https://github.com/ethanwan/yzm-doohickey
🐒 🐒 🐒 JS, TS, CSS style guide for react project
https://github.com/ethanwan/yzm-doohickey
eslint husky lint-staged linter prettier style-linter typescript
Last synced: 4 months ago
JSON representation
🐒 🐒 🐒 JS, TS, CSS style guide for react project
- Host: GitHub
- URL: https://github.com/ethanwan/yzm-doohickey
- Owner: EthanWan
- License: mit
- Created: 2022-07-05T14:05:02.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T07:45:32.000Z (almost 3 years ago)
- Last Synced: 2025-05-25T18:50:02.471Z (5 months ago)
- Topics: eslint, husky, lint-staged, linter, prettier, style-linter, typescript
- Language: TypeScript
- Homepage:
- Size: 846 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
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`
```bash
doohickey init
```
## Others
View all cli options with the following command
```bash
doohickey --help
```
```bash
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](./LICENSE)