This package has been deprecated
There exist better tools now.
Automated package creation and registration:
To run the following command you must:
The following command will:
- Create a new directory named
js-<namespace>in the current working directory;
- Initialize a new git repository in this directory;
- Create a repository named
js-<namespace>on github.com for
- Add an AGPL LICENSE file to the repository;
- Configure the local git repository with
https://<username>@github.com/<username>/js-<namespace>as its origin remote;
- Create a gh-pages branch that will be populated by the
npm run doccommand using groc;
- Create a
- Create a configuration file for travis-ci.org or drone.io;
- Create a
- Register a package named
<username>-js-<namespace>on npm and bower.
After running the command you will have to:
- Register the github.com repository on travis-ci.org or drone.io;
- Register the github.com repository on codeclimate.com;
- Register the github.com repository on coveralls.io.
The sak $ command to run is:
$ codebricks new <namespace> <description> --keywords <keyword>* --username <username> --ci
Or the shortened version of it:
$ cdb n <namespace> <description> -k <keyword>* -u <username> -c
--ci travis-ci is the default.
--keywords can be left empty.
--username is not given then either sak
can find it in your
~/.sak config file or will prompt for it.
$ npm release major
$ npm release minor
$ npm release patch
$ npm release <semver>
$ npm release <...> can be shortened to
$ npm r <...>.
How does the doc, build and test commands work?
Running the package creation command explained earlier will install
aureooms-node-package as a development dependency of your package. This is
equivalent to running:
npm install --save-dev aureooms-node-package
This will give your project access to tree runnables located in
node_modules/.bin. The package creation command will add these scripts to
It will also create a
pkg.json file, assuming your code tree is located in
js/src and your testing
index.js is located in
npm run build will parse your code tree recursively and in
lexicographical order, concatenating all the files it encounters in
js/dist/<namespace>.js and minify this file to
npm run test will test the main code file using the test code