js-resources

staging: master:

Resource context management inspired by Python's with context manager and Haskell's bracket pattern.

Installation

npm install --save @matrixai/resources
Copy

Development

Run nix-shell, and once you're inside, you can use:

# install (or reinstall packages from package.json)
npm install
# build the dist
npm run build
# run the repl (this allows you to import from ./src)
npm run tsx
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
Copy

Docs Generation

npm run docs
Copy

See the docs at: https://matrixai.github.io/js-resources/

Publishing

Publishing is handled automatically by the staging pipeline.

Prerelease:

# npm login
npm version prepatch --preid alpha # premajor/preminor/prepatch
git push --follow-tags
Copy

Release:

# npm login
npm version patch # major/minor/patch
git push --follow-tags
Copy

Manually:

# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
Copy