@akinon/eslint-plugin-projectzero 1.49.0 → 1.50.0-rc.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.50.0-rc.1
+
+## 1.50.0-rc.0
+
+### Minor Changes
+
+- 4d64ef7: ZERO-2611: Add check-sentry-options rule to eslint-plugin-projectzero
+- 5a4c6076: ZERO-2764: Add case-warning rule to eslint-plugin-projectzero
+- 64699d3: ZERO-2761: Fix invalid import for plugin module
+- c4747807: ZERO-2666: Add rule to check menu depth
+
 ## 1.49.0
 
 ## 1.48.0

package/configs/core.ts

@@ -9,6 +9,9 @@ export default {
     '@akinon/projectzero/meta-data-import': 'error',
     '@akinon/projectzero/urls-without-slash': 'error',
     '@akinon/projectzero/invalid-imports': 'error',
+    '@akinon/projectzero/check-menu-depth': 'error',
+    '@akinon/projectzero/case-warning': 'warn',
+    '@akinon/projectzero/check-sentry-options': 'error',
     'no-restricted-syntax': [
       'error',
       {

package/dist/configs/core.js

@@ -11,6 +11,9 @@ exports.default = {
         '@akinon/projectzero/meta-data-import': 'error',
         '@akinon/projectzero/urls-without-slash': 'error',
         '@akinon/projectzero/invalid-imports': 'error',
+        '@akinon/projectzero/check-menu-depth': 'error',
+        '@akinon/projectzero/case-warning': 'warn',
+        '@akinon/projectzero/check-sentry-options': 'error',
         'no-restricted-syntax': [
             'error',
             {

package/dist/rules/case-warning.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            CallExpression(node) {
+                if (node.callee.type === 'MemberExpression' &&
+                    node.callee.property.type === 'Identifier' &&
+                    (node.callee.property.name === 'toLocaleUpperCase' ||
+                        node.callee.property.name === 'toLocaleLowerCase')) {
+                    const args = node.arguments;
+                    if (args.length === 0) {
+                        context.report({
+                            node,
+                            messageId: 'noLocale'
+                        });
+                    }
+                }
+            }
+        };
+    },
+    meta: {
+        messages: {
+            noLocale: 'toLocaleUpperCase() or toLocaleLowerCase() should specify a locale for consistent behavior across different environments.'
+        },
+        type: 'problem',
+        fixable: 'code',
+        schema: []
+    },
+    defaultOptions: []
+});

package/dist/rules/check-menu-depth.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const types_1 = require("@typescript-eslint/types");
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create: function (context) {
+        return {
+            CallExpression(node) {
+                const { callee, arguments: args } = node;
+                if (callee.type !== types_1.AST_NODE_TYPES.Identifier ||
+                    callee.name !== 'getMenu' ||
+                    args.length === 0 ||
+                    args[0].type !== types_1.AST_NODE_TYPES.ObjectExpression) {
+                    return;
+                }
+                const depthProperty = args[0].properties.find((prop) => {
+                    var _a;
+                    return prop.type === types_1.AST_NODE_TYPES.Property &&
+                        prop.key.type === types_1.AST_NODE_TYPES.Identifier &&
+                        prop.key.name === 'depth' &&
+                        ((_a = prop.value) === null || _a === void 0 ? void 0 : _a.type) === types_1.AST_NODE_TYPES.Literal &&
+                        typeof prop.value.value === 'number' &&
+                        prop.value.value > 3;
+                });
+                if (depthProperty) {
+                    context.report({
+                        node: depthProperty,
+                        messageId: 'depthMessage'
+                    });
+                }
+            }
+        };
+    },
+    meta: {
+        type: 'problem',
+        fixable: 'code',
+        messages: {
+            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.'
+        },
+        schema: []
+    },
+    defaultOptions: []
+});

package/dist/rules/check-sentry-options.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            CallExpression(node) {
+                const callee = node.callee;
+                if (callee.object &&
+                    callee.object.name === 'Sentry' &&
+                    callee.property &&
+                    callee.property.name === 'init') {
+                    const optionsArgument = node
+                        .arguments[0];
+                    if (optionsArgument && optionsArgument.type === 'ObjectExpression') {
+                        optionsArgument.properties.forEach((property) => {
+                            if (property.type === 'Property') {
+                                const key = property.key.name;
+                                if (key === 'dsn') {
+                                    const dsnValue = property.value;
+                                    if (dsnValue.type === 'Literal' && !dsnValue.value) {
+                                        context.report({
+                                            node: property,
+                                            messageId: 'invalidDsn'
+                                        });
+                                    }
+                                    if (dsnValue.type === 'MemberExpression') {
+                                        const objectName = dsnValue.object
+                                            .name;
+                                        const propertyName = dsnValue.property.name;
+                                        if (objectName === 'process' && propertyName === 'env') {
+                                            return;
+                                        }
+                                    }
+                                }
+                                if (key === 'tracesSampleRate') {
+                                    const traceRate = property.value.value;
+                                    if (traceRate !== 1.0) {
+                                        context.report({
+                                            node: property,
+                                            messageId: 'incorrectTraceRate'
+                                        });
+                                    }
+                                }
+                            }
+                        });
+                    }
+                }
+            }
+        };
+    },
+    meta: {
+        messages: {
+            invalidDsn: 'Sentry DSN should not be empty.',
+            incorrectTraceRate: 'Sentry tracesSampleRate should be set to 1.0.'
+        },
+        type: 'problem',
+        fixable: 'code',
+        schema: []
+    },
+    defaultOptions: []
+});

package/dist/rules/index.js

@@ -14,6 +14,9 @@ const meta_data_import_1 = __importDefault(require("./meta-data-import"));
 const check_middleware_order_1 = __importDefault(require("./check-middleware-order"));
 const urls_without_slash_1 = __importDefault(require("./urls-without-slash"));
 const invalid_imports_1 = __importDefault(require("./invalid-imports"));
+const check_menu_depth_1 = __importDefault(require("./check-menu-depth"));
+const case_warning_1 = __importDefault(require("./case-warning"));
+const check_sentry_options_1 = __importDefault(require("./check-sentry-options"));
 const rules = {
     'client-url': client_url_1.default,
     'image-import': image_import_1.default,
@@ -24,6 +27,9 @@ const rules = {
     'meta-data-import': meta_data_import_1.default,
     'check-middleware-order': check_middleware_order_1.default,
     'urls-without-slash': urls_without_slash_1.default,
-    'invalid-imports': invalid_imports_1.default
+    'invalid-imports': invalid_imports_1.default,
+    'check-menu-depth': check_menu_depth_1.default,
+    'case-warning': case_warning_1.default,
+    'check-sentry-options': check_sentry_options_1.default
 };
 exports.rules = rules;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/eslint-plugin-projectzero",
-  "version": "1.49.0",
+  "version": "1.50.0-rc.1",
   "private": false,
   "description": "ESLint plugin for Project Zero Next",
   "main": "dist/index.js",

package/rules/case-warning.ts

@@ -0,0 +1,39 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { TSESTree } from '@typescript-eslint/types';
+
+type MessageIds = 'noLocale';
+type Options = readonly [];
+
+export default ESLintUtils.RuleCreator.withoutDocs<Options, MessageIds>({
+  create(context) {
+    return {
+      CallExpression(node: TSESTree.CallExpression) {
+        if (
+          node.callee.type === 'MemberExpression' &&
+          node.callee.property.type === 'Identifier' &&
+          (node.callee.property.name === 'toLocaleUpperCase' ||
+            node.callee.property.name === 'toLocaleLowerCase')
+        ) {
+          const args = node.arguments;
+
+          if (args.length === 0) {
+            context.report({
+              node,
+              messageId: 'noLocale'
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      noLocale:
+        'toLocaleUpperCase() or toLocaleLowerCase() should specify a locale for consistent behavior across different environments.'
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/check-menu-depth.ts

@@ -0,0 +1,48 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { AST_NODE_TYPES } from '@typescript-eslint/types';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create: function (context) {
+    return {
+      CallExpression(node) {
+        const { callee, arguments: args } = node;
+
+        if (
+          callee.type !== AST_NODE_TYPES.Identifier ||
+          callee.name !== 'getMenu' ||
+          args.length === 0 ||
+          args[0].type !== AST_NODE_TYPES.ObjectExpression
+        ) {
+          return;
+        }
+
+        const depthProperty = args[0].properties.find(
+          (prop) =>
+            prop.type === AST_NODE_TYPES.Property &&
+            prop.key.type === AST_NODE_TYPES.Identifier &&
+            prop.key.name === 'depth' &&
+            prop.value?.type === AST_NODE_TYPES.Literal &&
+            typeof prop.value.value === 'number' &&
+            prop.value.value > 3
+        );
+
+        if (depthProperty) {
+          context.report({
+            node: depthProperty,
+            messageId: 'depthMessage'
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    type: 'problem',
+    fixable: 'code',
+    messages: {
+      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.'
+    },
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/check-sentry-options.ts

@@ -0,0 +1,72 @@
+import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    return {
+      CallExpression(node: TSESTree.CallExpression) {
+        const callee = node.callee as TSESTree.MemberExpression;
+
+        if (
+          callee.object &&
+          (callee.object as TSESTree.Identifier).name === 'Sentry' &&
+          callee.property &&
+          (callee.property as TSESTree.Identifier).name === 'init'
+        ) {
+          const optionsArgument = node
+            .arguments[0] as TSESTree.ObjectExpression;
+
+          if (optionsArgument && optionsArgument.type === 'ObjectExpression') {
+            optionsArgument.properties.forEach((property) => {
+              if (property.type === 'Property') {
+                const key = (property.key as TSESTree.Identifier).name;
+
+                if (key === 'dsn') {
+                  const dsnValue = property.value;
+
+                  if (dsnValue.type === 'Literal' && !dsnValue.value) {
+                    context.report({
+                      node: property,
+                      messageId: 'invalidDsn'
+                    });
+                  }
+
+                  if (dsnValue.type === 'MemberExpression') {
+                    const objectName = (dsnValue.object as TSESTree.Identifier)
+                      .name;
+                    const propertyName = (
+                      dsnValue.property as TSESTree.Identifier
+                    ).name;
+
+                    if (objectName === 'process' && propertyName === 'env') {
+                      return;
+                    }
+                  }
+                }
+
+                if (key === 'tracesSampleRate') {
+                  const traceRate = (property.value as TSESTree.Literal).value;
+                  if (traceRate !== 1.0) {
+                    context.report({
+                      node: property,
+                      messageId: 'incorrectTraceRate'
+                    });
+                  }
+                }
+              }
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      invalidDsn: 'Sentry DSN should not be empty.',
+      incorrectTraceRate: 'Sentry tracesSampleRate should be set to 1.0.'
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/index.ts

@@ -8,6 +8,9 @@ import metaDataImport from './meta-data-import';
 import checkMiddlewareOrder from './check-middleware-order';
 import urlsWithoutSlash from './urls-without-slash';
 import invalidImports from './invalid-imports';
+import checkMenuDepth from './check-menu-depth';
+import caseWarning from './case-warning';
+import checkSentryOptions from './check-sentry-options';
 
 const rules = {
   'client-url': clientUrl,
@@ -19,7 +22,10 @@ const rules = {
   'meta-data-import': metaDataImport,
   'check-middleware-order': checkMiddlewareOrder,
   'urls-without-slash': urlsWithoutSlash,
-  'invalid-imports': invalidImports
+  'invalid-imports': invalidImports,
+  'check-menu-depth': checkMenuDepth,
+  'case-warning': caseWarning,
+  'check-sentry-options': checkSentryOptions
 };
 
 export { rules };