@commission-on-post/eslint-config-recommended 0.4.3 → 0.6.0

package/.eslintrc.js

@@ -9,7 +9,8 @@ module.exports = {
         "plugin:@typescript-eslint/recommended-requiring-type-checking"
     ],
     plugins: [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "import/no-duplicates" // This was imported to replace the rule `no-duplicate-imports`
     ],
     rules: {
         /*
@@ -104,10 +105,11 @@ module.exports = {
         "@typescript-eslint/no-dupe-class-members": [
             "error"
         ],
-        "@typescript-eslint/no-duplicate-imports": [
+        // Rule updated from `no-duplicate-imports` 
+        "import/no-duplicates": [
             "error",
             {
-                "includeExports": true
+                "prefer-inline": true
             }
         ],
         "@typescript-eslint/no-empty-function": [
@@ -249,7 +251,7 @@ module.exports = {
             {
                 "arraysInArrays": false,
                 "objectsInArrays": true,
-                "singleValue": true
+                "singleValue": false
             }
         ],
         "arrow-body-style": [
@@ -555,7 +557,7 @@ module.exports = {
                 "ExportDeclaration": "never",
                 "ImportDeclaration": "never",
                 "ObjectExpression": {
-                    "minProperties": 3
+                    "minProperties": 2 // Updated from 3
                 },
                 "ObjectPattern": {
                     "multiline": true
@@ -742,8 +744,8 @@ module.exports = {
             "fields"
         ],
         "@typescript-eslint/consistent-indexed-object-style": [
-            "error",
-            "index-signature"
+            "warn",
+            "record"
         ],
         "@typescript-eslint/consistent-type-assertions": [
             "error",
@@ -814,7 +816,7 @@ module.exports = {
         ], // If you are disabling this rule consider changing your data structure
         "@typescript-eslint/no-extraneous-class": [
             "off"
-        ], // I dont think we have developers using namespaces as classes, but if they wanted to I don't think the linter should stop them
+        ], // I don't think we have developers using namespaces as classes, but if they wanted to I don't think the linter should stop them
         "@typescript-eslint/no-invalid-void-type": [
             "warn",
             {
@@ -828,8 +830,12 @@ module.exports = {
         "@typescript-eslint/no-non-null-asserted-nullish-coalescing": [
             "warn"
         ], // Wrap your expression in parenthesis
-        "@typescript-eslint/no-parameter-properties": [
-            "off"
+        "@typescript-eslint/parameter-properties": [
+            "warn",
+            {
+                "allow":[ "private readonly" ],
+                "prefer": "parameter-property"
+            }
         ], // I like parameter properties
         "@typescript-eslint/no-require-imports": [
             "error"
@@ -880,11 +886,7 @@ module.exports = {
             "off"
         ], // values are locally scoped 
         "@typescript-eslint/prefer-nullish-coalescing": [
-            "warn",
-            {
-                "ignoreConditionalTests": false,
-                "ignoreMixedLogicalExpressions": false
-            }
+            "off" // This rule was getting very annoying so it has been turned off going forward
         ],
         "@typescript-eslint/prefer-optional-chain": [
             "warn"
@@ -932,12 +934,11 @@ module.exports = {
                 "ignoreStringArrays": true
             }
         ],
-        "@typescript-eslint/sort-type-union-intersection-members": [
-            "warn",
-            {
-                "checkIntersections": true,
-                "checkUnions": true
-            }
+        "@typescript-eslint/sort-type-constituents": [
+            // This rule has been turned off because the settings are not granular enough to allow for `let x: string | string[] = undefined`
+            // It does not allow you to allow for arrays after literals without changing every group order.
+            // Developers will have to sort their own keys if they care about order.
+            "off" 
         ],
         "@typescript-eslint/strict-boolean-expressions": [
             "off"
@@ -968,6 +969,18 @@ module.exports = {
         "@typescript-eslint/unified-signatures": [
             "warn"
         ],
+        // This rule was added later and
+        "@typescript-eslint/restrict-template-expressions": [
+            "warn",
+            {
+                "allowNumber": true,
+                "allowBoolean": true,
+                "allowAny": true,
+                "allowNullish": true,
+                "allowRegExp": true,
+                "allowNever": true
+            }
+        ],
         // ~~~~~ Rules set to "off" because the tslinter overrides their base behavior ~~~~~
         "comma-dangle": [
             "off"
@@ -1068,7 +1081,8 @@ module.exports = {
         "require-await": [
             "off"
         ],
-        "return-await": [
+        // This rule was renamed to have a `no-` in front of it
+        "no-return-await": [
             "off"
         ],
         "semi": [

package/README.md

@@ -3,12 +3,12 @@ The official [**Commission on Peace Officer Standards and Training**](https://gi
 
 ## Install
 ```bash
-$ npm install @typescript-eslint/parser
-$ npm install @commission-on-post/tslint-config-recommended
+$ npm install @typescript-eslint/parser -D
+$ npm install @commission-on-post/eslint-config-recommended -D
 ```
 ---
 
-## Recommended `.eslint.json`
+## Recommended `.eslintrc.json`
 ```json
 {
     "root": true,
@@ -45,7 +45,7 @@ Name | Description | [:large_blue_circle:](##Scripts "LOGO / LINK")
 **LintLens - ESLint rules made easier** | Augment your ESLint rules in Visual Studio Code by Adding metadata and usage information beside each ESLint rule. |[<img alt="LinLens Logo" width="120px" src="https://cdn.vsassets.io/v/M194_20211025.9/_content/Header/default_icon_128.png"/>](https://marketplace.visualstudio.com/items?itemName=ghmcadams.lintlens)
 
 #### VS Code setting.json (fix on save)
-- If you have format on save in vs code you may need to disable it, because mine started fighting.
+- If you have format on save in VS Code you may need to disable it, because mine started fighting.
 ```json
 // (file->preferences->settings [switch to json view])
 "eslint.validate": [

package/index.js

@@ -1,3 +1,3 @@
 const eslintrc = require('./.eslintrc.js');
 
-module.exports = eslintrc;
+module.exports = eslintrc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commission-on-post/eslint-config-recommended",
-  "version": "0.4.3",
+  "version": "0.6.0",
   "description": "ESLint config using recommended state practices for the Commission on POST",
   "main": "index.js",
   "author": "Ryan W. Bell",
@@ -10,6 +10,9 @@
     "url": "git+https://github.com/Commission-on-POST/eslint_recommended_style.git"
   },
   "homepage": "https://github.com/Commission-on-POST/eslint_recommended_style#readme",
+  "scripts":{
+    "start": "node ."
+  },
   "keywords": [
     "ESlint",
     "style",
@@ -21,12 +24,14 @@
     "@typescript-eslint/eslint-plugin": ">=5.3.0",
     "@typescript-eslint/parser": ">=5.3.0",
     "eslint": ">=8.1.0",
-    "typescript": ">=4.4.4"
+    "typescript": ">=4.4.4",
+    "eslint-plugin-import": "^2.27.5"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.3.0",
-    "@typescript-eslint/parser": "^5.3.0",
-    "eslint": "^8.1.0",
-    "typescript": "^4.4.4"
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.59.8",
+    "eslint": "^8.41.0",
+    "eslint-plugin-import": "^2.27.5",
+    "typescript": "^5.1.0"
   }
-}
+}