@akinon/eslint-plugin-projectzero 2.0.0-rc.7 → 2.0.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.
package/CHANGELOG.md CHANGED
@@ -1,20 +1,282 @@
1
1
  # @akinon/eslint-plugin-projectzero
2
2
 
3
- ## 2.0.0-rc.7
3
+ ## 2.0.0
4
4
 
5
- ## 1.24.0-rc.6
5
+ ## 2.0.0-beta.27
6
6
 
7
- ## 1.24.0-rc.5
7
+ ## 2.0.0-beta.26
8
8
 
9
- ## 1.24.0-rc.4
9
+ ## 2.0.0-beta.25
10
10
 
11
- ## 1.24.0-rc.3
11
+ ## 2.0.0-beta.24
12
12
 
13
- ## 1.24.0-rc.2
13
+ ## 2.0.0-beta.23
14
14
 
15
- ## 1.24.0-rc.1
15
+ ## 2.0.0-beta.22
16
16
 
17
- ## 1.24.0-rc.0
17
+ ## 2.0.0-beta.21
18
+
19
+ ## 2.0.0-beta.20
20
+
21
+ ## 1.126.0
22
+
23
+ ## 1.125.2
24
+
25
+ ## 1.125.1
26
+
27
+ ## 1.125.0
28
+
29
+ ## 1.124.0
30
+
31
+ ## 1.123.0
32
+
33
+ ## 1.122.0
34
+
35
+ ## 1.121.0
36
+
37
+ ## 1.120.0
38
+
39
+ ## 1.119.0
40
+
41
+ ## 1.118.0
42
+
43
+ ## 1.117.0
44
+
45
+ ## 1.116.0
46
+
47
+ ## 1.115.0
48
+
49
+ ## 1.114.0
50
+
51
+ ## 1.113.0
52
+
53
+ ## 1.112.0
54
+
55
+ ## 1.111.0
56
+
57
+ ## 1.110.0
58
+
59
+ ## 1.109.0
60
+
61
+ ## 1.108.0
62
+
63
+ ## 1.107.0
64
+
65
+ ## 1.106.0
66
+
67
+ ## 1.105.0
68
+
69
+ ### Minor Changes
70
+
71
+ - 62779ee: ZERO-3668: Refactor check-menu-depth rule to simplify depth validation logic and remove unused error messages
72
+
73
+ ## 1.104.0
74
+
75
+ ## 1.103.0
76
+
77
+ ## 1.102.0
78
+
79
+ ## 1.101.0
80
+
81
+ ## 1.100.0
82
+
83
+ ### Minor Changes
84
+
85
+ - e57cd93: ZERO-3460: prevent installment loop on payment method switch
86
+
87
+ ## 1.99.0
88
+
89
+ ### Minor Changes
90
+
91
+ - d58538b: ZERO-3638: Enhance RC pipeline: add fetch, merge, and pre-release setup with conditional commit
92
+
93
+ ## 1.98.0
94
+
95
+ ## 1.97.0
96
+
97
+ ## 1.96.0
98
+
99
+ ## 1.95.0
100
+
101
+ ### Minor Changes
102
+
103
+ - 3b47394: ZERO-3582: Enhance check-menu-depth rule to enforce depth parameter in getMenu calls and add corresponding error messages
104
+
105
+ ## 1.94.0
106
+
107
+ ## 1.93.0
108
+
109
+ ## 1.92.0
110
+
111
+ ## 1.91.0
112
+
113
+ ## 1.90.0
114
+
115
+ ## 1.89.0
116
+
117
+ ## 1.88.0
118
+
119
+ ## 1.87.0
120
+
121
+ ## 1.86.0
122
+
123
+ ## 1.85.0
124
+
125
+ ### Minor Changes
126
+
127
+ - 443ea19: ZERO-3254: Add ESLint rule to enforce correct order of pre-order middlewares
128
+
129
+ ## 1.84.0
130
+
131
+ ## 1.83.0
132
+
133
+ ## 1.82.0
134
+
135
+ ## 1.81.0
136
+
137
+ ## 1.80.0
138
+
139
+ ## 1.79.0
140
+
141
+ ## 1.78.0
142
+
143
+ ## 1.77.0
144
+
145
+ ## 1.76.0
146
+
147
+ ## 1.75.0
148
+
149
+ ## 1.74.0
150
+
151
+ ## 1.73.0
152
+
153
+ ## 1.72.0
154
+
155
+ ## 1.71.0
156
+
157
+ ## 1.70.0
158
+
159
+ ## 1.69.0
160
+
161
+ ## 1.68.0
162
+
163
+ ## 1.67.0
164
+
165
+ ## 1.66.0
166
+
167
+ ## 1.65.0
168
+
169
+ ### Minor Changes
170
+
171
+ - 5a4c607: ZERO-2764: Add case-warning rule to eslint-plugin-projectzero
172
+
173
+ ## 1.64.0
174
+
175
+ ## 1.63.0
176
+
177
+ ## 1.62.0
178
+
179
+ ## 1.61.0
180
+
181
+ ## 1.60.0
182
+
183
+ ## 1.59.0
184
+
185
+ ## 1.58.0
186
+
187
+ ## 1.57.0
188
+
189
+ ## 1.56.0
190
+
191
+ ### Minor Changes
192
+
193
+ - 4d64ef7: ZERO-2611: Add check-sentry-options rule to eslint-plugin-projectzero
194
+
195
+ ## 1.55.0
196
+
197
+ ## 1.54.0
198
+
199
+ ### Minor Changes
200
+
201
+ - c474780: ZERO-2666: Add rule to check menu depth
202
+
203
+ ## 1.53.0
204
+
205
+ ## 1.52.0
206
+
207
+ ## 1.51.0
208
+
209
+ ## 1.50.0
210
+
211
+ ## 1.49.0
212
+
213
+ ## 1.48.0
214
+
215
+ ## 1.47.0
216
+
217
+ ## 1.46.0
218
+
219
+ ## 1.45.0
220
+
221
+ ## 1.44.0
222
+
223
+ ## 1.43.0
224
+
225
+ ## 1.42.0
226
+
227
+ ## 1.41.0
228
+
229
+ ## 1.40.0
230
+
231
+ ## 1.39.0
232
+
233
+ ## 1.38.0
234
+
235
+ ## 1.37.0
236
+
237
+ ## 1.36.0
238
+
239
+ ## 1.35.0
240
+
241
+ ## 1.34.0
242
+
243
+ ## 1.33.2
244
+
245
+ ## 1.33.1
246
+
247
+ ## 1.33.0
248
+
249
+ ## 1.32.0
250
+
251
+ ## 1.31.1
252
+
253
+ ## 1.31.0
254
+
255
+ ## 1.30.2
256
+
257
+ ## 1.30.1
258
+
259
+ ## 1.30.0
260
+
261
+ ### Patch Changes
262
+
263
+ - 073fbd2: ZERO-2503: Add check changeset control script
264
+
265
+ ## 1.29.0
266
+
267
+ ## 1.27.0
268
+
269
+ ## 1.26.0
270
+
271
+ ## 1.25.0
272
+
273
+ ## 1.24.1
274
+
275
+ ### Patch Changes
276
+
277
+ - 95510c7: ZERO-2508: Enable rc branch pipeline and add check-publish-version step
278
+
279
+ ## 1.24.0
18
280
 
19
281
  ## 1.23.0
20
282
 
package/configs/core.ts CHANGED
@@ -9,6 +9,9 @@ export default {
9
9
  '@akinon/projectzero/meta-data-import': 'error',
10
10
  '@akinon/projectzero/urls-without-slash': 'error',
11
11
  '@akinon/projectzero/invalid-imports': 'error',
12
+ '@akinon/projectzero/case-warning': 'warn',
13
+ '@akinon/projectzero/check-sentry-options': 'error',
14
+ '@akinon/projectzero/check-menu-depth': 'error',
12
15
  'no-restricted-syntax': [
13
16
  'error',
14
17
  {
@@ -11,6 +11,9 @@ exports.default = {
11
11
  '@akinon/projectzero/meta-data-import': 'error',
12
12
  '@akinon/projectzero/urls-without-slash': 'error',
13
13
  '@akinon/projectzero/invalid-imports': 'error',
14
+ '@akinon/projectzero/case-warning': 'warn',
15
+ '@akinon/projectzero/check-sentry-options': 'error',
16
+ '@akinon/projectzero/check-menu-depth': 'error',
14
17
  'no-restricted-syntax': [
15
18
  'error',
16
19
  {
package/dist/index.js CHANGED
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  var __exportStar = (this && this.__exportStar) || function(m, exports) {
19
19
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
20
20
  };
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.configs = void 0;
30
40
  __exportStar(require("./rules"), exports);
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const utils_1 = require("@typescript-eslint/utils");
4
+ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
5
+ create(context) {
6
+ return {
7
+ CallExpression(node) {
8
+ if (node.callee.type === 'MemberExpression' &&
9
+ node.callee.property.type === 'Identifier' &&
10
+ (node.callee.property.name === 'toLocaleUpperCase' ||
11
+ node.callee.property.name === 'toLocaleLowerCase')) {
12
+ const args = node.arguments;
13
+ if (args.length === 0) {
14
+ context.report({
15
+ node,
16
+ messageId: 'noLocale'
17
+ });
18
+ }
19
+ }
20
+ }
21
+ };
22
+ },
23
+ meta: {
24
+ messages: {
25
+ noLocale: 'toLocaleUpperCase() or toLocaleLowerCase() should specify a locale for consistent behavior across different environments.'
26
+ },
27
+ type: 'problem',
28
+ fixable: 'code',
29
+ schema: []
30
+ },
31
+ defaultOptions: []
32
+ });
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  Object.defineProperty(exports, "__esModule", { value: true });
26
36
  const utils_1 = require("@typescript-eslint/utils");
27
37
  const path = __importStar(require("path"));
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const utils_1 = require("@typescript-eslint/utils");
4
+ const types_1 = require("@typescript-eslint/types");
5
+ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
6
+ create: function (context) {
7
+ return {
8
+ CallExpression(node) {
9
+ const { callee, arguments: args } = node;
10
+ if (callee.type !== types_1.AST_NODE_TYPES.Identifier ||
11
+ callee.name !== 'getMenu' ||
12
+ args.length === 0 ||
13
+ args[0].type !== types_1.AST_NODE_TYPES.ObjectExpression) {
14
+ return;
15
+ }
16
+ const depthProperty = args[0].properties.find((prop) => {
17
+ var _a;
18
+ return prop.type === types_1.AST_NODE_TYPES.Property &&
19
+ prop.key.type === types_1.AST_NODE_TYPES.Identifier &&
20
+ prop.key.name === 'depth' &&
21
+ ((_a = prop.value) === null || _a === void 0 ? void 0 : _a.type) === types_1.AST_NODE_TYPES.Literal &&
22
+ typeof prop.value.value === 'number' &&
23
+ prop.value.value > 3;
24
+ });
25
+ if (depthProperty) {
26
+ context.report({
27
+ node: depthProperty,
28
+ messageId: 'depthMessage'
29
+ });
30
+ }
31
+ }
32
+ };
33
+ },
34
+ meta: {
35
+ type: 'problem',
36
+ fixable: 'code',
37
+ messages: {
38
+ depthMessage: 'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.'
39
+ },
40
+ schema: []
41
+ },
42
+ defaultOptions: []
43
+ });
@@ -0,0 +1,87 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const utils_1 = require("@typescript-eslint/utils");
4
+ const CORRECT_PRE_ORDER_MIDDLEWARE_ORDER = [
5
+ 'shippingStepMiddleware',
6
+ 'installmentOptionMiddleware',
7
+ 'paymentOptionResetMiddleware',
8
+ 'paymentOptionMiddleware',
9
+ 'attributeBasedShippingOptionMiddleware',
10
+ 'dataSourceShippingOptionMiddleware',
11
+ 'shippingOptionMiddleware',
12
+ 'setAddressMiddleware',
13
+ 'deliveryOptionMiddleware',
14
+ 'setPreOrderMiddleware',
15
+ 'redirectionMiddleware',
16
+ 'preOrderValidationMiddleware'
17
+ ];
18
+ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
19
+ create(context) {
20
+ function checkPreOrderMiddlewareOrder(node) {
21
+ if (!isPreOrderMiddlewaresDeclaration(node)) {
22
+ return;
23
+ }
24
+ const arrayExpression = node.init;
25
+ const foundOrder = extractMiddlewareNames(arrayExpression);
26
+ validateMiddlewareOrder(foundOrder, node);
27
+ }
28
+ function isPreOrderMiddlewaresDeclaration(node) {
29
+ var _a;
30
+ return (node.id.type === utils_1.AST_NODE_TYPES.Identifier &&
31
+ node.id.name === 'preOrderMiddlewares' &&
32
+ ((_a = node.init) === null || _a === void 0 ? void 0 : _a.type) === utils_1.AST_NODE_TYPES.ArrayExpression);
33
+ }
34
+ function extractMiddlewareNames(arrayExpression) {
35
+ return arrayExpression.elements
36
+ .map((element) => {
37
+ if ((element === null || element === void 0 ? void 0 : element.type) === utils_1.AST_NODE_TYPES.Identifier) {
38
+ return element.name;
39
+ }
40
+ return null;
41
+ })
42
+ .filter((name) => Boolean(name));
43
+ }
44
+ function validateMiddlewareOrder(foundOrder, node) {
45
+ for (let i = 0; i < foundOrder.length; i++) {
46
+ const middleware = foundOrder[i];
47
+ const correctIndex = CORRECT_PRE_ORDER_MIDDLEWARE_ORDER.indexOf(middleware);
48
+ if (correctIndex === -1) {
49
+ context.report({
50
+ node,
51
+ messageId: 'unknownMiddleware',
52
+ data: { middleware }
53
+ });
54
+ break;
55
+ }
56
+ if (i !== correctIndex) {
57
+ context.report({
58
+ node,
59
+ messageId: 'incorrectPreOrderMiddlewarePosition',
60
+ data: {
61
+ middleware,
62
+ currentPosition: i + 1,
63
+ expectedPosition: correctIndex + 1
64
+ }
65
+ });
66
+ break;
67
+ }
68
+ }
69
+ }
70
+ return {
71
+ VariableDeclarator: checkPreOrderMiddlewareOrder
72
+ };
73
+ },
74
+ meta: {
75
+ type: 'problem',
76
+ docs: {
77
+ description: 'Enforces the correct order of pre-order middlewares',
78
+ recommended: 'error'
79
+ },
80
+ schema: [],
81
+ messages: {
82
+ incorrectPreOrderMiddlewarePosition: '{{middleware}} is at position {{currentPosition}}, but it should be at position {{expectedPosition}}.',
83
+ unknownMiddleware: '{{middleware}} is not recognized as a valid pre-order middleware.'
84
+ }
85
+ },
86
+ defaultOptions: []
87
+ });
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const utils_1 = require("@typescript-eslint/utils");
4
+ exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
5
+ create(context) {
6
+ return {
7
+ CallExpression(node) {
8
+ const callee = node.callee;
9
+ if (callee.object &&
10
+ callee.object.name === 'Sentry' &&
11
+ callee.property &&
12
+ callee.property.name === 'init') {
13
+ const optionsArgument = node
14
+ .arguments[0];
15
+ if (optionsArgument && optionsArgument.type === 'ObjectExpression') {
16
+ optionsArgument.properties.forEach((property) => {
17
+ if (property.type === 'Property') {
18
+ const key = property.key.name;
19
+ if (key === 'dsn') {
20
+ const dsnValue = property.value;
21
+ if (dsnValue.type === 'Literal' && !dsnValue.value) {
22
+ context.report({
23
+ node: property,
24
+ messageId: 'invalidDsn'
25
+ });
26
+ }
27
+ if (dsnValue.type === 'MemberExpression') {
28
+ const objectName = dsnValue.object
29
+ .name;
30
+ const propertyName = dsnValue.property.name;
31
+ if (objectName === 'process' && propertyName === 'env') {
32
+ return;
33
+ }
34
+ }
35
+ }
36
+ }
37
+ });
38
+ }
39
+ }
40
+ }
41
+ };
42
+ },
43
+ meta: {
44
+ messages: {
45
+ invalidDsn: 'Sentry DSN should not be empty.'
46
+ },
47
+ type: 'problem',
48
+ fixable: 'code',
49
+ schema: []
50
+ },
51
+ defaultOptions: []
52
+ });
@@ -14,6 +14,10 @@ const meta_data_import_1 = __importDefault(require("./meta-data-import"));
14
14
  const check_middleware_order_1 = __importDefault(require("./check-middleware-order"));
15
15
  const urls_without_slash_1 = __importDefault(require("./urls-without-slash"));
16
16
  const invalid_imports_1 = __importDefault(require("./invalid-imports"));
17
+ const case_warning_1 = __importDefault(require("./case-warning"));
18
+ const check_sentry_options_1 = __importDefault(require("./check-sentry-options"));
19
+ const check_menu_depth_1 = __importDefault(require("./check-menu-depth"));
20
+ const check_pre_order_middleware_order_1 = __importDefault(require("./check-pre-order-middleware-order"));
17
21
  const rules = {
18
22
  'client-url': client_url_1.default,
19
23
  'image-import': image_import_1.default,
@@ -24,6 +28,10 @@ const rules = {
24
28
  'meta-data-import': meta_data_import_1.default,
25
29
  'check-middleware-order': check_middleware_order_1.default,
26
30
  'urls-without-slash': urls_without_slash_1.default,
27
- 'invalid-imports': invalid_imports_1.default
31
+ 'invalid-imports': invalid_imports_1.default,
32
+ 'case-warning': case_warning_1.default,
33
+ 'check-sentry-options': check_sentry_options_1.default,
34
+ 'check-menu-depth': check_menu_depth_1.default,
35
+ 'check-pre-order-middleware-order': check_pre_order_middleware_order_1.default
28
36
  };
29
37
  exports.rules = rules;
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  Object.defineProperty(exports, "__esModule", { value: true });
26
36
  const utils_1 = require("@typescript-eslint/utils");
27
37
  const path = __importStar(require("path"));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@akinon/eslint-plugin-projectzero",
3
- "version": "2.0.0-rc.7",
3
+ "version": "2.0.0",
4
4
  "private": false,
5
5
  "description": "ESLint plugin for Project Zero Next",
6
6
  "main": "dist/index.js",
@@ -0,0 +1,39 @@
1
+ import { ESLintUtils } from '@typescript-eslint/utils';
2
+ import { TSESTree } from '@typescript-eslint/types';
3
+
4
+ type MessageIds = 'noLocale';
5
+ type Options = readonly [];
6
+
7
+ export default ESLintUtils.RuleCreator.withoutDocs<Options, MessageIds>({
8
+ create(context) {
9
+ return {
10
+ CallExpression(node: TSESTree.CallExpression) {
11
+ if (
12
+ node.callee.type === 'MemberExpression' &&
13
+ node.callee.property.type === 'Identifier' &&
14
+ (node.callee.property.name === 'toLocaleUpperCase' ||
15
+ node.callee.property.name === 'toLocaleLowerCase')
16
+ ) {
17
+ const args = node.arguments;
18
+
19
+ if (args.length === 0) {
20
+ context.report({
21
+ node,
22
+ messageId: 'noLocale'
23
+ });
24
+ }
25
+ }
26
+ }
27
+ };
28
+ },
29
+ meta: {
30
+ messages: {
31
+ noLocale:
32
+ 'toLocaleUpperCase() or toLocaleLowerCase() should specify a locale for consistent behavior across different environments.'
33
+ },
34
+ type: 'problem',
35
+ fixable: 'code',
36
+ schema: []
37
+ },
38
+ defaultOptions: []
39
+ });
@@ -0,0 +1,48 @@
1
+ import { ESLintUtils } from '@typescript-eslint/utils';
2
+ import { AST_NODE_TYPES } from '@typescript-eslint/types';
3
+
4
+ export default ESLintUtils.RuleCreator.withoutDocs({
5
+ create: function (context) {
6
+ return {
7
+ CallExpression(node) {
8
+ const { callee, arguments: args } = node;
9
+
10
+ if (
11
+ callee.type !== AST_NODE_TYPES.Identifier ||
12
+ callee.name !== 'getMenu' ||
13
+ args.length === 0 ||
14
+ args[0].type !== AST_NODE_TYPES.ObjectExpression
15
+ ) {
16
+ return;
17
+ }
18
+
19
+ const depthProperty = args[0].properties.find(
20
+ (prop) =>
21
+ prop.type === AST_NODE_TYPES.Property &&
22
+ prop.key.type === AST_NODE_TYPES.Identifier &&
23
+ prop.key.name === 'depth' &&
24
+ prop.value?.type === AST_NODE_TYPES.Literal &&
25
+ typeof prop.value.value === 'number' &&
26
+ prop.value.value > 3
27
+ );
28
+
29
+ if (depthProperty) {
30
+ context.report({
31
+ node: depthProperty,
32
+ messageId: 'depthMessage'
33
+ });
34
+ }
35
+ }
36
+ };
37
+ },
38
+ meta: {
39
+ type: 'problem',
40
+ fixable: 'code',
41
+ messages: {
42
+ depthMessage:
43
+ 'A request for a menu deeper than 3 levels from the server can lead to unnecessary memory usage and unwanted outcomes. Therefore, sending a request for a 3-level menu on the client side and making additional requests on hover for deeper levels may be more efficient.'
44
+ },
45
+ schema: []
46
+ },
47
+ defaultOptions: []
48
+ });
@@ -0,0 +1,116 @@
1
+ import {
2
+ AST_NODE_TYPES,
3
+ ESLintUtils,
4
+ TSESTree
5
+ } from '@typescript-eslint/utils';
6
+ import { RuleContext } from '@typescript-eslint/utils/dist/ts-eslint';
7
+
8
+ const CORRECT_PRE_ORDER_MIDDLEWARE_ORDER = [
9
+ 'shippingStepMiddleware',
10
+ 'installmentOptionMiddleware',
11
+ 'paymentOptionResetMiddleware',
12
+ 'paymentOptionMiddleware',
13
+ 'attributeBasedShippingOptionMiddleware',
14
+ 'dataSourceShippingOptionMiddleware',
15
+ 'shippingOptionMiddleware',
16
+ 'setAddressMiddleware',
17
+ 'deliveryOptionMiddleware',
18
+ 'setPreOrderMiddleware',
19
+ 'redirectionMiddleware',
20
+ 'preOrderValidationMiddleware'
21
+ ];
22
+
23
+ type MessageIds = 'incorrectPreOrderMiddlewarePosition' | 'unknownMiddleware';
24
+ type Options = [];
25
+
26
+ export default ESLintUtils.RuleCreator.withoutDocs({
27
+ create(context: RuleContext<MessageIds, Options>) {
28
+ function checkPreOrderMiddlewareOrder(
29
+ node: TSESTree.VariableDeclarator
30
+ ): void {
31
+ if (!isPreOrderMiddlewaresDeclaration(node)) {
32
+ return;
33
+ }
34
+
35
+ const arrayExpression = node.init as TSESTree.ArrayExpression;
36
+ const foundOrder = extractMiddlewareNames(arrayExpression);
37
+
38
+ validateMiddlewareOrder(foundOrder, node);
39
+ }
40
+
41
+ function isPreOrderMiddlewaresDeclaration(
42
+ node: TSESTree.VariableDeclarator
43
+ ): boolean {
44
+ return (
45
+ node.id.type === AST_NODE_TYPES.Identifier &&
46
+ node.id.name === 'preOrderMiddlewares' &&
47
+ node.init?.type === AST_NODE_TYPES.ArrayExpression
48
+ );
49
+ }
50
+
51
+ function extractMiddlewareNames(
52
+ arrayExpression: TSESTree.ArrayExpression
53
+ ): string[] {
54
+ return arrayExpression.elements
55
+ .map((element) => {
56
+ if (element?.type === AST_NODE_TYPES.Identifier) {
57
+ return element.name;
58
+ }
59
+ return null;
60
+ })
61
+ .filter((name): name is string => Boolean(name));
62
+ }
63
+
64
+ function validateMiddlewareOrder(
65
+ foundOrder: string[],
66
+ node: TSESTree.Node
67
+ ): void {
68
+ for (let i = 0; i < foundOrder.length; i++) {
69
+ const middleware = foundOrder[i];
70
+ const correctIndex =
71
+ CORRECT_PRE_ORDER_MIDDLEWARE_ORDER.indexOf(middleware);
72
+
73
+ if (correctIndex === -1) {
74
+ context.report({
75
+ node,
76
+ messageId: 'unknownMiddleware',
77
+ data: { middleware }
78
+ });
79
+ break;
80
+ }
81
+
82
+ if (i !== correctIndex) {
83
+ context.report({
84
+ node,
85
+ messageId: 'incorrectPreOrderMiddlewarePosition',
86
+ data: {
87
+ middleware,
88
+ currentPosition: i + 1,
89
+ expectedPosition: correctIndex + 1
90
+ }
91
+ });
92
+ break;
93
+ }
94
+ }
95
+ }
96
+
97
+ return {
98
+ VariableDeclarator: checkPreOrderMiddlewareOrder
99
+ };
100
+ },
101
+ meta: {
102
+ type: 'problem',
103
+ docs: {
104
+ description: 'Enforces the correct order of pre-order middlewares',
105
+ recommended: 'error'
106
+ },
107
+ schema: [],
108
+ messages: {
109
+ incorrectPreOrderMiddlewarePosition:
110
+ '{{middleware}} is at position {{currentPosition}}, but it should be at position {{expectedPosition}}.',
111
+ unknownMiddleware:
112
+ '{{middleware}} is not recognized as a valid pre-order middleware.'
113
+ }
114
+ },
115
+ defaultOptions: []
116
+ });
@@ -0,0 +1,61 @@
1
+ import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
2
+
3
+ export default ESLintUtils.RuleCreator.withoutDocs({
4
+ create(context) {
5
+ return {
6
+ CallExpression(node: TSESTree.CallExpression) {
7
+ const callee = node.callee as TSESTree.MemberExpression;
8
+
9
+ if (
10
+ callee.object &&
11
+ (callee.object as TSESTree.Identifier).name === 'Sentry' &&
12
+ callee.property &&
13
+ (callee.property as TSESTree.Identifier).name === 'init'
14
+ ) {
15
+ const optionsArgument = node
16
+ .arguments[0] as TSESTree.ObjectExpression;
17
+
18
+ if (optionsArgument && optionsArgument.type === 'ObjectExpression') {
19
+ optionsArgument.properties.forEach((property) => {
20
+ if (property.type === 'Property') {
21
+ const key = (property.key as TSESTree.Identifier).name;
22
+
23
+ if (key === 'dsn') {
24
+ const dsnValue = property.value;
25
+
26
+ if (dsnValue.type === 'Literal' && !dsnValue.value) {
27
+ context.report({
28
+ node: property,
29
+ messageId: 'invalidDsn'
30
+ });
31
+ }
32
+
33
+ if (dsnValue.type === 'MemberExpression') {
34
+ const objectName = (dsnValue.object as TSESTree.Identifier)
35
+ .name;
36
+ const propertyName = (
37
+ dsnValue.property as TSESTree.Identifier
38
+ ).name;
39
+
40
+ if (objectName === 'process' && propertyName === 'env') {
41
+ return;
42
+ }
43
+ }
44
+ }
45
+ }
46
+ });
47
+ }
48
+ }
49
+ }
50
+ };
51
+ },
52
+ meta: {
53
+ messages: {
54
+ invalidDsn: 'Sentry DSN should not be empty.'
55
+ },
56
+ type: 'problem',
57
+ fixable: 'code',
58
+ schema: []
59
+ },
60
+ defaultOptions: []
61
+ });
package/rules/index.ts CHANGED
@@ -8,6 +8,10 @@ import metaDataImport from './meta-data-import';
8
8
  import checkMiddlewareOrder from './check-middleware-order';
9
9
  import urlsWithoutSlash from './urls-without-slash';
10
10
  import invalidImports from './invalid-imports';
11
+ import caseWarning from './case-warning';
12
+ import checkSentryOptions from './check-sentry-options';
13
+ import checkMenuDepth from './check-menu-depth';
14
+ import checkPreOrderMiddlewareOrder from './check-pre-order-middleware-order';
11
15
 
12
16
  const rules = {
13
17
  'client-url': clientUrl,
@@ -19,7 +23,11 @@ const rules = {
19
23
  'meta-data-import': metaDataImport,
20
24
  'check-middleware-order': checkMiddlewareOrder,
21
25
  'urls-without-slash': urlsWithoutSlash,
22
- 'invalid-imports': invalidImports
26
+ 'invalid-imports': invalidImports,
27
+ 'case-warning': caseWarning,
28
+ 'check-sentry-options': checkSentryOptions,
29
+ 'check-menu-depth': checkMenuDepth,
30
+ 'check-pre-order-middleware-order': checkPreOrderMiddlewareOrder
23
31
  };
24
32
 
25
33
  export { rules };