@rooknj/eslint-config v1.1.1
Eslint Config Rooknj
My Personal Eslint Config for Typescript-React applications
Installing
Prerequisites
- NodeJS LTS installed on your system (Check by running
node -v
)
Install with Yarn or NPM
yarn:
yarn add -D @rooknj/eslint-config \
eslint-plugin-jest@^24.0.2 \
eslint-plugin-prettier@3.1.4 \
eslint-plugin-import@^2.22.0 \
eslint-plugin-jsx-a11y@^6.3.1 \
eslint-plugin-react@^7.20.3 \
eslint-plugin-react-hooks@^4.0.8 \
@typescript-eslint/eslint-plugin@^4.0.1 \
@typescript-eslint/parser@^4.2.0
npm:
npm install --save-dev @rooknj/eslint-config \
eslint-plugin-jest@^24.0.2 \
eslint-plugin-prettier@3.1.4 \
eslint-plugin-import@^2.22.0 \
eslint-plugin-jsx-a11y@^6.3.1 \
eslint-plugin-react@^7.20.3 \
eslint-plugin-react-hooks@^4.0.8 \
@typescript-eslint/eslint-plugin@^4.0.1 \
@typescript-eslint/parser@^4.2.0
Developing
Prerequisites
- NodeJS LTS installed on your system (Check by running
node -v
) - Yarn (Check by running
yarn -v
)
Deploying
Deployments happen automatically using Semantic-Release based off of conventional commit messages
Commit Messages
Commit messages must follow Conventional Commits
Example Messages
- chore(docs): updated Readme
- refactor: renamed index.js
- fix(scope): fixed bug
- feat: Added new ability in code
- BREAKING CHANGE: Removed deprecated functions
CI will fail if you do not use the correct commit format. Local messages are linted using Commitlint
Commitizen support coming soon
Versioning
We use SemVer 2.0.0 for versioning. To see available versions, check out the releases page
Code Style
Code style is managed by Prettier
All default prettier styles are enabled except for the overrides located in .prettierrc.js
Prettier is automatically ran on staged files every commit using Husky and Lint-Staged
You can run prettier manually on every file through the command yarn reformat
or you can set up prettier to run inside your IDE/Editor
License
This project is licensed under the terms of the MIT license.