@akinon/eslint-plugin-projectzero 1.47.0-rc.2 → 1.47.0-rc.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.47.0-rc.3
+
+### Minor Changes
+
+- 4d64ef7: ZERO-2611: Add check-sentry-options rule to eslint-plugin-projectzero
+
 ## 1.47.0-rc.2
 
 ## 1.47.0-rc.1

package/configs/core.ts

@@ -11,6 +11,7 @@ export default {
     '@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

@@ -1,24 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
 exports.default = {
-    rules: {
-        '@akinon/projectzero/image-import': 'error',
-        '@akinon/projectzero/client-url': 'error',
-        '@akinon/projectzero/link-import': 'error',
-        '@akinon/projectzero/router-import': 'error',
-        '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
-        '@akinon/projectzero/check-locale': 'error',
-        '@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',
-        'no-restricted-syntax': [
-            'error',
-            {
-                selector: "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
-                message: "You should use it as 'Settings.commerceUrl'"
-            }
-        ]
-    }
+  rules: {
+    '@akinon/projectzero/image-import': 'error',
+    '@akinon/projectzero/client-url': 'error',
+    '@akinon/projectzero/link-import': 'error',
+    '@akinon/projectzero/router-import': 'error',
+    '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
+    '@akinon/projectzero/check-locale': 'error',
+    '@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',
+      {
+        selector:
+          "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
+        message: "You should use it as 'Settings.commerceUrl'"
+      }
+    ]
+  }
 };

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

@@ -1,33 +1,43 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
 exports.rules = void 0;
-const client_url_1 = __importDefault(require("./client-url"));
-const image_import_1 = __importDefault(require("./image-import"));
-const link_import_1 = __importDefault(require("./link-import"));
-const router_import_1 = __importDefault(require("./router-import"));
-const skip_trailing_slash_redirect_1 = __importDefault(require("./skip-trailing-slash-redirect"));
-const check_locale_1 = __importDefault(require("./check-locale"));
-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 client_url_1 = __importDefault(require('./client-url'));
+const image_import_1 = __importDefault(require('./image-import'));
+const link_import_1 = __importDefault(require('./link-import'));
+const router_import_1 = __importDefault(require('./router-import'));
+const skip_trailing_slash_redirect_1 = __importDefault(
+  require('./skip-trailing-slash-redirect')
+);
+const check_locale_1 = __importDefault(require('./check-locale'));
+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,
-    'link-import': link_import_1.default,
-    'router-import': router_import_1.default,
-    'skip-trailing-slash-redirect': skip_trailing_slash_redirect_1.default,
-    'check-locale': check_locale_1.default,
-    '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,
-    'check-menu-depth': check_menu_depth_1.default,
-    'case-warning': case_warning_1.default
+  'client-url': client_url_1.default,
+  'image-import': image_import_1.default,
+  'link-import': link_import_1.default,
+  'router-import': router_import_1.default,
+  'skip-trailing-slash-redirect': skip_trailing_slash_redirect_1.default,
+  'check-locale': check_locale_1.default,
+  '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,
+  '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.47.0-rc.2",
+  "version": "1.47.0-rc.3",
   "private": false,
   "description": "ESLint plugin for Project Zero Next",
   "main": "dist/index.js",

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

@@ -10,6 +10,7 @@ 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,
@@ -23,7 +24,8 @@ const rules = {
   'urls-without-slash': urlsWithoutSlash,
   'invalid-imports': invalidImports,
   'check-menu-depth': checkMenuDepth,
-  'case-warning': caseWarning
+  'case-warning': caseWarning,
+  'check-sentry-options': checkSentryOptions
 };
 
 export { rules };