Skip to content

Roms1383/generator-kroms

Repository files navigation

generator-kroms

Latest Release License Build Status Codacy Quality Codacy Coverage Renovate Dependencies Semantic Release Gitmoji

Very opinionated generator for Yeoman


install

First, install Yeoman.

yarn global add yo

use

Then, install generator-kroms and run it on your new project:

yarn add generator-kroms --dev
yo kroms

features

  • synchronise LICENSE from your package.json informations (thanks to generator-license)
  • synchronise .gitignore from files found in project (only basic set so far), thanks to gitignore.io
  • synchronise README.md header and footer while leaving content untouched only if using proper delimiters
  • add configuration file for Renovate
  • add configuration file for NVM
  • add configuration files, dependencies and script for ESLint, using eslint-config-kroms as preset
  • add configuration file, dependencies and script for RemarkLint, using remark-preset-lint-recommended as preset
  • add configuration file, dependency and script for Jest
  • add dependency and script for Codacy (more infos)
  • add configuration file, dependencies and script for semantic-release, using semantic-release-kroms as preset
  • add configuration file and dependencies for commitlint, using commitlint-config-kroms as preset
  • add configuration file and dependency for lint-staged
  • add configuration file and dependency for husky
  • add configuration file and Git hooks for travis

More to come...

getting to know Yeoman

  • Yeoman has a heart of gold. I don't 😂.
  • 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.

Romain KELIFA - MIT - 2019