eslint-plugin-remeda 1.5.0 → 1.7.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 (6) hide show
  1. package/dist/index.cjs +3828 -3708
  2. package/dist/index.d.cts +58 -186
  3. package/dist/index.d.ts +58 -186
  4. package/dist/index.js +3814 -3711
  5. package/docs/rules/prefer-has-atleast.md +89 -0
  6. package/package.json +27 -21
package/dist/index.d.cts CHANGED
@@ -1,201 +1,73 @@
1
- interface RemedaMethodVisitors {
2
- [key: string]: any;
3
- }
1
+ import { RuleListener, RuleModule } from "@typescript-eslint/utils/ts-eslint";
4
2
 
3
+ //#region src/index.d.ts
5
4
  declare const plugin: {
6
5
  meta: {
7
6
  name: string;
8
7
  version: string;
9
8
  };
10
9
  rules: {
11
- "collection-method-value": {
12
- create: (context: any) => RemedaMethodVisitors;
13
- meta: {
14
- readonly type: "problem";
15
- readonly schema: readonly [];
16
- readonly docs: {
17
- readonly description: "Use value returned from collection methods properly";
18
- readonly url: string;
19
- };
20
- };
21
- };
22
- "collection-return": {
23
- create: (context: any) => {
24
- "CallExpression:exit": (node: any) => void;
25
- ReturnStatement(): void;
26
- onCodePathStart(codePath: any, node: any): void;
27
- onCodePathEnd(): void;
28
- } & {
29
- ImportDeclaration({ source, specifiers }: {
30
- source: any;
31
- specifiers: any;
32
- }): void;
33
- VariableDeclarator({ init, id }: {
34
- init: any;
35
- id: any;
36
- }): void;
37
- };
38
- meta: {
39
- readonly type: "problem";
40
- readonly schema: readonly [];
41
- readonly docs: {
42
- readonly description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`";
43
- readonly url: string;
44
- };
45
- };
46
- };
47
- "prefer-constant": {
48
- create: (context: any) => {
49
- FunctionExpression: (node: any) => void;
50
- FunctionDeclaration(node: any): void;
51
- ArrowFunctionExpression(node: any): void;
52
- };
53
- meta: {
54
- readonly type: "problem";
55
- readonly docs: {
56
- readonly description: "Prefer R.constant over functions returning literals";
57
- readonly url: string;
58
- };
59
- readonly schema: readonly [{
60
- readonly type: "boolean";
61
- }, {
62
- readonly type: "boolean";
63
- }];
64
- };
65
- };
66
- "prefer-do-nothing": {
67
- create: (context: any) => {
68
- FunctionExpression: (node: any) => void;
69
- ArrowFunctionExpression: (node: any) => void;
70
- };
71
- meta: {
72
- readonly type: "problem";
73
- readonly schema: readonly [];
74
- readonly docs: {
75
- readonly description: "Prefer R.doNothing() or R.constant(undefined) over an empty function";
76
- readonly url: string;
77
- };
78
- };
79
- };
80
- "prefer-filter": {
81
- create: (context: any) => RemedaMethodVisitors;
82
- meta: {
83
- readonly type: "problem";
84
- readonly docs: {
85
- readonly description: "Prefer R.filter or R.some over an if statement inside a R.forEach";
86
- readonly url: string;
87
- };
88
- readonly schema: readonly [{
89
- readonly type: "integer";
90
- }];
91
- };
92
- };
93
- "prefer-find": {
94
- create: (context: any) => RemedaMethodVisitors;
95
- meta: {
96
- readonly type: "problem";
97
- readonly schema: readonly [];
98
- readonly docs: {
99
- readonly description: "Prefer using `R.find` over selecting the first item of a filtered result";
100
- readonly url: string;
101
- };
102
- };
103
- };
104
- "prefer-flat-map": {
105
- create: (context: any) => RemedaMethodVisitors;
106
- meta: {
107
- readonly type: "problem";
108
- readonly schema: readonly [];
109
- readonly docs: {
110
- readonly description: "Prefer R.flatMap over consecutive R.map and R.flat.";
111
- readonly url: string;
112
- };
113
- };
114
- };
115
- "prefer-is-empty": {
116
- create: (context: any) => RemedaMethodVisitors;
117
- meta: {
118
- readonly type: "problem";
119
- readonly schema: readonly [];
120
- readonly docs: {
121
- readonly description: "Prefer R.isEmpty over manually checking for length value.";
122
- readonly url: string;
123
- };
124
- readonly fixable: "code";
125
- };
126
- };
127
- "prefer-is-nullish": {
128
- create: (context: any) => RemedaMethodVisitors;
129
- meta: {
130
- readonly type: "problem";
131
- readonly schema: readonly [];
132
- readonly docs: {
133
- readonly description: "Prefer R.isNullish over checks for both null and undefined.";
134
- readonly url: string;
135
- };
136
- };
137
- };
138
- "prefer-map": {
139
- create: (context: any) => RemedaMethodVisitors;
140
- meta: {
141
- readonly type: "problem";
142
- readonly schema: readonly [];
143
- readonly docs: {
144
- readonly description: "Prefer R.map over a R.forEach with a push to an array inside";
145
- readonly url: string;
146
- };
147
- };
148
- };
149
- "prefer-nullish-coalescing": {
150
- create: (context: any) => RemedaMethodVisitors;
151
- meta: {
152
- readonly type: "problem";
153
- readonly schema: readonly [];
154
- readonly docs: {
155
- readonly description: "Prefer nullish coalescing over checking a ternary with !isNullish.";
156
- readonly url: string;
157
- };
158
- readonly fixable: "code";
159
- };
160
- };
161
- "prefer-remeda-typecheck": {
162
- create: (context: any) => {
163
- BinaryExpression(node: any): void;
164
- };
165
- meta: {
166
- readonly type: "problem";
167
- readonly schema: readonly [];
168
- readonly docs: {
169
- readonly description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.";
170
- readonly url: string;
10
+ "collection-method-value": RuleModule<"useReturnValueId" | "dontUseReturnValueId", [], unknown, RuleListener>;
11
+ "collection-return": RuleModule<"no-return", [], unknown, RuleListener>;
12
+ "prefer-constant": RuleModule<"prefer-constant", [(boolean | undefined)?, (boolean | undefined)?], unknown, RuleListener>;
13
+ "prefer-do-nothing": RuleModule<"prefer-do-nothing", [], unknown, RuleListener>;
14
+ "prefer-filter": RuleModule<"prefer-filter", [{
15
+ maxPropertyPathLength?: number;
16
+ }], unknown, RuleListener>;
17
+ "prefer-find": RuleModule<"prefer-find" | "prefer-find-last", [], unknown, RuleListener>;
18
+ "prefer-flat-map": RuleModule<"prefer-flat-map", [], unknown, RuleListener>;
19
+ "prefer-has-atleast": RuleModule<"prefer-has-atleast" | "prefer-has-atleast-over-negated-isempty", [], unknown, RuleListener>;
20
+ "prefer-is-empty": RuleModule<"preferIsEmpty", [], unknown, RuleListener>;
21
+ "prefer-is-nullish": RuleModule<"prefer-is-nullish", [], unknown, RuleListener>;
22
+ "prefer-map": RuleModule<"prefer-map", [], unknown, RuleListener>;
23
+ "prefer-nullish-coalescing": RuleModule<"prefer-nullish-coalescing", [], unknown, RuleListener>;
24
+ "prefer-remeda-typecheck": RuleModule<"prefer-remeda-typecheck", [], unknown, RuleListener>;
25
+ "prefer-some": RuleModule<"prefer-some", [], unknown, RuleListener>;
26
+ "prefer-times": RuleModule<"prefer-times", [], unknown, RuleListener>;
27
+ };
28
+ configs: {};
29
+ processors: {};
30
+ };
31
+ declare const configs: {
32
+ recommended: {
33
+ plugins: {
34
+ [x: string]: {
35
+ meta: {
36
+ name: string;
37
+ version: string;
171
38
  };
172
- };
173
- };
174
- "prefer-some": {
175
- create: (context: any) => RemedaMethodVisitors;
176
- meta: {
177
- readonly type: "problem";
178
- readonly docs: {
179
- readonly description: "Prefer R.some over findIndex comparison to -1";
180
- readonly url: string;
39
+ rules: {
40
+ "collection-method-value": RuleModule<"useReturnValueId" | "dontUseReturnValueId", [], unknown, RuleListener>;
41
+ "collection-return": RuleModule<"no-return", [], unknown, RuleListener>;
42
+ "prefer-constant": RuleModule<"prefer-constant", [(boolean | undefined)?, (boolean | undefined)?], unknown, RuleListener>;
43
+ "prefer-do-nothing": RuleModule<"prefer-do-nothing", [], unknown, RuleListener>;
44
+ "prefer-filter": RuleModule<"prefer-filter", [{
45
+ maxPropertyPathLength?: number;
46
+ }], unknown, RuleListener>;
47
+ "prefer-find": RuleModule<"prefer-find" | "prefer-find-last", [], unknown, RuleListener>;
48
+ "prefer-flat-map": RuleModule<"prefer-flat-map", [], unknown, RuleListener>;
49
+ "prefer-has-atleast": RuleModule<"prefer-has-atleast" | "prefer-has-atleast-over-negated-isempty", [], unknown, RuleListener>;
50
+ "prefer-is-empty": RuleModule<"preferIsEmpty", [], unknown, RuleListener>;
51
+ "prefer-is-nullish": RuleModule<"prefer-is-nullish", [], unknown, RuleListener>;
52
+ "prefer-map": RuleModule<"prefer-map", [], unknown, RuleListener>;
53
+ "prefer-nullish-coalescing": RuleModule<"prefer-nullish-coalescing", [], unknown, RuleListener>;
54
+ "prefer-remeda-typecheck": RuleModule<"prefer-remeda-typecheck", [], unknown, RuleListener>;
55
+ "prefer-some": RuleModule<"prefer-some", [], unknown, RuleListener>;
56
+ "prefer-times": RuleModule<"prefer-times", [], unknown, RuleListener>;
181
57
  };
182
- readonly schema: readonly [];
58
+ configs: {};
59
+ processors: {};
183
60
  };
184
61
  };
185
- "prefer-times": {
186
- create: (context: any) => RemedaMethodVisitors;
187
- meta: {
188
- readonly type: "problem";
189
- readonly schema: readonly [];
190
- readonly docs: {
191
- readonly description: "Prefer R.times over R.map without using arguments";
192
- readonly url: string;
193
- };
194
- };
62
+ rules: {
63
+ [x: string]: number | number[];
195
64
  };
196
65
  };
197
- configs: {};
198
- processors: {};
199
66
  };
67
+ type Plugin = typeof plugin & {
68
+ configs: typeof configs;
69
+ };
70
+ declare const _default: Plugin;
200
71
 
201
- export { plugin as default };
72
+ //#endregion
73
+ export { _default as default };
package/dist/index.d.ts CHANGED
@@ -1,201 +1,73 @@
1
- interface RemedaMethodVisitors {
2
- [key: string]: any;
3
- }
1
+ import { RuleListener, RuleModule } from "@typescript-eslint/utils/ts-eslint";
4
2
 
3
+ //#region src/index.d.ts
5
4
  declare const plugin: {
6
5
  meta: {
7
6
  name: string;
8
7
  version: string;
9
8
  };
10
9
  rules: {
11
- "collection-method-value": {
12
- create: (context: any) => RemedaMethodVisitors;
13
- meta: {
14
- readonly type: "problem";
15
- readonly schema: readonly [];
16
- readonly docs: {
17
- readonly description: "Use value returned from collection methods properly";
18
- readonly url: string;
19
- };
20
- };
21
- };
22
- "collection-return": {
23
- create: (context: any) => {
24
- "CallExpression:exit": (node: any) => void;
25
- ReturnStatement(): void;
26
- onCodePathStart(codePath: any, node: any): void;
27
- onCodePathEnd(): void;
28
- } & {
29
- ImportDeclaration({ source, specifiers }: {
30
- source: any;
31
- specifiers: any;
32
- }): void;
33
- VariableDeclarator({ init, id }: {
34
- init: any;
35
- id: any;
36
- }): void;
37
- };
38
- meta: {
39
- readonly type: "problem";
40
- readonly schema: readonly [];
41
- readonly docs: {
42
- readonly description: "Always return a value in iteratees of Remeda collection methods that aren't `forEach`";
43
- readonly url: string;
44
- };
45
- };
46
- };
47
- "prefer-constant": {
48
- create: (context: any) => {
49
- FunctionExpression: (node: any) => void;
50
- FunctionDeclaration(node: any): void;
51
- ArrowFunctionExpression(node: any): void;
52
- };
53
- meta: {
54
- readonly type: "problem";
55
- readonly docs: {
56
- readonly description: "Prefer R.constant over functions returning literals";
57
- readonly url: string;
58
- };
59
- readonly schema: readonly [{
60
- readonly type: "boolean";
61
- }, {
62
- readonly type: "boolean";
63
- }];
64
- };
65
- };
66
- "prefer-do-nothing": {
67
- create: (context: any) => {
68
- FunctionExpression: (node: any) => void;
69
- ArrowFunctionExpression: (node: any) => void;
70
- };
71
- meta: {
72
- readonly type: "problem";
73
- readonly schema: readonly [];
74
- readonly docs: {
75
- readonly description: "Prefer R.doNothing() or R.constant(undefined) over an empty function";
76
- readonly url: string;
77
- };
78
- };
79
- };
80
- "prefer-filter": {
81
- create: (context: any) => RemedaMethodVisitors;
82
- meta: {
83
- readonly type: "problem";
84
- readonly docs: {
85
- readonly description: "Prefer R.filter or R.some over an if statement inside a R.forEach";
86
- readonly url: string;
87
- };
88
- readonly schema: readonly [{
89
- readonly type: "integer";
90
- }];
91
- };
92
- };
93
- "prefer-find": {
94
- create: (context: any) => RemedaMethodVisitors;
95
- meta: {
96
- readonly type: "problem";
97
- readonly schema: readonly [];
98
- readonly docs: {
99
- readonly description: "Prefer using `R.find` over selecting the first item of a filtered result";
100
- readonly url: string;
101
- };
102
- };
103
- };
104
- "prefer-flat-map": {
105
- create: (context: any) => RemedaMethodVisitors;
106
- meta: {
107
- readonly type: "problem";
108
- readonly schema: readonly [];
109
- readonly docs: {
110
- readonly description: "Prefer R.flatMap over consecutive R.map and R.flat.";
111
- readonly url: string;
112
- };
113
- };
114
- };
115
- "prefer-is-empty": {
116
- create: (context: any) => RemedaMethodVisitors;
117
- meta: {
118
- readonly type: "problem";
119
- readonly schema: readonly [];
120
- readonly docs: {
121
- readonly description: "Prefer R.isEmpty over manually checking for length value.";
122
- readonly url: string;
123
- };
124
- readonly fixable: "code";
125
- };
126
- };
127
- "prefer-is-nullish": {
128
- create: (context: any) => RemedaMethodVisitors;
129
- meta: {
130
- readonly type: "problem";
131
- readonly schema: readonly [];
132
- readonly docs: {
133
- readonly description: "Prefer R.isNullish over checks for both null and undefined.";
134
- readonly url: string;
135
- };
136
- };
137
- };
138
- "prefer-map": {
139
- create: (context: any) => RemedaMethodVisitors;
140
- meta: {
141
- readonly type: "problem";
142
- readonly schema: readonly [];
143
- readonly docs: {
144
- readonly description: "Prefer R.map over a R.forEach with a push to an array inside";
145
- readonly url: string;
146
- };
147
- };
148
- };
149
- "prefer-nullish-coalescing": {
150
- create: (context: any) => RemedaMethodVisitors;
151
- meta: {
152
- readonly type: "problem";
153
- readonly schema: readonly [];
154
- readonly docs: {
155
- readonly description: "Prefer nullish coalescing over checking a ternary with !isNullish.";
156
- readonly url: string;
157
- };
158
- readonly fixable: "code";
159
- };
160
- };
161
- "prefer-remeda-typecheck": {
162
- create: (context: any) => {
163
- BinaryExpression(node: any): void;
164
- };
165
- meta: {
166
- readonly type: "problem";
167
- readonly schema: readonly [];
168
- readonly docs: {
169
- readonly description: "Prefer using `R.is*` methods over `typeof` and `instanceof` checks when applicable.";
170
- readonly url: string;
10
+ "collection-method-value": RuleModule<"useReturnValueId" | "dontUseReturnValueId", [], unknown, RuleListener>;
11
+ "collection-return": RuleModule<"no-return", [], unknown, RuleListener>;
12
+ "prefer-constant": RuleModule<"prefer-constant", [(boolean | undefined)?, (boolean | undefined)?], unknown, RuleListener>;
13
+ "prefer-do-nothing": RuleModule<"prefer-do-nothing", [], unknown, RuleListener>;
14
+ "prefer-filter": RuleModule<"prefer-filter", [{
15
+ maxPropertyPathLength?: number;
16
+ }], unknown, RuleListener>;
17
+ "prefer-find": RuleModule<"prefer-find" | "prefer-find-last", [], unknown, RuleListener>;
18
+ "prefer-flat-map": RuleModule<"prefer-flat-map", [], unknown, RuleListener>;
19
+ "prefer-has-atleast": RuleModule<"prefer-has-atleast" | "prefer-has-atleast-over-negated-isempty", [], unknown, RuleListener>;
20
+ "prefer-is-empty": RuleModule<"preferIsEmpty", [], unknown, RuleListener>;
21
+ "prefer-is-nullish": RuleModule<"prefer-is-nullish", [], unknown, RuleListener>;
22
+ "prefer-map": RuleModule<"prefer-map", [], unknown, RuleListener>;
23
+ "prefer-nullish-coalescing": RuleModule<"prefer-nullish-coalescing", [], unknown, RuleListener>;
24
+ "prefer-remeda-typecheck": RuleModule<"prefer-remeda-typecheck", [], unknown, RuleListener>;
25
+ "prefer-some": RuleModule<"prefer-some", [], unknown, RuleListener>;
26
+ "prefer-times": RuleModule<"prefer-times", [], unknown, RuleListener>;
27
+ };
28
+ configs: {};
29
+ processors: {};
30
+ };
31
+ declare const configs: {
32
+ recommended: {
33
+ plugins: {
34
+ [x: string]: {
35
+ meta: {
36
+ name: string;
37
+ version: string;
171
38
  };
172
- };
173
- };
174
- "prefer-some": {
175
- create: (context: any) => RemedaMethodVisitors;
176
- meta: {
177
- readonly type: "problem";
178
- readonly docs: {
179
- readonly description: "Prefer R.some over findIndex comparison to -1";
180
- readonly url: string;
39
+ rules: {
40
+ "collection-method-value": RuleModule<"useReturnValueId" | "dontUseReturnValueId", [], unknown, RuleListener>;
41
+ "collection-return": RuleModule<"no-return", [], unknown, RuleListener>;
42
+ "prefer-constant": RuleModule<"prefer-constant", [(boolean | undefined)?, (boolean | undefined)?], unknown, RuleListener>;
43
+ "prefer-do-nothing": RuleModule<"prefer-do-nothing", [], unknown, RuleListener>;
44
+ "prefer-filter": RuleModule<"prefer-filter", [{
45
+ maxPropertyPathLength?: number;
46
+ }], unknown, RuleListener>;
47
+ "prefer-find": RuleModule<"prefer-find" | "prefer-find-last", [], unknown, RuleListener>;
48
+ "prefer-flat-map": RuleModule<"prefer-flat-map", [], unknown, RuleListener>;
49
+ "prefer-has-atleast": RuleModule<"prefer-has-atleast" | "prefer-has-atleast-over-negated-isempty", [], unknown, RuleListener>;
50
+ "prefer-is-empty": RuleModule<"preferIsEmpty", [], unknown, RuleListener>;
51
+ "prefer-is-nullish": RuleModule<"prefer-is-nullish", [], unknown, RuleListener>;
52
+ "prefer-map": RuleModule<"prefer-map", [], unknown, RuleListener>;
53
+ "prefer-nullish-coalescing": RuleModule<"prefer-nullish-coalescing", [], unknown, RuleListener>;
54
+ "prefer-remeda-typecheck": RuleModule<"prefer-remeda-typecheck", [], unknown, RuleListener>;
55
+ "prefer-some": RuleModule<"prefer-some", [], unknown, RuleListener>;
56
+ "prefer-times": RuleModule<"prefer-times", [], unknown, RuleListener>;
181
57
  };
182
- readonly schema: readonly [];
58
+ configs: {};
59
+ processors: {};
183
60
  };
184
61
  };
185
- "prefer-times": {
186
- create: (context: any) => RemedaMethodVisitors;
187
- meta: {
188
- readonly type: "problem";
189
- readonly schema: readonly [];
190
- readonly docs: {
191
- readonly description: "Prefer R.times over R.map without using arguments";
192
- readonly url: string;
193
- };
194
- };
62
+ rules: {
63
+ [x: string]: number | number[];
195
64
  };
196
65
  };
197
- configs: {};
198
- processors: {};
199
66
  };
67
+ type Plugin = typeof plugin & {
68
+ configs: typeof configs;
69
+ };
70
+ declare const _default: Plugin;
200
71
 
201
- export { plugin as default };
72
+ //#endregion
73
+ export { _default as default };