Skip to content

Commit

Permalink
NDS-36 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d-lan1 committed Jan 9, 2018
1 parent db49c9b commit 8f58fc0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,19 @@ Run `npm start` and `npm run test:watch` for development. However, there are oth
| Task | Description |
| ---- | ----------- |
| `npm start` | Simply runs `grunt` under the hood |
| `npm run dist` | Builds the projects in distribution mode for release |
| `npm run dist:teamcity` | Builds the projects in distribution mode for release via teamcity |
| `npm test` | Runs JS tests |
| `npm test:teamcity` | Runs JS tests (with the [mocha-teamcity-reporter](https://www.npmjs.com/package/mocha-teamcity-reporter))|
| `npm run test:watch` | Runs JS test tests (with [min reporter](https://github.com/mochajs/mocha/blob/master/lib/reporters/min.js)) and watches for changes. Useful to run in development alongside grunt. |
| `npm run test:coverage` | Runs JS test tests and generates a coverage report with [Istanbul](https://istanbul.js.org/) into the *coverage* folder |
| `test:coverage:teamcity` | Runs JS test tests and generates a coverage report with [Istanbul](https://istanbul.js.org/) (using the [mocha-teamcity-reporter](https://www.npmjs.com/package/mocha-teamcity-reporter)). |
| `npm run lint` | Lints SASS and JS (uses `grunt lint` under the hood) |

| `npm run release` | Builds the assets in dist mode, increments package.json patch version, pushes a new git tag, creates a GitHub release (with release notes from commits since last release) and creates an npm release. |
| `npm run release:minor` | Does the same as release but with a minor version |


#### Grunt

Some of the npm scripts use Grunt tasks under the hood. These Grunt tasks (and aliases) can be run directly e.g. `grunt lint`. However, we recommend using the npm scripts themselves. See the task aliases in [Gruntfile.js#L35-L47](Gruntfile.js) for more information.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"// JAVASCRIPT": "",
"webpack": "SET \"NODE_ENV=production\" && webpack --progress --colors --display-error-details",
"// TESTS": "",
"test:teamcity": "grunt test:mocha-teamcity-reporter --color",
"test": "mocha src/**/*.test.js test/**/*.test.js --require babel-core/register --require mocha-clean --require test/_setup.js --color",
"test:teamcity": "grunt test:mocha-teamcity-reporter --color",
"test:watch": "mocha src/**/*.test.js test/**/*.test.js --require babel-core/register --require mocha-clean --require test/_setup.js --reporter min --watch --color",
"test:coverage": "nyc --reporter=html npm run test --color",
"test:coverage:teamcity": "nyc --reporter=teamcity --reporter=html npm run test:teamcity --color",
Expand Down

0 comments on commit 8f58fc0

Please sign in to comment.