https://github.com/roms1383/generator-kroms
Yeoman generator based on custom presets
https://github.com/roms1383/generator-kroms
codacy commitlint-config custom eslint-config husky-config lint-staged nvm opinionated remark-lint renovate-config semantic-release-config travis-ci yeoman-generator
Last synced: about 2 months ago
JSON representation
Yeoman generator based on custom presets
- Host: GitHub
- URL: https://github.com/roms1383/generator-kroms
- Owner: Roms1383
- License: mit
- Created: 2019-05-29T05:18:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T12:50:50.000Z (about 2 months ago)
- Last Synced: 2025-04-14T04:58:52.676Z (about 2 months ago)
- Topics: codacy, commitlint-config, custom, eslint-config, husky-config, lint-staged, nvm, opinionated, remark-lint, renovate-config, semantic-release-config, travis-ci, yeoman-generator
- Language: JavaScript
- Size: 865 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-kroms
[](https://www.npmjs.com/package/generator-kroms) [](LICENSE) [](https://travis-ci.org/Roms1383/generator-kroms) [](https://www.codacy.com/app/Roms1383/generator-kroms?utm_source=github.com&utm_medium=referral&utm_content=Roms1383/generator-kroms&utm_campaign=Badge_Grade) [](https://www.codacy.com/app/Roms1383/generator-kroms?utm_source=github.com&utm_medium=referral&utm_content=Roms1383/generator-kroms&utm_campaign=Badge_Coverage) [](https://renovatebot.com) [](https://david-dm.org/) [](https://github.com/semantic-release/semantic-release) [](https://github.com/carloscuesta/gitmoji)
Very opinionated generator for Yeoman
*****
## install
First, install [Yeoman](http://yeoman.io).
```bash
yarn global add yo
```
## use
Then, install `generator-kroms` and run it on your new project:
```bash
yarn add generator-kroms --dev
yo kroms
```
## features
* synchronise `LICENSE` from your `package.json` informations (thanks to [generator-license](https://github.com/jozefizso/generator-license))
* synchronise `.gitignore` from files found in project (only basic set so far), thanks to [gitignore.io](https://gitignore.io)
* synchronise `README.md` header and footer while leaving content untouched only if using proper delimiters
* add configuration file for [Renovate](https://renovatebot.com)
* add configuration file for [NVM](https://github.com/nvm-sh/nvm)
* add configuration files, dependencies and script for [ESLint](https://github.com/eslint/eslint), using [eslint-config-kroms](https://github.com/Roms1383/eslint-config-kroms) as preset
* add configuration file, dependencies and script for [RemarkLint](https://github.com/remarkjs/remark-lint), using `remark-preset-lint-recommended` as preset
* add configuration file, dependency and script for [Jest](https://github.com/facebook/jest)
* add dependency and script for [Codacy](https://github.com/codacy/node-codacy-coverage) (more [infos](generators/codacy/README.md))
* add configuration file, dependencies and script for [semantic-release](https://github.com/semantic-release/semantic-release), using [semantic-release-kroms](https://github.com/Roms1383/semantic-release-kroms) as preset
* add configuration file and dependencies for [commitlint](https://github.com/conventional-changelog/commitlint), using [commitlint-config-kroms](https://github.com/Roms1383/commitlint-config-kroms) as preset
* add configuration file and dependency for [lint-staged](https://github.com/okonet/lint-staged)
* add configuration file and dependency for [husky](https://github.com/typicode/husky)
* add configuration file and Git hooks for [travis](https://travis-ci.org)
More to come...
## getting to know Yeoman
* Yeoman has a heart of gold. I don't :joy:.
* Yeoman is a person with feelings and opinions, but is very easy to work with.
* Yeoman can be too opinionated at times but is easily convinced not to be.
* Feel free to [learn more about Yeoman](http://yeoman.io/).
*****
_Romain KELIFA - MIT - 2019_