@favorodera/eslint-config 0.0.4 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Favour Emeka
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -32,10 +32,15 @@ The following configurations are bundled and enabled by default (they can be ind
32
32
  - **Vue** — Single-file component support (`eslint-plugin-vue`, `vue-eslint-parser`)
33
33
  - **Stylistic** — Formatting rules (`@stylistic/eslint-plugin`)
34
34
  - **Tailwind CSS** — Utility class linting and sorting (`eslint-plugin-better-tailwindcss`)
35
+ - **Test** — Test and Vitest specific linting (`@vitest/eslint-plugin`)
35
36
  - **Imports** — Auto-sorting and unused imports removal (`eslint-plugin-import-lite`, `eslint-plugin-unused-imports`)
36
37
  - **Markdown** — Linting for markdown files and embedded code blocks (`@eslint/markdown`)
37
38
  - **JSON/JSONC/JSON5** — Formatting and sorting for JSON files like `package.json` (`eslint-plugin-jsonc`)
38
39
  - **JSDoc** — Standardized comment formatting (`eslint-plugin-jsdoc`)
40
+ - **Unicorn** — Various code quality improvements (`eslint-plugin-unicorn`)
41
+ - **Perfectionist** — Sorting objects, imports, classes, etc. (`eslint-plugin-perfectionist`)
42
+ - **Node** — Node.js specific linting rules (`eslint-plugin-n`)
43
+
39
44
 
40
45
  ## Usage
41
46
 
@@ -75,24 +80,24 @@ bun add -D eslint @favorodera/eslint-config
75
80
 
76
81
  ### Configure
77
82
 
78
- Create an `eslint.config.mjs` (or `eslint.config.ts`) file in the root of your project. Since all configurations are enabled by default, you only need to pass options if you want to disable or customize something:
83
+ Create an `eslint.config.ts` file in the root of your project. Since all configurations are enabled by default, you only need to pass options if you want to disable or customize something:
79
84
 
80
- ```javascript
85
+ ```ts
81
86
  import { factory } from '@favorodera/eslint-config'
82
87
 
83
88
  export default factory({
84
89
  // All configs are true by default!
85
90
 
86
- // Example: Disable tailwind if you aren't using it
87
- tailwind: false,
88
-
89
91
  // Example: Customize specific rulesets
90
92
  stylistic: {
91
93
  settings: {
94
+ indent: 4,
92
95
  quotes: 'double',
93
- indent: 4
94
- }
95
- }
96
+ },
97
+ },
98
+
99
+ // Example: Disable tailwind if you aren't using it
100
+ tailwind: false,
96
101
  })
97
102
  ```
98
103