https://github.com/snyk-snippets/modern-npm-package

An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format. It can be used in Node.js and browser applications.
https://github.com/snyk-snippets/modern-npm-package

Last synced: 3 months ago
JSON representation

An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format. It can be used in Node.js and browser applications.

• Host: GitHub
• URL: https://github.com/snyk-snippets/modern-npm-package
• Owner: snyk-snippets
• License: mit
• Created: 2022-08-12T22:23:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-08T17:38:23.000Z (about 1 year ago)
• Last Synced: 2024-04-14T12:56:55.791Z (9 months ago)
• Language: TypeScript
• Size: 116 KB
• Stars: 93
• Watchers: 3
• Forks: 26
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - snyk-snippets/modern-npm-package - An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format. It can be used in Node.js and browser applications. (TypeScript)

README

        
# modern-npm-package

An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format (CJS). It can be used in Node.js and browser applications.

## Get Started

1. Run `npm install` in your terminal

1. Then run `npm run build`

1. Update the `package.json` file "name" field with your own package name. Example `@username/package-name`

1. Create an account with [npm](https://www.npmjs.com/signup) if you don't have one already. Also be sure to enable [two-factor authentication](https://docs.npmjs.com/configuring-two-factor-authentication)

1. Sign in to your npm account in your terminal with `npm login`

1. Run `npm publish --access=public` to publish your package

### Testing

1. Install developer dependencies using the following command in your terminal `npm i -D mocha @types/mocha chai @types/chai ts-node`

1. Create a new file `.mocharc.json` in the root directory with the following contents:

   ```json

   {

     "extension": ["ts"],

     "spec": "./**/*.spec.ts",

     "require": "ts-node/register"

   }

   ```

1. Create a `tests` folder

1. Create an `index.spec.ts` file in the `tests` folder

1. Write unit tests in the `index.spec.ts` file to test the code in `index.ts`

1. Add a `"test"` property in the `package.json` file and give it a value of `"mocha"`

1. Run `npm test` in your terminal from the root folder of the project