Enable TypeScript Rules (without requiring type checking rules)

.github/workflows/build.yml

@@ -1,15 +1,39 @@
 on:
-  pull_request_target:
+  pull_request:
   push:
     branches:
     - '*'
+    tags:
+    - 'v*'
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@v2
+
+    # Install dependencies
     - uses: actions/setup-node@v1
       with:
         node-version: '12'
+        registry-url: 'https://registry.npmjs.org'
     - run: npm ci
+
+    # Build
+    - run: npm pack
+    - uses: actions/upload-artifact@v2
+      with:
+        name: npm package
+        path: ./ni-eslint-config-*.tgz
+        if-no-files-found: error
+
+    # Test
+    - run: npm run test-typescript
+    - run: npm run test-typescript-typed
+    - run: npm run dev-print-typescript-props
+
+    # Publish
+    - if: startsWith(github.ref, 'refs/tags/v')
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .DS_Store
 *.tgz
+.vscode

index.js

@@ -1,5 +1,11 @@
 module.exports = {
-    extends: 'airbnb-base',
+    extends: [
+        /*
+            airbnb-base source:
+            https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/index.js
+        */
+        'airbnb-base'
+    ],
     rules: {
         /*
             Omit arrow function parenthesis where they are not required to improve readability.
@@ -57,11 +63,17 @@ module.exports = {
         */
         'linebreak-style': 'off',
 
+        /*
+            Requires empty lines between multiline class members but avoids the empty line
+            for single line members to reduce the amount of vertical space used in a class.
+        */
+        'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }],
+
         /*
             Including one class per file is a best practice in general and also recommended by the
             Angular style guide. However, migrating older projects may not be trivial, and there
             may be exceptions for public/internal types that are only used as part of the interface
-            to the main type and no other types
+            to the main type and no other types.
         */
         'max-classes-per-file': ['error', 1],
 
@@ -132,6 +144,9 @@ module.exports = {
             'error', {
                 selector: 'LabeledStatement',
                 message: 'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
+            }, {
+                selector: "UnaryExpression[operator='delete']",
+                message: 'The `delete` operator is not allowed. If using an object keys as a map, use the ES `Map` data structure instead.'
             }, {
                 selector: 'WithStatement',
                 message: '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',

lib/typescript-extensions-requiring-type-checking.js

@@ -0,0 +1,23 @@
+module.exports = {
+    rules: {
+        // Defined by Airbnb
+        // 'dot-notation': 'off',
+        // '@typescript-eslint/dot-notation': ['error', { allowKeywords: true }],
+
+        // Defined by Airbnb
+        // 'no-implied-eval': 'off',
+        // '@typescript-eslint/no-implied-eval': 'error',
+
+        // Defined by Airbnb
+        // 'no-throw-literal': 'off',
+        // '@typescript-eslint/no-throw-literal': 'error',
+
+        // Defined by Airbnb
+        // 'require-await': 'off',
+        // '@typescript-eslint/require-await': 'off',
+
+        // Defined by Airbnb
+        // 'no-return-await': 'off',
+        // '@typescript-eslint/return-await': 'error',
+    }
+};

lib/typescript-extensions.js

@@ -0,0 +1,170 @@
+module.exports = {
+    rules: {
+        /*
+            The following are extension rules that replace core JavaScript rules to support
+            TypeScript.
+            * When upgrading, changes to these rules can be identified in the typescript-eslint
+              changelog under features and breaking changes:
+              https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#extension-rules
+            * In addition, the `npm run dev-print-typescript-props` command can be used to list
+              the expected extension properties.
+            * The value of the extension properties should match the value chosen by the
+              JavaScript / Airbnb configuration.
+        */
+
+        // Defined by Airbnb
+        'brace-style': 'off',
+        '@typescript-eslint/brace-style': ['error', '1tbs', { allowSingleLine: true }],
+
+        // Defined by NI
+        'comma-dangle': 'off',
+        '@typescript-eslint/comma-dangle': ['error', 'only-multiline'],
+
+        // Defined by Airbnb
+        'comma-spacing': 'off',
+        '@typescript-eslint/comma-spacing': ['error', { before: false, after: true }],
+
+        // Defined by Airbnb
+        'default-param-last': 'off',
+        '@typescript-eslint/default-param-last': 'off',
+
+        // Defined by Airbnb
+        'func-call-spacing': 'off',
+        '@typescript-eslint/func-call-spacing': ['error', 'never'],
+
+        // Defined by NI
+        indent: 'off',
+        '@typescript-eslint/indent': ['error', 4],
+
+        // Defined by Airbnb
+        'init-declarations': 'off',
+        '@typescript-eslint/init-declarations': 'off',
+
+        // Defined by Airbnb
+        'keyword-spacing': 'off',
+        '@typescript-eslint/keyword-spacing': ['error', {
+            before: true,
+            after: true,
+            overrides: {
+                return: { after: true },
+                throw: { after: true },
+                case: { after: true }
+            }
+        }],
+
+        // Defined by NI
+        'lines-between-class-members': 'off',
+        '@typescript-eslint/lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }],
+
+        // Defined by Airbnb
+        'no-array-constructor': 'off',
+        '@typescript-eslint/no-array-constructor': 'error',
+
+        // Defined by Airbnb
+        'no-dupe-class-members': 'off',
+        '@typescript-eslint/no-dupe-class-members': 'error',
+
+        // Defined by Airbnb
+        'no-duplicate-imports': 'off',
+        '@typescript-eslint/no-duplicate-imports': 'off',
+
+        // Defined by Airbnb
+        'no-empty-function': 'off',
+        '@typescript-eslint/no-empty-function': ['error', {
+            allow: [
+                'arrowFunctions',
+                'functions',
+                'methods'
+            ]
+        }],
+
+        // Defined by Airbnb
+        'no-extra-parens': 'off',
+        '@typescript-eslint/no-extra-parens': ['off', 'all', {
+            conditionalAssign: true,
+            nestedBinaryExpressions: false,
+            returnAssign: false,
+            ignoreJSX: 'all',
+            enforceForArrowConditionals: false,
+        }],
+
+        // Defined by Airbnb
+        'no-extra-semi': 'off',
+        '@typescript-eslint/no-extra-semi': 'error',
+
+        // Defined by Airbnb
+        'no-invalid-this': 'off',
+        '@typescript-eslint/no-invalid-this': 'off',
+
+        // Defined by NI
+        'no-loop-func': 'off',
+        '@typescript-eslint/no-loop-func': 'error',
+
+        // Defined by Airbnb
+        'no-loss-of-precision': 'off',
+        '@typescript-eslint/no-loss-of-precision': 'off',
+
+        // Defined by Airbnb
+        'no-magic-numbers': 'off',
+        '@typescript-eslint/no-magic-numbers': ['off', {
+            ignore: [],
+            ignoreArrayIndexes: true,
+            enforceConst: true,
+            detectObjects: false,
+        }],
+
+        // Defined by Airbnb
+        'no-redeclare': 'off',
+        '@typescript-eslint/no-redeclare': 'error',
+
+        // Defined by Airbnb
+        'no-shadow': 'off',
+        '@typescript-eslint/no-shadow': 'error',
+
+        // Defined by Airbnb
+        'no-unused-expressions': 'off',
+        '@typescript-eslint/no-unused-expressions': ['error', {
+            allowShortCircuit: false,
+            allowTernary: false,
+            allowTaggedTemplates: false,
+        }],
+
+        // Defined by Airbnb
+        'no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+
+        // Defined by NI
+        'no-use-before-define': 'off',
+        '@typescript-eslint/no-use-before-define': ['error', { functions: false, classes: true, variables: true }],
+
+        // Defined by Airbnb
+        'no-useless-constructor': 'off',
+        '@typescript-eslint/no-useless-constructor': 'error',
+
+        // Available in newer typescript-eslint version, enable on upgrade.
+        // See: https://github.com/ni/javascript-styleguide/pull/18#discussion_r569795937
+        // Defined by Airbnb
+        'object-curly-spacing': 'off',
+        // '@typescript-eslint/object-curly-spacing': ['error', 'always'],
+
+        // Defined by Airbnb
+        quotes: 'off',
+        '@typescript-eslint/quotes': ['error', 'single', { avoidEscape: true }],
+
+        // Defined by Airbnb
+        semi: 'off',
+        '@typescript-eslint/semi': ['error', 'always'],
+
+        // Defined by NI
+        'space-before-function-paren': 'off',
+        '@typescript-eslint/space-before-function-paren': ['error', {
+            anonymous: 'always',
+            named: 'never',
+            asyncArrow: 'always'
+        }],
+
+        // Defined by Airbnb
+        'space-infix-ops': 'off',
+        '@typescript-eslint/space-infix-ops': 'error',
+    }
+};

package.json

@@ -5,7 +5,10 @@
   "main": "index.js",
   "scripts": {
     "prepare": "npm test",
-    "test": "eslint ."
+    "test": "eslint .",
+    "test-typescript": "eslint ./test/typescript/",
+    "test-typescript-typed": "eslint ./test/typescript-type-checking/",
+    "dev-print-typescript-props": "node ./tools/print-typescript-properties"
   },
   "repository": {
     "type": "git",
@@ -26,16 +29,18 @@
     "access": "public"
   },
   "files": [
-    ".eslintrc.js",
-    "typescript.js"
+    "/*.js",
+    "/lib/*"
   ],
   "dependencies": {
     "@typescript-eslint/parser": "^4.9.1",
     "eslint-config-airbnb-base": "~14.2.0"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.9.1",
     "eslint": "^7.6.0",
-    "eslint-plugin-import": "^2.22.0"
+    "eslint-plugin-import": "^2.22.0",
+    "typescript": "^4.1.3"
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^4.9.1",