IFS RQE Javascript Library Template

This repo is a template repo to create a Vanilla Javascript Library using Rollup JS as the packager, ESLint for linting, and Karma/Jasmine for running unit tests. One should be able to use this as a template, run npm install and be ready to go. To ensure that all of your code is exported and built (not tree shaken out), it must be included in the main.ts file. See example code.

Once you have created a repo from the template, update the README, package.json file, and LICENSE file appropriately. If you thing there is something we should add to the template, please create a PR.

All peerDependencies and dependencies are automatically made to be externals as part of the rollup build. They will need to be installed by the consuming app if peerDependencies. Regular dependencies are automatically installed by NPM, but their use is discourage as you can have package version conflicts.

Global NPM packages to install on your box#

These packages should be installed globally for convenience.

• Rollup: npm install rollup -g
• Karma CLI: npm install karma-cli -g

Commands

These commands should not be changed to enforce consistency across the libraries. If you believe there is something that should be added as a standard build command, plese branch and submit a PR for consideration.

• npm run lint-lib Lint the library
• npm run test-lib Run Karam/Jasmine Unit Tests
• npm run build-lib Builds the library using rollup and places in the \dist\ folder
• npm run publish-patch Will automatically increment the patch number, push to npm, and commit and tag github repo
• npm run publish-minor Will automatically increment the patch number, push to npm, and commit and tag github repo
• npm run publish-major Will automatically increment the patch number, push to npm, and commit and tag github repo