Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heywon0909/ate
This is a esliint-plugin for Eight-ate 🧐
https://github.com/heywon0909/ate
eslint-plugin mocha-tests react typescript
Last synced: about 2 months ago
JSON representation
This is a esliint-plugin for Eight-ate 🧐
- Host: GitHub
- URL: https://github.com/heywon0909/ate
- Owner: heywon0909
- Created: 2024-03-11T14:17:31.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-02T04:20:00.000Z (9 months ago)
- Last Synced: 2024-10-12T17:21:55.348Z (3 months ago)
- Topics: eslint-plugin, mocha-tests, react, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-plugin-ate
- Size: 516 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-plugin-ate
This is eslint-plugin for ate-Eight
## Installation
You'll first need to install [ESLint](https://eslint.org/):
```sh
npm i eslint --save-dev
```
Next, install `eslint-plugin-ate`:
```sh
npm install eslint-plugin-ate --save-dev
```
## Usage
Add `ate` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": ["ate"]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"ate/rule-name": 2
}
}
```
## Configurations
TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).
## Rules
| Name |
| :------------------------------------------------------------------- |
| [react-event-handler](docs/rules/react-event-handler.md) |
| [react-props-check](docs/rules/react-props-check.md) |
| [react-props-destructuring](docs/rules/react-props-destructuring.md) |
| [ts-naming-interface](docs/rules/ts-naming-interface.md) |
| [ts-naming-type](docs/rules/ts-naming-type.md) |
💼 TBD
🚫 TBD
🏃 TBD
☑️ Set in the `recommended`
💡 Manually fixable by [editor suggestions]
❌ Deprecated.
| Name | Description | 💼 | 🚫 | 🔧 | 💡 | ❌ |
| :--------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------- | :-- | :-- | :-- | :-- | :-- |
| [react-event-handler](https://github.com/heywon0909/ate/blob/main/docs/rules/react-event-handler.md) | Definition for react event handler function naming | | | | | |
| [react-props-check](https://github.com/heywon0909/ate/blob/main/docs/rules/react-props-check.md) | Definition for React functional Components Props Part1 | | | | | ❌ |
| [react-props-destructuring](https://github.com/heywon0909/ate/blob/main/docs/rules/react-props-destructuring.md) | Definition for React function Component Part 2 | | | | | |
| [ts-naming-interface](https://github.com/heywon0909/ate/blob/main/docs/rules/ts-naming-interface.md) | Definition for typescript Interface naming | | | | | |
| [ts-naming-type](https://github.com/heywon0909/ate/blob/main/docs/rules/ts-naming-type.md) | Definition for typescript Type naming | | | | | |
| [react-props-name](https://github.com/heywon0909/ate/blob/main/docs/rules/react-props-name.md) | Definition for React Functional Component Props name | | | | | |