Scripts

Scripts

Note

This is to help developers working on this package.
None of this information is needed if you are just using the package.

Run scripts from root level.

# Compile all src code into a bundle in build/ directory.
$ npm run build

# Part of 'build' and it bundles the typescipt declarations into a single bundle.d.ts file.
$ npm run build:dts

# Part of build and it removes directories and files before the build.
$ npm run clean:prebuild

# Part of build and it removes directories and files after the build.
$ npm run clean:postbuild

# Used to package the code before a release.
$ npm run pack

# Updates the version in package.json by patch before a release.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run bump:patch

# Updates the version in package.json by minor before a release.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run bump:minor

# Updates the version in package.json by major before a release.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run bump:major

# Updates the version in package.json by adding the `-beta` suffix or incrementing it.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run tag:beta

# Updates the version in package.json by adding the `-rc` suffix or incrementing it.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run tag:rc

# Updates the version in package.json by removing tags such as `-beta`.
# Do NOT use this script, instead use the "Create Release" workflow.
$ npm run remove-tag

# Run suites of unit and integration tests from the `__tests__` directory.
$ npm run test

# Run suites of unit and integration tests and get a coverage report.
$ npm run coverage

# Run suites of unit and integration tests and get a coverage report, then open it in the browser.
$ npm run coverage:open