Merge remote-tracking branch 'origin/main' into isolated-functions

Author: mmkal

.eslint-doc-generatorrc.js

@@ -2,20 +2,24 @@
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */
 const config = {
-  ignoreConfig: ['all'],
-  ignoreDeprecatedRules: true,
-  ruleDocTitleFormat: 'desc',
-  ruleListColumns: [
-    'name',
-    'description',
-    'configsError',
-    // Omit `configsOff` since we don't intend to convey meaning by setting rules to `off` in the `recommended` config.
-    'configsWarn',
-    'fixable',
-    'hasSuggestions',
-    'requiresTypeChecking',
-  ],
-  urlConfigs: 'https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs',
+	ignoreConfig: [
+		'all',
+		'flat/all',
+		'flat/recommended',
+	],
+	ignoreDeprecatedRules: true,
+	ruleDocTitleFormat: 'desc',
+	ruleListColumns: [
+		'name',
+		'description',
+		'configsError',
+		// Omit `configsOff` since we don't intend to convey meaning by setting rules to `off` in the `recommended` config.
+		'configsWarn',
+		'fixable',
+		'hasSuggestions',
+		'requiresTypeChecking',
+	],
+	urlConfigs: 'https://github.com/sindresorhus/eslint-plugin-unicorn#recommended-config',
 };
 
-module.exports = config;
+export default config;

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,7 @@
 ---
 name: Bug report
 about: A rule isn't working as it should?
+labels: bug
 ---
 
 <!-- ✨ Thanks for reporting a bug! ➡️ Please don't ignore this template -->

.github/ISSUE_TEMPLATE/rule_change.yml

@@ -0,0 +1,49 @@
+name: Rule change
+description: A rule could be improved or extended?
+title: "`rule-name`: "
+labels:
+  - change request
+  - evaluating
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before opening a new issue:
+        - Look for existing [open or closed rule proposals](https://github.com/sindresorhus/eslint-plugin-unicorn/issues?q=is:issue+label%25enhancement)
+        - [Report a bug](https://github.com/sindresorhus/eslint-plugin-unicorn/issues/new?assignees=&labels=&projects=&template=bug_report.md) instead if it's a false positive
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: Explain the improvement you would like to see.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Examples
+      description: Provide examples of code to detect and the acceptable alternatives.
+      value: |
+        ```js
+        // ❌
+        var replace = 'me';
+
+        // ✅
+        const replace = 'me';
+        ```
+
+        ```js
+        // ❌
+        function foo() {
+        	var replace = 'me';
+        	return replace;
+        }
+
+        // ✅
+        function foo() {
+        	return 'me';
+        }
+        ```
+  - type: textarea
+    attributes:
+      label: Additional Info

.github/ISSUE_TEMPLATE/rule_proposal.yml

@@ -20,35 +20,35 @@ body:
     validations:
       required: true
     attributes:
-      label: Fail
-      description: Specify examples of code that should be detected
+      label: Examples
+      description: Provide examples of code to detect and the acceptable alternatives.
       value: |
         ```js
+        // ❌
         var replace = 'me';
+
+        // ✅
+        const replace = 'me';
         ```
 
         ```js
+        // ❌
         function foo() {
-          var replace = 'me';
-          return replace;
+        	var replace = 'me';
+        	return replace;
         }
-        ```
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: Pass
-      description: Specify examples of code that would be accepted in its place
-      value: |
-        ```js
-        const replace = 'me';
-        ```
 
-        ```js
+        // ✅
         function foo() {
-          return 'me';
+        	return 'me';
         }
         ```
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Proposed rule name
+      placeholder: no-invalid-rule-name
   - type: textarea
     attributes:
       label: Additional Info

.github/contributing.md

@@ -11,3 +11,7 @@ First open an issue with your proposal. When the rule is accepted, see the [docs
 ## I want to implement a rule from an open issue
 
 See the [docs on creating and submitting a new rule](../docs/new-rule.md).
+
+## How to write tests
+
+See the [docs on writing tests](../docs/write-tests.md).

.github/funding.yml

@@ -0,0 +1,4 @@
+github: [sindresorhus, fisker]
+open_collective: sindresorhus
+buy_me_a_coffee: sindresorhus
+custom: https://sindresorhus.com/donate

.github/workflows/main.yml

@@ -15,43 +15,54 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
+          - 24
           - 20
-          - 16
         os:
           - ubuntu-latest
           - windows-latest
+        # Even numbers of node-version
         include:
           - os: ubuntu-latest
-            node-version: 18
+            node-version: 22
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
       - run: npx ava
   lint-test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          # Locked due to the difference of `zlib.gzipSync()` between Node.js versions
+          node-version: 24
       - run: npm install
       - run: npm run lint
-      - run: rm -rf test/snapshots
+      - run: npx del-cli test/snapshots --verbose
       # Force update snapshots, https://github.com/avajs/ava/discussions/2754
       - run: npx c8 ava --update-snapshots
         env:
           AVA_FORCE_CI: not-ci
       - run: git diff --exit-code
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
           fail_ci_if_error: true
+          disable_search: true
           files: coverage/lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
   run-rules-on-codebase:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
       - run: npm install
       - run: npm run run-rules-on-codebase
   integration:
@@ -69,15 +80,11 @@ jobs:
           - "7"
           - "8"
           - "9"
-          - "10"
-          - "11"
-          - "12"
-          - "13"
     env:
       TIMING: 1
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
       - run: npm install
       - run: npm run integration -- --group ${{ matrix.group }}

.github/workflows/smoke-test.yml

@@ -9,13 +9,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-      - run: |
-          npm install
-          npm link
-          npm link eslint-plugin-unicorn
-      - uses: AriPerkkio/eslint-remote-tester-run-action@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: npm install
+      - uses: AriPerkkio/eslint-remote-tester-run-action@v5
         with:
           issue-title: "Results of weekly scheduled smoke test"
           eslint-remote-tester-config: test/smoke/eslint-remote-tester.config.js

.github/workflows/title-formatter.yml

@@ -0,0 +1,25 @@
+name: Title formatter
+
+on:
+  pull_request_target:
+    types: [opened, edited]
+  issues:
+    types: [opened, edited]
+
+jobs:
+  Rule:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      issues: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: docs/rules
+      - name: Auto-format rule names in titles
+        uses: fregante/keyword-formatter-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          keywords-path: docs/rules
+          prefix: unicorn/
+

.markdownlint.json

@@ -4,5 +4,6 @@
 	"no-hard-tabs": false,
 	"ul-style": {
 		"style": "dash"
-	}
+	},
+	"descriptive-link-text": false
 }