klarify-opus-processing

Klarify small window silence detection

Setup

Make sure you have Rust installed first.

Once rust is installed, run bun install to install dependencies & bun run build to build the project for testing+benching.

Modifications

Make any modifications in src/lib.rs, and if the API signature changes, be sure to update the benchmark/bench.ts and __test__/index.spec.ts files accordingly.

Publishing

Preparing to publish

Commit any changes without changing the version number first, and make sure to run bun format to improve code style.

Once ready to publish, increment the version number in package.json (if you break the API spec, make sure to use a major version increase) and then run bun version. Once the command finishes, commit the staged changes with the same version number as you put in the package json file.

Example flow:

# ...make changes to lib.rs
bun run build # Regenerate index.d.ts
# ...update api usages as needed
bun run test # Run tests. Note: the "run test" instead of just "test" here is important!
# set package.json version to 1.2.3
bun version
git commit -m "1.2.3"
git push

This will trigger a deployment and publish the new version to npm.

Importantly, we currently only use main so its a bit unstable, but we can improve this if further work is needed here. At some point, having this flow be fully automated would be ideal, but that's not really necessary at the moment.