Merge pull request #480 from eslint-functional/next

Author: RebeccaStevens

.cspell.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1",
+  "version": "0.2",
   "language": "en",
   "ignorePaths": [
     "**/coverage/**",
@@ -21,24 +21,19 @@
     "misc",
     "filetypes"
   ],
+  "import": ["./node_modules/@cspell/dict-cryptocurrencies/cspell-ext.json"],
   "ignoreRegExpList": [
     "/```[\\w\\W]*?```/",
     "/~~~[\\w\\W]*?~~~/",
     "/``[\\w\\W]*?``/",
     "/`[^`]*`/",
     "/\\.\\/docs\\/rules\\/[^.]*.md/",
     "/TS[^\\s]+/",
-    "\\(#.+?\\)"
-  ],
-  "words": [
-    "globstar",
-    "IIFE",
-    "IIFEs",
-    "ruleset",
-    "rulesets",
-    "typeguard",
-    "typeguards"
+    "\\(#.+?\\)",
+    "// @ts-.*",
+    "/[A-Za-z0-9]{32,}/"
   ],
+  "words": ["litecoin", "globstar", "IIFE", "IIFEs", "ruleset", "rulesets"],
   "overrides": [
     {
       "filename": "**/*.{ts,js}",

.eslint-doc-generatorrc.js

@@ -0,0 +1,12 @@
+const { format } = require("prettier");
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  configEmoji: [["lite", "☑️"]],
+  ignoreConfig: ["all", "off"],
+  ruleDocSectionInclude: ["Rule Details"],
+  ruleListSplit: "meta.docs.category",
+  postprocess: (doc) => format(doc, { parser: "markdown" }),
+};
+
+module.exports = config;

.eslintrc.json

@@ -29,29 +29,17 @@
     ],
     "sourceType": "module"
   },
-  "ignorePatterns": ["/build/", "/coverage/", "/lib/", "/**/*.cjs", "/**/*.js"],
+  "ignorePatterns": [
+    "/build/",
+    "/coverage/",
+    "/lib/",
+    "/**/*.cjs",
+    "/**/*.js",
+    "/src/utils/tsutils.ts"
+  ],
   "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-unnecessary-condition": "off",
-    "@typescript-eslint/no-unsafe-argument": "off",
-    "@typescript-eslint/no-unsafe-assignment": "off",
-    "@typescript-eslint/no-unsafe-call": "off",
-    "@typescript-eslint/no-unsafe-member-access": "off",
-    "@typescript-eslint/no-unsafe-return": "off",
-    "@typescript-eslint/prefer-readonly-parameter-types": "warn",
-    "import/no-relative-parent-imports": "error",
-    "functional/prefer-readonly-type": "off",
-    "node/no-unsupported-features/es-builtins": "off",
-    "node/no-unsupported-features/es-syntax": "off",
-    "promise/prefer-await-to-callbacks": "off",
-    // only available for node >= 16.8
-    "unicorn/prefer-at": "off",
-    // enable once supported in all our supported node versions.
-    "unicorn/prefer-node-protocol": "off",
-    // only available for node >= 15.4
-    "unicorn/prefer-string-replace-all": "off",
-    // only available for node >= 14.8
-    "unicorn/prefer-top-level-await": "off"
+    "functional/prefer-immutable-types": "off",
+    "import/no-relative-parent-imports": "error"
   },
   "overrides": [
     // Top level files.
@@ -64,7 +52,7 @@
       "files": ["./src/**/*"],
       "extends": ["plugin:eslint-plugin/recommended"],
       "rules": {
-        "functional/no-expression-statement": "error"
+        "functional/no-expression-statements": "error"
       }
     },
     {
@@ -75,17 +63,37 @@
       }
     },
     {
-      "files": ["./src/util/typeguard.ts", "./tests/**/*", "./cz-adapter/**/*"],
+      "files": ["./src/utils/type-guards.ts", "./src/utils/node-types.ts"],
       "rules": {
         "jsdoc/require-jsdoc": "off"
       }
     },
+    {
+      "files": ["./tests/**/*", "./cz-adapter/**/*"],
+      "rules": {
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "jsdoc/require-jsdoc": "off"
+      }
+    },
+    {
+      "files": ["./typings/**/*"],
+      "extends": ["plugin:functional/off"],
+      "rules": {
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+    },
     // FIXME: This override is defined in the upsteam; it shouldn't need to be redefined here. Why?
     {
       "files": ["./**/*.md/**"],
       "parserOptions": {
         "project": null
       },
+      "extends": ["plugin:markdown/recommended", "plugin:functional/off"],
       "rules": {
         "@typescript-eslint/await-thenable": "off",
         "@typescript-eslint/consistent-type-definitions": "off",
@@ -94,12 +102,15 @@
         "@typescript-eslint/naming-convention": "off",
         "@typescript-eslint/no-confusing-void-expression": "off",
         "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-floating-promises": "off",
         "@typescript-eslint/no-for-in-array": "off",
         "@typescript-eslint/no-implied-eval": "off",
         "@typescript-eslint/no-misused-promises": "off",
         "@typescript-eslint/no-throw-literal": "off",
+        "@typescript-eslint/no-unnecessary-condition": "off",
         "@typescript-eslint/no-unnecessary-type-assertion": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
         "@typescript-eslint/no-unsafe-assignment": "off",
         "@typescript-eslint/no-unsafe-call": "off",
         "@typescript-eslint/no-unsafe-member-access": "off",
@@ -120,17 +131,6 @@
         "@typescript-eslint/strict-boolean-expressions": "off",
         "@typescript-eslint/switch-exhaustiveness-check": "off",
         "@typescript-eslint/unbound-method": "off",
-        "functional/functional-parameters": "off",
-        "functional/immutable-data": "off",
-        "functional/no-class": "off",
-        "functional/no-expression-statement": "off",
-        "functional/no-let": "off",
-        "functional/no-loop-statement": "off",
-        "functional/no-return-void": "off",
-        "functional/no-this-expression": "off",
-        "functional/no-throw-statement": "off",
-        "functional/no-try-statement": "off",
-        "functional/prefer-readonly-type": "off",
         "import/no-unresolved": "off",
         "init-declarations": "off",
         "jsdoc/require-jsdoc": "off",
@@ -146,6 +146,7 @@
         "sonarjs/no-unused-collection": "off",
         "unicorn/prefer-optional-catch-binding": "off",
         "unicorn/prefer-top-level-await": "off",
+        "unicorn/switch-case-braces": "off",
 
         "dot-notation": "error",
         "no-implied-eval": "error",

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+issuehunt: eslint-functional/eslint-plugin-functional
+ko_fi: rebeccastevens
+custom: https://github.com/eslint-functional/eslint-plugin-functional/blob/main/DONATIONS.md

.github/ISSUE_TEMPLATE/bug-report.md

@@ -6,22 +6,22 @@ labels: 'Type: Bug, Status: Triage'
 assignees: ''
 ---
 
-# Bug Report
+## Bug Report
 
 <!-- Why the issue was filed? -->
 
-## Expected behavior
+### Expected behavior
 
 <!-- What you expected to happen? -->
 
-## Actual behavior
+### Actual behavior
 
 <!-- What actually happened? -->
 
-## Steps to reproduce
+### Steps to reproduce
 
 <!-- How can someone else make/see it happen -->
 
-## Proposed changes
+### Proposed changes
 
 <!-- If you have a proposed change, workaround or fix, describe it here -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -6,4 +6,4 @@ labels: 'Type: Idea, Status: Triage'
 assignees: ''
 ---
 
-# Suggestion
+## Suggestion

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,5 @@
 Fixes: #(Issue Number)
 
-# Proposed Changes
+## Proposed Changes
 
 <!-- Describe the changes and rationale behind them. -->

.github/renovate.json

@@ -1,6 +1,10 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["config:base", "helpers:disableTypesNodeMajor"],
+  "extends": [
+    "config:base",
+    "helpers:disableTypesNodeMajor",
+    "schedule:monthly"
+  ],
   "postUpdateOptions": ["yarnDedupeHighest"],
   "labels": ["Type: Maintenance", ":blue_heart:"],
   "automerge": true,
@@ -24,7 +28,7 @@
     {
       "matchManagers": ["npm"],
       "matchDepTypes": ["devDependencies"],
-      "rangeStrategy": "update-lockfile",
+      "rangeStrategy": "pin",
       "semanticCommitType": "chore",
       "semanticCommitScope": "dev-deps"
     },

.github/workflows/ci.yml

@@ -41,9 +41,6 @@ jobs:
       - name: Run Linting Checks
         run: yarn lint
 
-      - name: Check spelling
-        run: yarn check-spelling
-
   test:
     name: "Test - Node: ${{ matrix.node_version }} - TS: ${{ matrix.ts_version }} - OS: ${{ matrix.os }}"
     needs: pre_job
@@ -54,7 +51,6 @@ jobs:
         os:
           - "ubuntu-latest"
         node_version:
-          - "14"
           - "16"
           - "18"
         ts_version:
@@ -107,6 +103,8 @@ jobs:
             const filename = "./tsconfig.base.json";
             const tsConfig = require(filename);
             delete tsConfig.compilerOptions.exactOptionalPropertyTypes;
+            delete tsConfig.compilerOptions.noPropertyAccessFromIndexSignature;
+            delete tsConfig.compilerOptions.noUncheckedIndexedAccess;
             const tsConfigString = JSON.stringify(tsConfig, undefined, 2);
             fs.writeFileSync(filename, tsConfigString, { encoding: "utf8" });
             console.log("TS Config updated successfully.");

.github/workflows/release.yml

@@ -24,9 +24,24 @@ jobs:
       - name: Install dependencies
         run: yarn install --immutable --ignore-scripts
 
-      - name: Build & Verify
+      - name: Build
+        run: yarn build
+
+      - name: Verify
         run: yarn verify
 
+      - name: Install semantic release
+      - run: >
+          npm install --no-save
+            @google/semantic-release-replace-plugin
+            @semantic-release/changelog
+            @semantic-release/commit-analyzer
+            @semantic-release/git
+            @semantic-release/github
+            @semantic-release/npm
+            @semantic-release/release-notes-generator
+            semantic-release
+
       - name: Release
         run: npx semantic-release
         env: