modern-npm-package

An npm package for demonstration purposes using TypeScript to build for the ECMAScript Module format (i.e. ESM or ES Module). It can be used in Node.js and browser applications. Refer to the Snyk blog post for a full tutorial.

If you're reading/coming from the Snyk blog post that discusses both ESM and CommonJS go to the v2022-2024 branch

Get Started

1. Run npm install in your terminal
2. Then run npm run build
3. Update the package.json file "name" field with your own package name. Example @username/package-name
4. Create an account with npm if you don't have one already. Also be sure to enable two-factor authentication
5. Sign in to your npm account in your terminal with npm login
6. Run npm publish --access=public to publish your package

Testing

1. Install developer dependencies using the following command in your terminal npm i -D typescript @types/node
2. Create a tests folder
3. Create an index.test.ts file in the tests folder
4. Write unit tests in the index.test.ts file to test the code in index.ts
5. Add a "test" property in the package.json file "scripts" object and give it a value of "node --experimental-strip-types --test"
6. Run npm test in your terminal from the root folder of the project