eslint-plugin-react-form-fields
React Form Fields specific linting rules for ESLint
[](LICENSE)
[](https://github.com/kotarella1110/eslint-plugin-react-form-fields/actions?query=workflow%3ACI)
[](https://www.npmjs.com/package/eslint-plugin-react-form-fields)
[](https://www.npmjs.com/package/eslint-plugin-react-form-fields)
[](https://www.npmjs.com/package/eslint-plugin-react-form-fields)
[](https://david-dm.org/kotarella1110/eslint-plugin-react-form-fields)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
[](CONTRIBUTING.md)
[](#contributors-)
## Installation
Install [ESLint](https://www.github.com/eslint/eslint) either locally or globally. (Note that locally, per project, is strongly preferred)
```sh
$ npm install eslint --save-dev
```
If you installed ESLint globally, you have to install React plugin globally too. Otherwise, install it locally.
```sh
$ npm install eslint-plugin-react-form-fields --save-dev
```
## Configuration
Use our preset to get reasonable defaults:
```json
"extends": [
"eslint:recommended",
"plugin:react-form-fields/recommended"
]
```
If you do not use a preset you will need to specify individual rules and add extra configuration.
Add "react-form-fields" to the plugins section.
```json
{
"plugins": ["react-form-fields"]
}
```
Enable the rules that you would like to use.
```json
"rules": {
"react-form-fields/no-mix-controlled-with-uncontrolled": "error",
"react-form-fields/no-only-value-prop": "error"
}
```
See also [Configuring ESLint](https://eslint.org/docs/user-guide/configuring).
## Rules
### Possible Errors
| Rule ID | Description | |
| :------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- | :-: |
| [react-form-fields/no-mix-controlled-with-uncontrolled](./docs/rules/no-mix-controlled-with-uncontrolled.md) | Forbid to specify both value/checked and defaultValue/defaultChecked props to form fields | ⭐️ |
| [react-form-fields/no-only-value-prop](./docs/rules/no-only-value-prop.md) | Forbid to specify only value/checked without onChange and readOnly props to form fields | ⭐️ |
| [react-form-fields/styled-no-mix-controlled-with-uncontrolled](./docs/rules/styled-no-mix-controlled-with-uncontrolled.md) | Forbid to specify both value/checked and defaultValue/defaultChecked props to form fields | |
| [react-form-fields/styled-no-only-value-prop](./docs/rules/styled-no-only-value-prop.md) | Forbid to specify only value/checked without onChange and readOnly props to form fields | |
## Semantic Versioning Policy
This plugin follows [Semantic Versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
## Contributing
Welcome your contribution!
See also [ESLint Contribution Guide](https://eslint.org/docs/developer-guide/contributing/).
### Development Tools
- `npm test` runs tests.
- `npm run update` updates the package version. And it updates `src/configs/recommended.ts`, `lib/index.ts`, and `README.md`'s rule table. See also [npm version CLI command](https://docs.npmjs.com/cli/version).
- `npm run add-rule ` creates three files to add a new rule.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## License
[MIT](./LICENSE) © [Kotaro Sugawara](https://twitter.com/kotarella1110)
