generator-web-dotfiles
You can use this generator on top of other generators to enforce code standards
for js, css, html and markdown.
Setup githooks to check linting or run tests when you commit or push and
improve the quality of your commit messages with commitlint.
Installing
First install Yeoman:
yarn global add yo
or
npm install -g yo
Now install the ultimate generator:
yarn global add generator-web-dotfiles
or
npm install -g generator-web-dotfiles
Finally, run and follow the instructions:
yo web-dotfiles
Options
You can accept all config files and escape the question by using the option
all:
yo web-dotfiles --all
Features
-
package.json automatic configuration
-
ISC license
-
README with name of the project
-
Pre-populated .gitignore
-
NPM configuration .npmrc
-
JavaScript linting through Eslint
with standard configuration
(.eslintrc.json, .eslintignore)
-
CSS linting through Stylelint
with standard
configuration (.stylelintrc.json, .stylelintignore)
-
HTML linting through
HTMLHint configuration (.htmlhintrc)
-
Markdown linting through
Remark with
markdown style guide
configuration (.remarkrc.js)
-
Commit linting with commitlint
configuration (commitlintrc.js) and husky
-
Git commits with husky. Runs lint on
commit, runs tests on push. If you haven't initialized a git repository, the
githooks won't be installed.
First, initialize your git repository git init. You can always run the
generator again to add the hooks or install husky events yarn husky install
and add the files to run on events e.g.: yarn husky add .husky/pre-commit "yarn lint".
Compatibility
Version 3.x requires yo 4.x
