|
1 | | -# eslint-plugin-devup |
2 | | - |
3 | | -`devup` is a system for faster and more accurate software development used at DevFive. |
4 | | - |
5 | | -`eslint-plugin-devup` helps you develop software quickly and accurately. |
6 | | - |
7 | | -For details on each rule, please refer to the files in the `src/rules` directory. |
8 | | - |
9 | | -As this was originally used internally and has now been made public, some rules exist for company-specific systems. |
10 | | - |
11 | | -All rules are provided as `named exports` so you can use only the rules you want. |
12 | | - |
13 | | -## Installation |
14 | | - |
15 | | -```bash |
16 | | -bun add -d eslint-plugin-devup |
17 | | -``` |
18 | | - |
19 | | -## Usage |
20 | | - |
21 | | -Create an `eslint.config.mjs` file in your project root. |
22 | | - |
23 | | -```js |
24 | | -import { configs } from 'eslint-plugin-devup' |
25 | | - |
26 | | -export default configs.recommended |
27 | | -``` |
28 | | - |
29 | | -## Test |
30 | | - |
31 | | -Coverage score must be 100%. |
32 | | - |
33 | | -```bash |
34 | | -bun test |
35 | | -``` |
36 | | - |
37 | | -## Contributing |
38 | | - |
39 | | -- When adding or modifying rules, add or modify files in the `src/rules` directory. |
40 | | -- When adding or modifying rules, add a description of the rule in `README.md`. |
41 | | - |
42 | | -All opinions and contributions are welcome. |
43 | | - |
44 | | -## Join the Community |
45 | | - |
46 | | -[Discord](https://discord.gg/8zjcGc7cWh) |
| 1 | +# eslint-plugin-devup |
| 2 | + |
| 3 | +`devup` is a system for faster and more accurate software development used at DevFive. |
| 4 | + |
| 5 | +`eslint-plugin-devup` helps you develop software quickly and accurately. |
| 6 | + |
| 7 | +For details on each rule, please refer to the files in the `src/rules` directory. |
| 8 | + |
| 9 | +As this was originally used internally and has now been made public, some rules exist for company-specific systems. |
| 10 | + |
| 11 | +All rules are provided as `named exports` so you can use only the rules you want. |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +```bash |
| 16 | +bun add -d eslint-plugin-devup |
| 17 | +``` |
| 18 | + |
| 19 | +## Usage |
| 20 | + |
| 21 | +### ESLint |
| 22 | + |
| 23 | +Create an `eslint.config.mjs` file in your project root. |
| 24 | + |
| 25 | +```js |
| 26 | +import { configs } from "eslint-plugin-devup"; |
| 27 | + |
| 28 | +export default configs.recommended; |
| 29 | +``` |
| 30 | + |
| 31 | +### Oxlint |
| 32 | + |
| 33 | +Create an `.oxlintrc.json` file in your project root. |
| 34 | + |
| 35 | +```json |
| 36 | +{ |
| 37 | + "extends": ["eslint-plugin-devup/oxlintrc"] |
| 38 | +} |
| 39 | +``` |
| 40 | + |
| 41 | +## Test |
| 42 | + |
| 43 | +Coverage score must be 100%. |
| 44 | + |
| 45 | +```bash |
| 46 | +bun test |
| 47 | +``` |
| 48 | + |
| 49 | +## Contributing |
| 50 | + |
| 51 | +- When adding or modifying rules, add or modify files in the `src/rules` directory. |
| 52 | +- When adding or modifying rules, add a description of the rule in `README.md`. |
| 53 | + |
| 54 | +All opinions and contributions are welcome. |
| 55 | + |
| 56 | +## Join the Community |
| 57 | + |
| 58 | +[Discord](https://discord.gg/8zjcGc7cWh) |
0 commit comments