WARNING: At this time this solution should be considered suitable for research and experimentation, further code and security review is needed before utilization in a production application.
Just clone this repo, remove .git, and edit package.json, webpack.config.js, karma.conf.js and whatever for your project. The simplest way is editing only webpack.baseconfig.json which defines the library name and library entry point.
Note that by plain commands, tests will be executed by importing from src/index.js. These tests should be done considering use cases of public library. Namely, the universal library is expected to be used by various ways of importing and executing, like ones from babel-ed sources (dist/index.js), from one bundle file (dist/testlib.bundle.js), on Node.js, and on browsers through a certain bundlers. Also you can test the case where the bundled library is imported as a part of window, i.e., window.testlib.
// Test for node.js with jest.
$ npm run test
// Test for browsers (headless chrome) with Karma.
$ npm run karma
$ npm run karma:window // test with `window.testlib`
// Execute babel and output transpiled JS files to ./dist,
// and create their bandle file via webpack.
// This also removes console.log in source codes.
$ npm run buildTo follow the workflow and NPM semantic version rule, we implemented some scripts in package.json. By using the scripts, you can easily follow the workflow.
-
Execute
npm run flow:version [patch|minor|major]to bump the version of the package. This does not commit to your git repo. -
Commit the current change in develop branch.
-
Execute
npm run release:startthat checks if the version can be published in NPM, and kicks the GitFlow release procedure. -
Prepare the release as the standard GitFlow release one.
-
Execute
npm run release:finishto finalize the GitFlow release operation.
Additionally npm run release:push executes git push --all and git push origin <the version number>.
Licensed under the MIT license, see LICENSE file.