@rotki/eslint-plugin 0.7.0 → 1.1.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 (7) hide show
  1. package/README.md +36 -6
  2. package/dist/index.d.mts +14 -5
  3. package/dist/index.d.ts +14 -5
  4. package/dist/index.mjs +252 -188
  5. package/package.json +28 -29
  6. package/dist/index.cjs +0 -707
  7. package/dist/index.d.cts +0 -108
package/README.md CHANGED
@@ -1,16 +1,46 @@
1
1
  # @rotki/eslint-plugin
2
2
 
3
- rotki's ESLint plugin.
3
+ [![npm version](https://img.shields.io/npm/v/@rotki/eslint-plugin.svg)](https://www.npmjs.com/package/@rotki/eslint-plugin)
4
4
 
5
- Inspired by [intlify/eslint-plugin-vue-i18n](https://github.com/intlify/eslint-plugin-vue-i18n)
6
- and [vuetifyjs/eslint-plugin-vuetify](https://github.com/vuetifyjs/eslint-plugin-vuetify).
5
+ An ESLint plugin for rotki projects that provides custom rules and configurations to maintain consistent code quality.
7
6
 
8
- The plugin was bootstrapped from on `intlify/eslint-plugin-vue-i18n`.
7
+ ## Overview
8
+
9
+ This ESLint plugin is designed specifically for rotki projects, drawing inspiration from established plugins like:
10
+
11
+ - [intlify/eslint-plugin-vue-i18n](https://github.com/intlify/eslint-plugin-vue-i18n)
12
+ - [vuetifyjs/eslint-plugin-vuetify](https://github.com/vuetifyjs/eslint-plugin-vuetify)
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ # Using pnpm (recommended)
18
+ pnpm add -D @rotki/eslint-plugin
19
+
20
+ # Using npm
21
+ npm install --save-dev @rotki/eslint-plugin
22
+
23
+ # Using yarn
24
+ yarn add -D @rotki/eslint-plugin
25
+ ```
9
26
 
10
27
  ## Documentation
11
28
 
12
- See [here](https://rotki.github.io/eslint-plugin)
29
+ For detailed usage instructions, available rules, and configuration options,
30
+ please visit our [documentation](https://rotki.github.io/eslint-plugin).
31
+
32
+ ## Contributing
33
+
34
+ Contributions are welcome!
35
+ Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request.
36
+ The guide includes detailed information about:
37
+
38
+ - Project prerequisites
39
+ - Development setup
40
+ - Commit message conventions
41
+ - Code style and linting
42
+ - Pull request process
13
43
 
14
44
  ## License
15
45
 
16
- [AGPL-3.0](./LICENSE) License © 2023- [Rotki Solutions GmbH](https://github.com/rotki)
46
+ [AGPL-3.0](./LICENSE.md) License © 2023- [Rotki Solutions GmbH](https://github.com/rotki)
package/dist/index.d.mts CHANGED
@@ -4,10 +4,15 @@ interface PluginRuleModule<TOptions extends readonly unknown[] = []> extends Rul
4
4
  defaultOptions: TOptions;
5
5
  }
6
6
 
7
- type Options$1 = [{
7
+ type Options$2 = [{
8
8
  legacy: boolean;
9
9
  }];
10
10
 
11
+ interface Options$1 {
12
+ max: number;
13
+ ignoreTypeImports: boolean;
14
+ }
15
+
11
16
  type Options = [{
12
17
  allowInference: boolean;
13
18
  }];
@@ -19,8 +24,9 @@ declare const plugin: {
19
24
  };
20
25
  rules: {
21
26
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
27
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
22
28
  'no-deprecated-classes': PluginRuleModule<[]>;
23
- 'no-deprecated-components': PluginRuleModule<Options$1>;
29
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
24
30
  'no-deprecated-props': PluginRuleModule<[]>;
25
31
  'no-dot-ts-imports': PluginRuleModule<[]>;
26
32
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -34,8 +40,9 @@ declare const _default: {
34
40
  };
35
41
  rules: {
36
42
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
43
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
37
44
  'no-deprecated-classes': PluginRuleModule<[]>;
38
- 'no-deprecated-components': PluginRuleModule<Options$1>;
45
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
39
46
  'no-deprecated-props': PluginRuleModule<[]>;
40
47
  'no-dot-ts-imports': PluginRuleModule<[]>;
41
48
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -51,8 +58,9 @@ declare const _default: {
51
58
  };
52
59
  rules: {
53
60
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
61
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
54
62
  'no-deprecated-classes': PluginRuleModule<[]>;
55
- 'no-deprecated-components': PluginRuleModule<Options$1>;
63
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
56
64
  'no-deprecated-props': PluginRuleModule<[]>;
57
65
  'no-dot-ts-imports': PluginRuleModule<[]>;
58
66
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -77,8 +85,9 @@ declare const _default: {
77
85
  };
78
86
  rules: {
79
87
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
88
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
80
89
  'no-deprecated-classes': PluginRuleModule<[]>;
81
- 'no-deprecated-components': PluginRuleModule<Options$1>;
90
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
82
91
  'no-deprecated-props': PluginRuleModule<[]>;
83
92
  'no-dot-ts-imports': PluginRuleModule<[]>;
84
93
  'no-legacy-library-import': PluginRuleModule<[]>;
package/dist/index.d.ts CHANGED
@@ -4,10 +4,15 @@ interface PluginRuleModule<TOptions extends readonly unknown[] = []> extends Rul
4
4
  defaultOptions: TOptions;
5
5
  }
6
6
 
7
- type Options$1 = [{
7
+ type Options$2 = [{
8
8
  legacy: boolean;
9
9
  }];
10
10
 
11
+ interface Options$1 {
12
+ max: number;
13
+ ignoreTypeImports: boolean;
14
+ }
15
+
11
16
  type Options = [{
12
17
  allowInference: boolean;
13
18
  }];
@@ -19,8 +24,9 @@ declare const plugin: {
19
24
  };
20
25
  rules: {
21
26
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
27
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
22
28
  'no-deprecated-classes': PluginRuleModule<[]>;
23
- 'no-deprecated-components': PluginRuleModule<Options$1>;
29
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
24
30
  'no-deprecated-props': PluginRuleModule<[]>;
25
31
  'no-dot-ts-imports': PluginRuleModule<[]>;
26
32
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -34,8 +40,9 @@ declare const _default: {
34
40
  };
35
41
  rules: {
36
42
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
43
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
37
44
  'no-deprecated-classes': PluginRuleModule<[]>;
38
- 'no-deprecated-components': PluginRuleModule<Options$1>;
45
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
39
46
  'no-deprecated-props': PluginRuleModule<[]>;
40
47
  'no-dot-ts-imports': PluginRuleModule<[]>;
41
48
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -51,8 +58,9 @@ declare const _default: {
51
58
  };
52
59
  rules: {
53
60
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
61
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
54
62
  'no-deprecated-classes': PluginRuleModule<[]>;
55
- 'no-deprecated-components': PluginRuleModule<Options$1>;
63
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
56
64
  'no-deprecated-props': PluginRuleModule<[]>;
57
65
  'no-dot-ts-imports': PluginRuleModule<[]>;
58
66
  'no-legacy-library-import': PluginRuleModule<[]>;
@@ -77,8 +85,9 @@ declare const _default: {
77
85
  };
78
86
  rules: {
79
87
  'consistent-ref-type-annotation': PluginRuleModule<Options>;
88
+ 'max-dependencies': PluginRuleModule<[Options$1]>;
80
89
  'no-deprecated-classes': PluginRuleModule<[]>;
81
- 'no-deprecated-components': PluginRuleModule<Options$1>;
90
+ 'no-deprecated-components': PluginRuleModule<Options$2>;
82
91
  'no-deprecated-props': PluginRuleModule<[]>;
83
92
  'no-dot-ts-imports': PluginRuleModule<[]>;
84
93
  'no-legacy-library-import': PluginRuleModule<[]>;