Feat/types

[Lordfirespeed]

See #272 for discussion

Summary by CodeRabbit

• New Features

  • Introduced support for Continuation-Passing Style (CPS) functions, enhancing asynchronous programming capabilities.
  • Added TypeScript type definitions to improve usability for TypeScript users.

• Documentation

  • Updated package.json to include type definitions and ensure proper distribution of necessary files.

• Tests

  • Implemented a testing framework for CPS functions to demonstrate their functionality and chaining capabilities.

[Lordfirespeed]

I decided to have a crack at CPS.chain - it's not 100% perfect (when fewer functions are provided than there are callbacks, the identity callback must be declared explicitly) but it does seem to work.

[dmitriz]

Nice! But how to run the new test file? Any script to add?

[dmitriz]

@coderabbitai review

[coderabbitai[bot]]

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The changes introduce a TypeScript implementation for Continuation-Passing Style (CPS) functions, enhancing asynchronous programming. New types and functions are defined in index.d.ts, facilitating the chaining of CPS functions. The package.json file is updated to include TypeScript definitions, improving usability. Additionally, a new file type-test/chain.ts demonstrates CPS through higher-order functions and chaining mechanisms, enabling complex control flows.

Changes

File	Change Summary
index.d.ts	Defined types and functions for CPS, including CPSFn, ChainFns, and the CPS function for chaining.
package.json	Added types field for TypeScript definitions and included index.d.ts in the files array.
type-test/chain.ts	Implemented higher-order CPS functions and demonstrated chaining with cpsFn, f1, f2, and chaining functions.

Poem

🐇 In the land of code where functions play,
A new CPS shines bright today.
With callbacks chaining, oh what a sight,
Asynchronous magic, pure delight!
Hopping through logic, swift and free,
Let's celebrate changes, just you and me! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Lordfirespeed]

Nice! But how to run the new test file? Any script to add?

I'll add a type-check script that runs the typescript compiler on the type-tests folder

[dmitriz]

@coderabbitai generate interesting stats about this repository and render them as a table

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

@dmitriz, here are the interesting statistics about the repository:

Metric	Count
Authors	2
Lines of Code	4225
TODOs	2
Files	40
Commits	4

Let me know if you need any further details!

Analysis chain

---

---

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Count the number of authors in the repository.
authors=$(git shortlog -sn --all | wc -l)

# Count the total number of lines of code in the repository.
lines_of_code=$(tokei --output json | jq '.total.code')

# Count the number of TODO comments in the repository.
todos=$(rg -c 'TODO' | wc -l)

# Count the total number of files in the repository.
files=$(fd . | wc -l)

# Count the total number of commits in the repository.
commits=$(git rev-list --count HEAD)

# Output the results as a table.
echo -e "Metric\tCount"
echo -e "------\t-----"
echo -e "Authors\t$authors"
echo -e "Lines of Code\t$lines_of_code"
echo -e "TODOs\t$todos"
echo -e "Files\t$files"
echo -e "Commits\t$commits"

Length of output: 465

---

Script:

#!/bin/bash
# Re-run tokei without jq to inspect the raw output.
tokei --output json

Length of output: 6877

---

Script:

#!/bin/bash
# Correctly parse the total number of lines of code from the tokei output.
lines_of_code=$(tokei --output json | jq '.Total.code')

# Output the results as a table.
echo -e "Metric\tCount"
echo -e "------\t-----"
echo -e "Authors\t2"
echo -e "Lines of Code\t$lines_of_code"
echo -e "TODOs\t2"
echo -e "Files\t40"
echo -e "Commits\t4"

Length of output: 316