Merge branch 'master' into prettier

* master: feat: support eslint flat config (#443) upgrade: Bump @typescript-eslint/parser from 6.7.5 to 6.21.0 (#465) upgrade: Bump typescript from 5.2.2 to 5.3.3 (#439) upgrade: Bump eslint-plugin-unicorn from 49.0.0 to 51.0.1 (#464) upgrade: Bump eslint-plugin-eslint-plugin from 5.1.1 to 5.3.0 (#463) upgrade: Bump globals from 13.23.0 to 14.0.0 (#462) upgrade: Bump eslint from 8.55.0 to 8.56.0 (#450) upgrade: Bump @eslint/js from 8.55.0 to 8.56.0 (#449) upgrade: Bump markdownlint-cli from 0.37.0 to 0.39.0 (#459) upgrade: Bump github/codeql-action from 2 to 3 (#447) upgrade: Bump eslint-doc-generator from 1.5.2 to 1.6.2 (#455) upgrade: Bump release-it from 16.2.1 to 16.3.0 (#437) ci: Use parallel coveralls config (#461)
platinumazure · Feb 10, 2024 · c3e7464 · c3e7464
2 parents 927faff + 87890a3
commit c3e7464
Show file tree

Hide file tree

Showing 8 changed files with 318 additions and 161 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,10 +30,11 @@ jobs:
     - run: npm run test:unit
 
     - name: Coveralls
-      uses: coverallsapp/github-action@master
+      uses: coverallsapp/github-action@v1
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
         path-to-lcov: ./build/coverage/lcov.info
+        parallel: true
 
   lint:
     runs-on: ubuntu-latest
@@ -44,3 +45,12 @@ jobs:
           node-version: "20.x"
       - run: npm ci
       - run: npm run lint
+
+  finish-coveralls:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Close parallel build
+        uses: coverallsapp/github-action@v1
+        with:
+          parallel-finished: true
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,6 +69,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"
diff --git a/README.md b/README.md
@@ -15,9 +15,9 @@ For more details on how to extend your configuration from a plugin configuration
 
 <!-- begin auto-generated configs list -->
 
-|    | Name          | Description                                                                                                                                                                                                                                                                                                                                        |
-| :- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ✅  | `recommended` | This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. You can use this configuration by extending from `"plugin:qunit/recommended"` in your configuration file. |
+|    | Name          | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| :- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ✅  | `recommended` | This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. For ESLint `.eslintrc.js` legacy config, extend from `"plugin:qunit/recommended"`. For ESLint `eslint.config.js` flat config, load from `require('eslint-plugin-qunit/configs/recommended')`. |
 
 <!-- end auto-generated configs list -->
 

diff --git a/index.js b/index.js
@@ -8,15 +8,24 @@
 "use strict";
 
 const requireIndex = require("requireindex");
+const pkg = require("./package.json");
 
 module.exports = {
+    meta: {
+        name: pkg.name,
+        version: pkg.version,
+    },
+
     rules: requireIndex(`${__dirname}/lib/rules`),
 
     // eslint-disable-next-line sort-keys
     configs: {
         recommended: {
-            description:
-                'This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. You can use this configuration by extending from `"plugin:qunit/recommended"` in your configuration file.',
+            description: [
+                "This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you.",
+                'For ESLint `.eslintrc.js` legacy config, extend from `"plugin:qunit/recommended"`.',
+                "For ESLint `eslint.config.js` flat config, load from `require('eslint-plugin-qunit/configs/recommended')`.",
+            ].join(" "),
             plugins: ["qunit"],
             rules: {
                 "qunit/assert-args": "error",

diff --git a/lib/configs/recommended.js b/lib/configs/recommended.js
@@ -0,0 +1,8 @@
+"use strict";
+
+const plugin = require("../../index.js");
+
+module.exports = {
+    plugins: { qunit: plugin },
+    rules: plugin.configs.recommended.rules,
+};