@drivenets/eslint-plugin-design-system 0.0.4 → 0.0.5
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/CHANGELOG.md +6 -0
- package/README.md +56 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# DriveNets Design System ESLint Plugin
|
|
2
|
+
|
|
3
|
+
This ESLint plugin provides custom linting rules and configurations for projects using the DriveNets Design System.
|
|
4
|
+
|
|
5
|
+
It helps enforce best practices and migrating from deprecated components and props.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
First, install the package via your preferred package manager:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @drivenets/eslint-plugin
|
|
13
|
+
# or
|
|
14
|
+
pnpm install @drivenets/eslint-plugin
|
|
15
|
+
# or
|
|
16
|
+
yarn add @drivenets/eslint-plugin
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
> [!NOTE]
|
|
22
|
+
> This plugin supports only the new ESLint Flat Config format and requires ESLint 9.0.0 or higher.
|
|
23
|
+
|
|
24
|
+
To use the plugin, add it to your ESLint configuration file (e.g. `eslint.config.ts`).
|
|
25
|
+
|
|
26
|
+
You can either use the recommended config:
|
|
27
|
+
|
|
28
|
+
```TS
|
|
29
|
+
import { defineConfig } from 'eslint/config';
|
|
30
|
+
import designSystem from '@drivenets/eslint-plugin-design-system';
|
|
31
|
+
|
|
32
|
+
export default defineConfig(
|
|
33
|
+
// ... your config
|
|
34
|
+
designSystem.configs.recommended,
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Or you can customize the rules as needed:
|
|
39
|
+
|
|
40
|
+
```TS
|
|
41
|
+
import { defineConfig } from 'eslint/config';
|
|
42
|
+
import designSystem from '@drivenets/eslint-plugin-design-system';
|
|
43
|
+
|
|
44
|
+
export default defineConfig(
|
|
45
|
+
// ... your config
|
|
46
|
+
{
|
|
47
|
+
plugins: {
|
|
48
|
+
'@drivenets/design-system': designSystem,
|
|
49
|
+
},
|
|
50
|
+
rules: {
|
|
51
|
+
'@drivenets/design-system/no-native-button': 'off',
|
|
52
|
+
'@drivenets/design-system/no-native-text-input': 'error',
|
|
53
|
+
},
|
|
54
|
+
}
|
|
55
|
+
);
|
|
56
|
+
```
|