@component-hook/eslint-plugin 0.1.2-alpha.0

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.
Files changed (5) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +109 -0
  3. package/dist/index.d.ts +4651 -0
  4. package/dist/index.js +759 -0
  5. package/package.json +65 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Tzuyi
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 ADDED
@@ -0,0 +1,109 @@
1
+ # @component-hook/eslint-plugin
2
+
3
+ A opinionated ESLint config preset for JavaScript, TypeScript, Vue,
4
+ and Prettier.
5
+
6
+ <p>
7
+ <a href="https://npm-stat.com/charts.html?package=@component-hook/picker">
8
+ <img src="https://img.shields.io/npm/dm/@component-hook/eslint-plugin.svg" alt="npm"/>
9
+ </a>
10
+ <a href="https://www.npmjs.com/package/@component-hook/picker">
11
+ <img src="https://img.shields.io/npm/v/@component-hook/eslint-plugin.svg" alt="npm"/>
12
+ </a>
13
+ </p>
14
+
15
+ ## Features
16
+
17
+ - Support `TypeScript`, `Vue` and `React` out-of-box.
18
+ - Built-in `Markdown`, `Sonarjs`, `Security`, `Playwright` and `Testing-library` configs can be referenced for respective needs.
19
+ - Format with Prettier.
20
+ - Ignores common files like `dist`, `node_modules`, `coverage`, and files in `.gitignore`.
21
+ - Reasonable defaults, best practices, and just a few lines of configuration.
22
+
23
+ ## Installation
24
+
25
+ ```bash
26
+ $ npm install @component-hook/eslint-plugin
27
+
28
+ # or use yarn
29
+ $ yarn add @component-hook/eslint-plugin
30
+
31
+ # or use pnpm
32
+ $ pnpm install @component-hook/eslint-plugin
33
+ ```
34
+
35
+ Require ESLint >= 9.0.0
36
+
37
+ ## Basic Usage
38
+
39
+ ```js
40
+ import componentHookPlugin from '@component-hook/eslint-plugin';
41
+
42
+ export default [
43
+ ...componentHookPlugin.configs.basic,
44
+ ...componentHookPlugin.configs.vue,
45
+ ...componentHookPlugin.configs.markdown,
46
+ componentHookPlugin.configs.sonarjs,
47
+ componentHookPlugin.configs.security,
48
+ {
49
+ files: ['**/__tests__/unit/**/*.test.[jt]s?(x)'],
50
+ ...componentHookPlugin.configs['testing-library/vue'],
51
+ },
52
+ {
53
+ files: ['**/__tests__/e2e/**/*.spec.[jt]s?(x)'],
54
+ ...componentHookPlugin.configs.playwright,
55
+ },
56
+ // ...your custom config
57
+ ];
58
+ ```
59
+
60
+ See [basic](./index.ts) for more details.
61
+
62
+ ## Presets Usage
63
+
64
+ ```js
65
+ import {
66
+ reactRecommended, // Includes basic, react, markdown, sonarjs, security configs
67
+ vueRecommended, // Includes basic, vue, markdown, sonarjs, security configs
68
+ } from '@component-hook/eslint-plugin';
69
+
70
+ export default reactRecommended;
71
+ ```
72
+
73
+ ## Configs
74
+
75
+ | Name | Type | Reference |
76
+ | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
77
+ | basic | `Linter.Config[]` | `eslint-recommended`, `typescript-eslint`, `eslint-plugin-import`, `eslint-plugin-regexp` and `eslint-plugin-prettier` |
78
+ | vue | `Linter.Config[]` | `eslint-plugin-vue` |
79
+ | react | `Linter.Config[]` | `eslint-plugin-react/recommended`, `eslint-plugin-react-hooks/recommended`, `eslint-plugin-jsx-a11y/recommended` |
80
+ | markdown | `Linter.Config[]` | `eslint-plugin-markdown/recommended` |
81
+ | sonarjs | `Linter.Config` | `eslint-plugin-sonarjs/recommended` |
82
+ | security | `Linter.Config` | `eslint-plugin-security/recommended` |
83
+ | playwright | `Linter.Config` | `eslint-plugin-playwright/flat/recommended` |
84
+ | testing-library/dom | `Linter.Config` | `eslint-plugin-testing-library/dom` |
85
+ | testing-library/vue | `Linter.Config` | `eslint-plugin-testing-library/vue` |
86
+ | testing-library/react | `Linter.Config` | `eslint-plugin-testing-library/react` |
87
+ | testing-library/angular | `Linter.Config` | `eslint-plugin-testing-library/angular` |
88
+ | testing-library/marko | `Linter.Config` | `eslint-plugin-testing-library/marko` |
89
+
90
+ ## Reference eslint plugin
91
+
92
+ - [eslint-recommended](https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js)
93
+ - [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)
94
+ - [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import)
95
+ - [eslint-plugin-regexp/flat/recommended](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/flat/recommended.ts)
96
+ - [eslint-plugin-prettier/recommended](https://github.com/prettier/eslint-plugin-prettier/blob/master/recommended.js)
97
+ - [eslint-plugin-react/recommended](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/configs/recommended.js)
98
+ - [eslint-plugin-react-hooks/recommended](https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/src/index.js)
99
+ - [eslint-plugin-jsx-a11y/recommended](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/src/index.js)
100
+ - [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)
101
+ - [eslint-plugin-markdown/recommended](https://github.com/eslint/markdown/blob/main/src/index.js)
102
+ - [eslint-plugin-sonarjs/recommended](https://github.com/SonarSource/eslint-plugin-sonarjs/blob/master/src/index.ts)
103
+ - [eslint-plugin-security/recommended](https://github.com/eslint-community/eslint-plugin-security/blob/main/index.js)
104
+ - [eslint-plugin-testing-library/dom](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/lib/configs/dom.ts)
105
+ - [eslint-plugin-testing-library/vue](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/lib/configs/vue.ts)
106
+ - [eslint-plugin-testing-library/react](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/lib/configs/react.ts)
107
+ - [eslint-plugin-testing-library/angular](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/lib/configs/angular.ts)
108
+ - [eslint-plugin-testing-library/marko](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/lib/configs/marko.ts)
109
+ - [eslint-plugin-playwright/flat/recommended](https://github.com/playwright-community/eslint-plugin-playwright/blob/main/src/index.ts)