@spscommerce/eslint-config-typescript 0.0.2 → 0.0.3

package/lib/rules/variables.js

@@ -1,59 +1,84 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.variables = void 0;
+// ✅ = recommended, 🔧 = fixable
 exports.variables = {
-    /** enforce or disallow variable initializations at definition
-    * https://eslint.org/docs/rules/init-declarations
-    * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/init-declarations.md */
-    'init-declarations': 'off',
-    '@typescript-eslint/init-declarations': 'off',
-    /** disallow the catch clause parameter name being the same as a variable in the outer scope
-    * https://eslint.org/docs/rules/no-catch-shadow */
-    'no-catch-shadow': 'off',
-    /** disallow deletion of variables
-    * https://eslint.org/docs/rules/no-delete-var */
-    'no-delete-var': 'error',
-    /** disallow labels that share a name with a variable
-    * https://eslint.org/docs/rules/no-label-var */
-    'no-label-var': 'error',
-    /** disallow specific globals
-    * https://eslint.org/docs/rules/no-restricted-globals */
-    'no-restricted-globals': [
-        'error',
+    /**
+     * enforce or disallow variable initializations at definition
+     * https://eslint.org/docs/rules/init-declarations
+     * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/init-declarations.md
+     */
+    "init-declarations": "off",
+    "@typescript-eslint/init-declarations": "off",
+    /**
+     * disallow the catch clause parameter name being the same as a variable in the outer scope
+     * https://eslint.org/docs/rules/no-catch-shadow
+     */
+    "no-catch-shadow": "off",
+    /**
+     * disallow deletion of variables ✅
+     * https://eslint.org/docs/rules/no-delete-var
+     */
+    "no-delete-var": "error",
+    /**
+     * disallow labels that share a name with a variable
+     * https://eslint.org/docs/rules/no-label-var
+     */
+    "no-label-var": "error",
+    /**
+     * disallow specific globals
+     * https://eslint.org/docs/rules/no-restricted-globals
+     */
+    "no-restricted-globals": [
+        "error",
         {
-            name: 'isFinite',
-            message: 'Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite',
+            name: "isFinite",
+            message: "Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite",
         },
         {
-            name: 'isNaN',
-            message: 'Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan',
+            name: "isNaN",
+            message: "Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan",
         },
     ],
-    /** disallow declaration of variables already declared in the outer scope
-    * https://eslint.org/docs/rules/no-shadow
-    * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md */
-    'no-shadow': 'off',
-    '@typescript-eslint/no-shadow': 'error',
-    /** disallow shadowing of names such as arguments
-    * https://eslint.org/docs/rules/no-shadow-restricted-names */
-    'no-shadow-restricted-names': 'error',
-    /** disallow use of undeclared variables unless mentioned in `/*global ` comments
-    * https://eslint.org/docs/rules/no-undef */
-    'no-undef': 'error',
-    /** disallow use of undefined when initializing variables
-    * https://eslint.org/docs/rules/no-undef-init */
-    'no-undef-init': 'error',
-    /** disallow use of undefined variable
-    * https://eslint.org/docs/rules/no-undefined */
-    'no-undefined': 'off',
-    /** disallow declaration of variables that are not used in the code
-    * https://eslint.org/docs/rules/no-unused-vars
-    * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md */
-    'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': ['error', { ignoreRestSiblings: true }],
-    /** disallow use of variables before they are defined
-    * https://eslint.org/docs/rules/no-use-before-define
-    * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md */
-    'no-use-before-define': 'off',
-    '@typescript-eslint/no-use-before-define': 'error',
+    /**
+     * disallow declaration of variables already declared in the outer scope
+     * https://eslint.org/docs/rules/no-shadow
+     * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md
+     */
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error",
+    /**
+     * disallow shadowing of names such as arguments ✅
+     * https://eslint.org/docs/rules/no-shadow-restricted-names
+     */
+    "no-shadow-restricted-names": "error",
+    /**
+     * disallow use of undeclared variables unless mentioned in `/*global ` comments ✅
+     * https://eslint.org/docs/rules/no-undef
+     */
+    "no-undef": "error",
+    /**
+     * disallow use of undefined when initializing variables 🔧
+     * https://eslint.org/docs/rules/no-undef-init
+     */
+    "no-undef-init": "error",
+    /**
+     * disallow use of undefined variable
+     * https://eslint.org/docs/rules/no-undefined
+     */
+    "no-undefined": "off",
+    /**
+     * disallow declaration of variables that are not used in the code ✅
+     * https://eslint.org/docs/rules/no-unused-vars
+     * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unused-vars.md
+     */
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { ignoreRestSiblings: true }],
+    /**
+     * disallow use of variables before they are defined
+     * https://eslint.org/docs/rules/no-use-before-define
+     * https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md
+     */
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": "error",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spscommerce/eslint-config-typescript",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "SPS official linter configuration for TypeScript.",
   "main": "lib/index.js",
   "scripts": {
@@ -31,16 +31,20 @@
   },
   "homepage": "https://github.com/SPSCommerce/javascript",
   "peerDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-import-resolver-typescript": "^2.5.0"
-  },
-  "dependencies": {
     "@typescript-eslint/eslint-plugin": "^4.31.2",
     "@typescript-eslint/parser": "^4.31.2",
+    "eslint": "^7.32.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.24.2"
   },
+  "dependencies": {
+  },
   "devDependencies": {
     "@types/eslint": "^7.28.0",
-    "eslint-import-resolver-typescript": "^2.5.0"
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.31.2",
+    "eslint": "^7.32.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.24.2"
   }
 }