data-structure-typed/COMMANDS.md

1.2 KiB

Commands

Overview of the commands to test, run and build this project as well as those that were used to set up it.

Most important commands for development

  • npm install Installs all dependencies and creates the folder node_modules, that is needed for all following commands.
  • npm run changelog Update CHANGELOG.md
  • npm login + npm publish To publish a new release. Be sure to run npm run package first.

Commands to test, run and build the project

  • npm test Run all unit tests (using Jest) with reporting coverage
  • npm run build:docs Generates JSDoc Documentation in folder "docs"
  • npm run build Build the application for production including es6(ESModule), es5(CommonJS) and minification(UMD)

Commands used to set up the project

  • npm audit fix Fixes vulnerabilities
  • npm install typedoc --save-dev Setup TypeScript Documentation (typedoc)
  • npm install eslint --save-dev Setup linter (static code quality analyzer)
  • npx eslint --init Initialize linter configuration file

References