New rule: prefer-readonly-type-declaration

.cspell.json

@@ -28,12 +28,14 @@
     "/`[^`]*`/",
     "/\\.\\/docs\\/rules\\/[^.]*.md/",
     "/TS[^\\s]+/",
-    "\\(#.+?\\)"
+    "\\(#.+?\\)",
+    "/\\/\\/ @ts-.*/"
   ],
   "words": [
     "globstar",
     "IIFE",
     "IIFEs",
+    "readonlyness",
     "ruleset",
     "rulesets",
     "typeguard",

.eslintrc.json

@@ -29,7 +29,13 @@
     ],
     "sourceType": "module"
   },
-  "ignorePatterns": ["/build/", "/coverage/", "/lib/", "/**/*.cjs", "/**/*.js"],
+  "ignorePatterns": [
+    "/build/",
+    "/coverage/",
+    "/lib/",
+    "/**/*.cjs",
+    "/**/*.js"
+  ],
   "rules": {
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-unnecessary-condition": "off",
@@ -41,6 +47,7 @@
     "@typescript-eslint/prefer-readonly-parameter-types": "warn",
     "import/no-relative-parent-imports": "error",
     "functional/prefer-readonly-type": "off",
+    "functional/prefer-readonly-type-declaration": "warn",
     "node/no-unsupported-features/es-builtins": "off",
     "node/no-unsupported-features/es-syntax": "off",
     "promise/prefer-await-to-callbacks": "off",
@@ -54,26 +61,74 @@
   "overrides": [
     // Top level files.
     {
-      "files": ["./*"],
-      "extends": ["plugin:functional/off"]
+      "files": [
+        "./*"
+      ],
+      "extends": [
+        "plugin:functional/off"
+      ]
     },
     // Source files.
     {
-      "files": ["./src/**/*"],
-      "extends": ["plugin:eslint-plugin/recommended"],
+      "files": [
+        "./src/**/*"
+      ],
+      "extends": [
+        "plugin:eslint-plugin/recommended"
+      ],
       "rules": {
         "functional/no-expression-statement": "error"
       }
     },
+    // Rule util file.
+    {
+      "files": [
+        "./src/util/rule.ts"
+      ],
+      "rules": {
+        "@typescript-eslint/prefer-readonly-parameter-types": "warn"
+      }
+    },
+    // Typeguard files.
+    {
+      "files": [
+        "./src/util/typeguard.ts"
+      ],
+      "rules": {
+        "jsdoc/require-jsdoc": "off"
+      }
+    },
+    // Test files.
     {
-      "files": ["./src/util/typeguard.ts", "./tests/**/*", "./cz-adapter/**/*"],
+      "files": [
+        "./tests/**/*"
+      ],
       "rules": {
         "jsdoc/require-jsdoc": "off"
       }
     },
+    // CZ Adapter files.
+    {
+      "files": [
+        "./src/util/typeguard.ts",
+        "./tests/**/*",
+        "./cz-adapter/**/*"
+      ],
+      "rules": {
+        "jsdoc/require-jsdoc": "off"
+      }
+    },
+    {
+      "files": ["**/*.md/**"],
+      "rules": {
+        "functional/prefer-readonly-type-declaration": "off"
+      }
+    },
     // FIXME: This override is defined in the upsteam; it shouldn't need to be redefined here. Why?
     {
-      "files": ["./**/*.md/**"],
+      "files": [
+        "./**/*.md/**"
+      ],
       "parserOptions": {
         "project": null
       },
@@ -136,7 +191,6 @@
         "sonarjs/no-unused-collection": "off",
         "unicorn/prefer-optional-catch-binding": "off",
         "unicorn/prefer-top-level-await": "off",
-
         "dot-notation": "error",
         "no-implied-eval": "error",
         "require-await": "error"

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Skip Duplicate Actions
         id: skip_check
-        uses: fkirc/skip-duplicate-actions@v3.4.1
+        uses: fkirc/skip-duplicate-actions@v4.0.0
         with:
           concurrent_skipping: "same_content"
           paths_ignore: '[".vscode/", "**/docs/**", "**/*.md"]'
@@ -25,15 +25,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup NodeJs
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: "lts/*"
 
+      - run: npm install -g yarn
+      - run: corepack enable
+
       - name: Install Dependencies
-        run: yarn install --frozen-lockfile --ignore-scripts --ignore-engines
+        run: yarn install --immutable
+
+      - name: Build
+        run: yarn build
 
       - name: Run Linting Checks
         run: yarn lint
@@ -51,32 +57,35 @@ jobs:
         os:
           - "ubuntu-latest"
         node_version:
-          - "12"
           - "14"
           - "16"
+          - "18"
         ts_version:
           - "next"
           - "latest"
-          - "3.4.1"
+          - "4.4.2"
           - "JS"
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.ts_version == 'next' }}
     env:
       REPORT_COVERAGE: ${{ fromJSON('["false", "true"]')[matrix.ts_version == 'latest' && matrix.node_version == '16' && matrix.os != 'ubuntu-latest'] }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # Fetch all commits for codecov.
           fetch-depth: ${{ fromJSON('[0, 1]')[ env.REPORT_COVERAGE == 'true'] }}
 
       - name: Setup NodeJs for building
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: "16"
 
+      - run: npm install -g yarn
+      - run: corepack enable
+
       - name: Install Dependencies
-        run: yarn install --frozen-lockfile --ignore-scripts --ignore-engines
+        run: yarn install --immutable
 
       - name: Build
         run: yarn build
@@ -86,28 +95,27 @@ jobs:
         run: yarn compile-tests
 
       - name: Setup NodeJs ${{ matrix.node_version }} for testing
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node_version }}
 
+      - run: npm install -g yarn
+      - run: corepack enable
+
       - name: Remove Dev TypeScript
-        run: yarn remove typescript --ignore-engines
+        run: yarn remove typescript
 
       - name: Add TypeScript "${{ matrix.ts_version }}"
         if: matrix.ts_version != 'JS'
-        run: yarn add -D typescript@"${{ matrix.ts_version }}" --ignore-engines
-
-      - name: Remove incompatible settings for ts 3.4.1
-        if: matrix.ts_version == '3.4.1'
-        run: node -e 'const fs = require("fs"); const tsconfig = require("./tsconfig.base.json"); delete tsconfig.compilerOptions.exactOptionalPropertyTypes; fs.writeFileSync("./tsconfig.base.json", JSON.stringify(tsconfig));'
+        run: yarn add -D typescript@"${{ matrix.ts_version }}"
 
       - name: Run Tests
         run: yarn test
         env:
           USE_COMPILED_TESTS: ${{ env.REPORT_COVERAGE == 'false' }}
 
       - name: Report coverage
-        uses: codecov/codecov-action@v2.1.0
+        uses: codecov/codecov-action@v3.1.0
         if: env.REPORT_COVERAGE == 'true'
         with:
           file: coverage/lcov.info

.github/workflows/dependabot-automerge.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: "Merge"
         if: steps.waitforstatuschecks.outputs.status == 'success'
-        uses: pascalgn/automerge-action@v0.14.3
+        uses: pascalgn/automerge-action@v0.15.3
         env:
           MERGE_LABELS: ":blue_heart:,!Status: On Hold"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dependabot.yml

@@ -0,0 +1,49 @@
+name: "Dependabot"
+
+on:
+  pull_request_target:
+
+jobs:
+  fix-lockfile:
+    runs-on: ubuntu-latest
+    if: |
+      github.actor == 'dependabot[bot]' &&
+      contains(github.event.pull_request.head.ref, 'dependabot/npm_and_yarn/')
+    env:
+      YARN_ENABLE_SCRIPTS: false
+      YARN_ENABLE_IMMUTABLE_INSTALLS: false
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 2
+
+      - run: git lfs pull --include .yarn/
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+
+      - name: Restore cache
+        uses: actions/cache@v3
+        with:
+          path: .yarn/cache
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: ${{ runner.os }}-yarn-
+
+      - run: git checkout HEAD~1 yarn.lock
+
+      - run: yarn install --mode=skip-build
+
+      - run: yarn dedupe
+
+      - name: Commit yarn.lock
+        run: |
+          git config user.name "dependabot-fix"
+          git config user.email "dependabot-fix@example.com"
+          git add yarn.lock
+          git commit -m '[dependabot skip] Fix yarn.lock'
+          git push

.github/workflows/labels.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: micnncim/action-label-syncer@v1
         env:

.github/workflows/pr.yml

@@ -12,6 +12,6 @@ jobs:
     name: Validate PR title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v4.1.0
+      - uses: amannn/action-semantic-pull-request@v4.5.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -11,18 +11,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: Setup NodeJs
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: "lts/*"
 
+      - run: npm install -g yarn
+      - run: corepack enable
+
       - name: Install dependencies
-        run: yarn install --frozen-lockfile --ignore-scripts
+        run: yarn install --immutable
 
       - name: Build & Verify
         run: yarn verify

.github/workflows/stale.yml

@@ -8,7 +8,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           days-before-issue-stale: 60
           days-before-issue-close: 7

.gitignore

@@ -3,6 +3,13 @@
 /coverage/
 
 .nyc_output/
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 node_modules/
 
 *.log