Skip to content

A template for Node libraries with TypeScript, SWC, Jest, ESLint, and a GitHub Action for testing & linting

License

Notifications You must be signed in to change notification settings

oskarlh/template-typescript-node-library

Repository files navigation

template-typescript-node-library

This is a template for TypeScript libraries.

Test coverage

The test coverage is a perfect 100% and enforced by the publishing and pull request verification workflows.

Contributing

Contributions are welcomed! Feel free to make a pull request. Please add your name to contributors in package.json and run npm run build-and-verify before submitting your PR. By making a pull request you agree to license your contribution under the CC0 license unless otherwise specified.

ESLint is used to enforce code quality and consistent formatting (with the help of Prettier). If ESLint complains when you run npm run build-and-verify, you can run npm run lint-fix to apply automatic fixes and then fix the rest of the errors manually. I recommend configuring your IDE for ESLint and Prettier. If you are using Visual Studio Code, simply installing Microsoft's ESLint extension and the official Prettier extension takes care of that.

About

A template for Node libraries with TypeScript, SWC, Jest, ESLint, and a GitHub Action for testing & linting

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published