EthanWan / yzm-doohickey

🐒 🐒 🐒 JS, TS, CSS style guide for react project

yzm-doohickey

Yzm-doohickey is a configuration gadgets of the react project mainly include some lint rules of javascript, typescript, jsx, code formatting rules, css rules, git commit rules, etc. By eliminating some repetitive code rules configuration at the beginning of the developer project, you can focus more on business development. For specific rules, please refer to the standard directory.

Installed

npm i yzm-doohickey --save-dev
# or
yarn add yzm-doohickey -D

Usage

Initialize all configuration with the following commands, including .eslintrc.js, .perttierrc.js, .stylelintrc.js, .husky and npm scripts lint-staged

doohickey init

Others

View all cli options with the following command

doohickey --help

Usage:  doohickey COMMAND [OPTIONS]

A quick configuration tool for react app

Options:
  -h, --help
  -v, --version

Commands:
  init              Generate configuration and adds npm scripts to package.json.
  lint:js           Lint code issues by eslint.
  lint:prettier     Checks code for formatting by prettier.
  lint:style        Checks CSS code for formatting and lint issues by stylelint.
  verifyCommitMsg   Verify git commit message.

Run 'doohickey COMMAND --help' for more information on a command.

LICENSE

MIT