https://github.com/urbanjs/urbanjs-tools
Development stack for JavaScript
https://github.com/urbanjs/urbanjs-tools
compile development node nodejs npm npm-package security stack static-analyzer test
Last synced: 8 months ago
JSON representation
Development stack for JavaScript
- Host: GitHub
- URL: https://github.com/urbanjs/urbanjs-tools
- Owner: urbanjs
- License: mit
- Created: 2016-01-06T22:08:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-10-01T11:58:28.000Z (over 8 years ago)
- Last Synced: 2025-09-29T01:53:46.904Z (9 months ago)
- Topics: compile, development, node, nodejs, npm, npm-package, security, stack, static-analyzer, test
- Language: TypeScript
- Homepage:
- Size: 627 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# urbanjs-tools
[](https://travis-ci.org/urbanjs/urbanjs-tools)
### Quick start
Initialize the necessary tasks and presets in your gulpfile.js:
```
const tools = require('urbanjs-tools');
tools.initialize(gulp, {
babel: true,
checkDependencies: true,
checkFileNames: true,
conventionalChangelog: true,
eslint: true,
jsdoc: true,
mocha: true,
nsp: true,
retire: true,
tslint: true,
webpack: true
});
```
**And that's it, you're good to go.**
You can run any of the gulp tasks above (e.g. ```gulp eslint```) or you can use these [presets](https://github.com/urbanjs/urbanjs-tools/wiki/3---Usage#available-presets):
- `gulp test`: runs tests (```mocha```)
- `gulp analyse`: analyzes the code base (```check-dependencies```, ```check-file-names```, ```eslint```, ```nsp```, ```retire```, ```tslint```)
- `gulp pre-commit`: analyzes the code base and runs tests (```analyse```, ```test```)
- `gulp doc`: generates the documentation (```jsdoc```)
- `gulp dist`: runs the configured transpiler/bundler (```babel```, ```webpack```)
- `gulp changelog`: generates the documentation (```conventional-changelog```)
- `gulp pre-release`: analyzes the code base, runs tests, generates documentation, and transpiles/bundles (```pre-commit```, ```doc```, ```dist```, ```changelog```)
Additionally you can use these modifiers:
- `:fix` (`eslint`, `tslint`)
- `:watch` (`babel`, `webpack`, `mocha`)
e.g. `gulp eslint:fix` or `gulp babel:watch`
## Documentation
Check out
- the [wiki](https://github.com/urbanjs/urbanjs-tools/wiki) for guides, examples and details
- [api documentation](https://github.com/urbanjs/urbanjs-tools/blob/master/packages/urbanjs-tools/README.md)
- README.md files of packages
## Contribution
Highly appreciated any ideas how to make it more powerful.