Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 1.87 KB

Contributing

This is an early alpha. The implementation might change between versions without warning. Please use at your own risk and pin to a specific version if you're relying on this for anything important!

Development

Make sure you have a recent version of Node.js installed (>=18). Then run:

npm install
npm test

Releases

To cut a new release, run:

cd replicate-js
git checkout main
git pull
npx np minor

This will:

  • Run tests locally
  • Bump the version in package.json
  • Commit and tag the release
  • Push the commit and tag to GitHub
  • Publish the package to npm
  • Create a GitHub release

Vendored Dependencies

We have a few dependencies that have been bundled into the vendor directory rather than adding external npm dependencies.

These have been generated using bundlejs.com and copied into the appropriate directory along with the license and repository information.

Note

The vendored implementation of TextDecoderStream requires the following patch to be applied to the output of bundlejs.com:

  constructor(label, options) {
-   this[decDecoder] = new TextDecoder(label, options);
-   this[decTransform] = new TransformStream(new TextDecodeTransformer(this[decDecoder]));
+   const decoder = new TextDecoder(label || "utf-8", options || {});
+   this[decDecoder] = decoder;
+   this[decTransform] = new TransformStream(new TextDecodeTransformer(decoder));
  }