new prefer-readonly-type rule

.eslintrc.json

@@ -6,7 +6,6 @@
     "eslint-plugin",
     "functional",
     "import",
-    "jest",
     "jsdoc",
     "prettier"
   ],
@@ -15,173 +14,38 @@
     "node": true
   },
   "extends": [
-    "eslint:recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
+    "@rebeccastevens/eslint-config/modern",
+    "@rebeccastevens/eslint-config/typescript",
+    "@rebeccastevens/eslint-config/common-overrides",
     "plugin:eslint-plugin/recommended",
-    "plugin:functional/recommended",
     "plugin:prettier/recommended",
     "prettier"
   ],
   "parserOptions": {
     "ecmaVersion": 10,
-    "project": [
-      "./tsconfig.json",
-      "./tests/tsconfig.json"
-    ],
+    "project": ["./tsconfig.json", "./tests/tsconfig.json"],
     "sourceType": "module"
   },
-  "ignorePatterns": [
-    "build/",
-    "lib/"
-  ],
+  "ignorePatterns": ["build/", "coverage/", "lib/"],
   "rules": {
-    // Built in.
-    "no-param-reassign": "error",
-    "no-var": "error",
-    // Our rules.
-    "functional/prefer-readonly-type": [
-      "error",
-      {
-        "allowMutableReturnType": true
-      }
-    ],
-    "functional/no-conditional-statement": [
-      "error",
-      {
-        "allowReturningBranches": true
-      }
-    ],
-    "functional/functional-parameters": [
-      "error",
-      {
-        "ignorePattern": [
-          "^tsInstalled$"
-        ]
-      }
-    ]
+    "@typescript-eslint/no-unnecessary-condition": "off",
+    "import/no-relative-parent-imports": "error",
+    "node/no-unsupported-features/es-builtins": "off",
+    "node/no-unsupported-features/es-syntax": "off",
+    // enable once supported in all our supported node versions.
+    "unicorn/prefer-node-protocol": "off"
   },
   "overrides": [
     // Top level files.
     {
-      "files": [
-        "*"
-      ],
+      "files": ["*"],
       "rules": {
         "functional/immutable-data": "off",
-        "functional/functional-parameters": "off",
-        "functional/no-expression-statement": "off"
-      }
-    },
-    // TypeScript files.
-    {
-      "files": [
-        "**/*.ts"
-      ],
-      "extends": [
-        "plugin:@typescript-eslint/recommended"
-      ],
-      "rules": {
-        "@typescript-eslint/array-type": [
-          "error",
-          {
-            "default": "generic"
-          }
-        ],
-        "@typescript-eslint/ban-types": [
-          "error",
-          {
-            "types": {
-              "Object": {
-                "message": "Use object instead",
-                "fixWith": "object"
-              },
-              "{}": false,
-              "object": false
-            },
-            "extendDefaults": true
-          }
-        ],
-        "@typescript-eslint/prefer-interface": "off",
-        "@typescript-eslint/no-non-null-assertion": "off",
-        "@typescript-eslint/no-require-imports": "error",
-        "@typescript-eslint/no-var-requires": "off",
-        "@typescript-eslint/no-unused-vars": "off",
-        "@typescript-eslint/no-unused-vars-experimental": [
-          "warn",
-          {
-            "ignoredNamesRegex": "^_",
-            "ignoreArgsIfArgsAfterAreUsed": true
-          }
-        ],
-        "@typescript-eslint/no-use-before-define": [
-          "error",
-          {
-            "functions": false,
-            "classes": true,
-            "variables": true,
-            "typedefs": true
-          }
-        ]
-      }
-    },
-    // Source files.
-    {
-      "files": [
-        "src/**/*"
-      ],
-      "rules": {
-        // JSDoc.
-        "jsdoc/check-alignment": "warn",
-        "jsdoc/check-indentation": "warn",
-        "jsdoc/check-param-names": "warn",
-        "jsdoc/check-tag-names": "warn",
-        "jsdoc/implements-on-classes": "warn",
-        "jsdoc/newline-after-description": "warn",
-        "jsdoc/no-types": "warn",
-        "jsdoc/require-description": "warn",
-        "jsdoc/require-description-complete-sentence": "warn",
-        "jsdoc/require-hyphen-before-param-description": "warn",
-        "jsdoc/require-jsdoc": "warn",
-        "jsdoc/require-param-description": "warn",
-        "jsdoc/require-param-name": "warn",
-        "jsdoc/require-returns-check": "warn",
-        "jsdoc/require-returns-description": "warn"
-      }
-    },
-    // Testing Files.
-    {
-      "files": [
-        "tests/**/*"
-      ],
-      "env": {
-        "jest/globals": true
-      },
-      "extends": [
-        "plugin:jest/recommended"
-      ],
-      "rules": {
         "functional/functional-parameters": "off",
         "functional/no-conditional-statement": "off",
         "functional/no-expression-statement": "off",
-        "jest/no-alias-methods": "error",
-        "jest/no-test-return-statement": "error",
-        "jest/prefer-called-with": "warn",
-        "jest/prefer-expect-assertions": "error",
-        "jest/prefer-spy-on": "warn",
-        "jest/prefer-strict-equal": "warn",
-        "jest/prefer-to-be-null": "warn",
-        "jest/prefer-to-be-undefined": "warn",
-        "jest/prefer-to-contain": "warn",
-        "jest/prefer-to-have-length": "warn",
-        "jest/prefer-todo": "error"
+        "functional/no-throw-statement": "off"
       }
     }
-  ],
-  "settings": {
-    "import/ignore": [
-      "escape-string-regexp"
-    ]
-  }
+  ]
 }

.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Setup NodeJs
         uses: actions/setup-node@v1
         with:
-          node-version: "14"
+          node-version: "16"
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
@@ -48,10 +48,9 @@ jobs:
         os:
           - "ubuntu-latest"
         node_version:
-          - "10"
           - "12"
           - "14"
-          - "15"
+          - "16"
         ts_version:
           - "next"
           - "latest"
@@ -60,19 +59,18 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.ts_version == 'next' }}
     env:
-      # Use compiled tests on everything instances except this one.
-      USE_COMPILED_TEST: ${{ fromJSON('["false", "true"]')[matrix.ts_version != 'latest' || matrix.node_version != '14' || matrix.os != 'ubuntu-latest'] }}
+      REPORT_COVERAGE: ${{ fromJSON('["false", "true"]')[matrix.ts_version == 'latest' && matrix.node_version == '16' && matrix.os != 'ubuntu-latest'] }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
         with:
           # Fetch all commits for codecov.
-          fetch-depth: ${{ fromJSON('[0, 1]')[ env.USE_COMPILED_TEST == 'true'] }}
+          fetch-depth: ${{ fromJSON('[0, 1]')[ env.REPORT_COVERAGE == 'true'] }}
 
-      - name: Setup NodeJs
+      - name: Setup NodeJs for building
         uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: "16"
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
@@ -81,26 +79,28 @@ jobs:
         run: yarn build
 
       - name: Compile Tests
-        if: env.USE_COMPILED_TEST == 'true'
+        if: env.REPORT_COVERAGE == 'false'
         run: yarn compile-tests
 
+      - name: Setup NodeJs ${{ matrix.node_version }} for testing
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node_version }}
+
       - name: Remove Dev TypeScript
-        run: yarn remove typescript
+        run: yarn remove typescript --ignore-engines
 
       - name: Add TypeScript "${{ matrix.ts_version }}"
         if: matrix.ts_version != 'JS'
-        run: yarn add -D typescript@"${{ matrix.ts_version }}"
+        run: yarn add -D typescript@"${{ matrix.ts_version }}" --ignore-engines
 
-      - name: Run Tests (Uncompiled)
-        if: env.USE_COMPILED_TEST != 'true'
+      - name: Run Tests
         run: yarn test
-
-      - name: Run Tests (Compiled)
-        if: env.USE_COMPILED_TEST == 'true'
-        run: yarn test-compiled
+        env:
+          USE_COMPILED_TESTS: ${{ env.REPORT_COVERAGE == 'false' }}
 
       - name: Report coverage
         uses: codecov/codecov-action@v1
-        if: env.USE_COMPILED_TEST != 'true'
+        if: env.REPORT_COVERAGE == 'true'
         with:
           file: coverage/lcov.info

.gitignore

@@ -1,7 +1,7 @@
 .DS_Store
 thumbs.db
 *.log
-.rpt2_cache/
+.nyc_output/
 node_modules/
 /build/
 /lib/

.nycrc

@@ -0,0 +1,20 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "src/util/conditional-imports/**/*"
+  ],
+  "reporter": [
+    "lcov",
+    "text"
+  ],
+  "check-coverage": false,
+  "watermarks": {
+    "lines": [80, 95],
+    "functions": [80, 95],
+    "branches": [80, 95],
+    "statements": [80, 95]
+  }
+}

.vscode/launch.json

@@ -7,13 +7,18 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Jest Test Current Test File",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "name": "AVA Test Current Test File",
+      "program": "${workspaceFolder}/node_modules/.bin/ava",
       "args": [
-        "--runInBand",
-        "--no-coverage",
         "${relativeFile}"
       ],
+      "outputCapture": "std",
+      "skipFiles": [
+        "<node_internals>/**/*.js"
+      ],
+      "env": {
+        "TEST_ALL_FILE": "1"
+      },
       "sourceMaps": true,
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",

.vscode/settings.json

@@ -1,12 +1,12 @@
 {
   "files.exclude": {
-    ".rpt2_cache": true,
+    ".nyc_output": true,
     "coverage": true,
   },
   "files.trimTrailingWhitespace": true,
   "search.exclude": {
     "**/.git/": true,
-    "**/.rpt2_cache/": true,
+    "**/.nyc_output/": true,
     "**/yarn.lock": true,
     ".vscode/": true,
     "build/": true,