Merge remote-tracking branch 'origin/main' into alpha

# Conflicts:
#	README.md
#	lib/rules/no-debugging-utils.ts
#	tests/index.test.ts

Author: Belco90

.all-contributorsrc

@@ -574,8 +574,53 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "patriscus",
+      "name": "Patrick Ahmetovic",
+      "avatar_url": "https://avatars.githubusercontent.com/u/23729362?v=4",
+      "profile": "https://github.com/patriscus",
+      "contributions": [
+        "ideas",
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "CodingItWrong",
+      "name": "Josh Justice",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15832198?v=4",
+      "profile": "https://codingitwrong.com",
+      "contributions": [
+        "code",
+        "test",
+        "doc",
+        "ideas"
+      ]
+    },
+    {
+      "login": "obsoke",
+      "name": "Dale Karp",
+      "avatar_url": "https://avatars.githubusercontent.com/u/389851?v=4",
+      "profile": "https://dale.io",
+      "contributions": [
+        "code",
+        "test",
+        "doc"
+      ]
+    },
+    {
+      "login": "nathanmmiller",
+      "name": "Nathan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/37555055?v=4",
+      "profile": "https://github.com/nathanmmiller",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,
-  "skipCi": true
+  "skipCi": true,
+  "commitType": "docs"
 }

.github/workflows/pipeline.yml

@@ -3,25 +3,27 @@ name: Pipeline
 on:
   push:
     branches:
-      # semantic-release valid branches
+      # semantic-release valid branches and all-contributors branches
       - '+([0-9])?(.{+([0-9]),x}).x'
       - 'main'
       - 'next'
       - 'next-major'
       - 'beta'
       - 'alpha'
+      - 'all-contributors/**'
   pull_request:
     types: [opened, synchronize]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   code_validation:
     name: Code Validation
     runs-on: ubuntu-latest
 
     steps:
-      - name: Cancel Previous Runs
-        uses: styfle/[email protected]
-
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -58,9 +60,6 @@ jobs:
         eslint: [7.5, 7, 8]
 
     steps:
-      - name: Cancel Previous Runs
-        uses: styfle/[email protected]
-
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -90,9 +89,6 @@ jobs:
       github.ref) && github.event_name == 'push' }}
 
     steps:
-      - name: Cancel Previous Runs
-        uses: styfle/[email protected]
-
       - name: Checkout
         uses: actions/checkout@v3
 

.github/workflows/smoke-test.yml

@@ -28,7 +28,7 @@ jobs:
 
       - run: npm link eslint-plugin-testing-library
 
-      - uses: AriPerkkio/eslint-remote-tester-run-action@v3
+      - uses: AriPerkkio/eslint-remote-tester-run-action@v4
         with:
           issue-title: 'Results of weekly scheduled smoke test'
           eslint-remote-tester-config: tests/eslint-remote-tester.config.js

.gitignore

@@ -67,7 +67,6 @@ yarn-error.log
 # Yarn Integrity file
 .yarn-integrity
 
-# these cause more harm than good
-# when working with contributors
-package-lock.json
+# Ignore locks other than npm
+pnpm-lock.yaml
 yarn.lock

.npmrc

@@ -1,3 +1,2 @@
-package-lock=false
 auto-install-peers=true
 enable-pre-post-scripts=true

README.md

@@ -182,13 +182,13 @@ Relates to the [Aggressive Imports Reporting mechanism](#imports). This setting
 
 If you pass a string other than `"off"` to this option, it will represent your custom utility file from where you re-export everything from Testing Library package.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/utils-module": "my-custom-test-utility-file"
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/utils-module': 'my-custom-test-utility-file',
+	},
+};
 ```
 
 Configuring this setting like that, you'll restrict the errors reported by the plugin to only those utils being imported from this custom utility file, or some `@testing-library/*` package. The previous setting example would cause:
@@ -225,13 +225,13 @@ test('testing-library/utils-module setting example', () => {
 
 You can also set this setting to `"off"` to entirely opt-out Aggressive Imports Reporting mechanism, so only utils coming from Testing Library packages are reported.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/utils-module": "off"
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/utils-module': 'off',
+	},
+};
 ```
 
 ### `testing-library/custom-renders`
@@ -240,13 +240,13 @@ Relates to the [Aggressive Renders Reporting mechanism](#renders). This setting
 
 If you pass an array of strings to this option, it will represent a list of function names that are valid as Testing Library custom renders.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/custom-renders": ["display", "renderWithProviders"]
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/custom-renders': ['display', 'renderWithProviders'],
+	},
+};
 ```
 
 Configuring this setting like that, you'll restrict the errors reported by the plugin related to `render` somehow to only those functions sharing a name with one of the elements of that list, or built-in `render`. The previous setting example would cause:
@@ -288,13 +288,13 @@ test('testing-library/custom-renders setting example', () => {
 
 You can also set this setting to `"off"` to entirely opt-out Aggressive Renders Reporting mechanism, so only methods named `render` are reported as Testing Library render util.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/custom-renders": "off"
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/custom-renders': 'off',
+	},
+};
 ```
 
 ### `testing-library/custom-queries`
@@ -308,13 +308,13 @@ Each string passed to this list of custom queries can be:
 - **pattern query (recommended)**: a custom query variant (suffix starting with "By") to be reported, so all query combinations around it are reported. For instance: `"ByIcon"` would report all `getByIcon()`, `getAllByIcon()`, `queryByIcon()` and `findByIcon()`.
 - **strict query**: a specific custom query name to be reported, so only that very exact query would be reported but not any related variant. For instance: `"getByIcon"` would make the plugin to report `getByIcon()` but not `getAllByIcon()`, `queryByIcon()` or `findByIcon()`.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/custom-queries": ["ByIcon", "getByComplexText"]
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/custom-queries': ['ByIcon', 'getByComplexText'],
+	},
+};
 ```
 
 Configuring this setting like that, you'll restrict the errors reported by the plugin related to the queries to only those custom queries matching name or pattern from that list, or [built-in queries](https://testing-library.com/docs/queries/about). The previous setting example would cause:
@@ -344,11 +344,11 @@ findBySomethingElse('foo');
 
 You can also set this setting to `"off"` to entirely opt-out Aggressive Queries Reporting mechanism, so only built-in queries are reported.
 
-```json
-// .eslintrc
-{
-	"settings": {
-		"testing-library/custom-queries": "off"
-	}
-}
+```js
+// .eslintrc.js
+module.exports = {
+	settings: {
+		'testing-library/custom-queries': 'off',
+	},
+};
 ```

docs/migration-guides/v4.md

@@ -34,29 +34,41 @@ const baz = (props) => <div>...</div>;
 | ----------------- | -------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
 | `testIdPattern`   | Yes      | None          | A regex used to validate the format of the `data-testid` value. `{fileName}` can optionally be used as a placeholder and will be substituted with the name of the file OR the name of the files parent directory in the case when the file name is `index.js` OR empty string in the case of dynamically changing routes (that contain square brackets) with `Gatsby.js` or `Next.js` | `^{fileName}(\_\_([A-Z]+[a-z]_?)+)_\$`                |
 | `testIdAttribute` | No       | `data-testid` | A string (or array of strings) used to specify the attribute used for querying by ID. This is only required if data-testid has been explicitly overridden in the [RTL configuration](https://testing-library.com/docs/dom-testing-library/api-queries#overriding-data-testid)                                                                                                         | `data-my-test-attribute`, `["data-testid", "testId"]` |
+| `customMessage`   | No       | `undefined`   | A string used to display a custom message whenever warnings/errors are reported.                                                                                                                                                                                                                                                                                                      | `A custom message`                                    |
 
 ## Example
 
-```json
-{
-	"testing-library/consistent-data-testid": [
-		2,
-		{
-			"testIdPattern": "^TestId(__[A-Z]*)?$"
-		}
-	]
-}
+```js
+module.exports = {
+	rules: {
+		'testing-library/consistent-data-testid': [
+			'error',
+			{ testIdPattern: '^TestId(__[A-Z]*)?$' },
+		],
+	},
+};
 ```
 
-```json
-{
-	"testing-library/consistent-data-testid": [
-		2,
-		{
-			"testIdAttribute": ["data-testid", "testId"]
-		}
-	]
-}
+```js
+module.exports = {
+	rules: {
+		'testing-library/consistent-data-testid': [
+			'error',
+			{ testIdAttribute: ['data-testid', 'testId'] },
+		],
+	},
+};
+```
+
+```js
+module.exports = {
+	rules: {
+		'testing-library/consistent-data-testid': [
+			'error',
+			{ customMessage: 'A custom message' },
+		],
+	},
+};
 ```
 
 ## Notes

docs/rules/consistent-data-testid.md

@@ -95,15 +95,15 @@ This option gives you more granular control of which event modules you want to r
 
 Example:
 
-```json
-{
-	"testing-library/no-await-sync-events": [
-		"error",
-		{
-			"eventModules": ["fire-event", "user-event"]
-		}
-	]
-}
+```js
+module.exports = {
+	rules: {
+		'testing-library/no-await-sync-events': [
+			'error',
+			{ eventModules: ['fire-event', 'user-event'] },
+		],
+	},
+};
 ```
 
 ## Notes

docs/rules/no-await-sync-events.md

@@ -45,19 +45,21 @@ screen.debug();
 
 You can control which debugging utils are checked for with the `utilsToCheckFor` option:
 
-```json
-{
-	"testing-library/no-debugging-utils": [
-		"error",
-		{
-			"utilsToCheckFor": {
-				"debug": false,
-				"logRoles": true,
-				"logDOM": true
-			}
-		}
-	]
-}
+```js
+module.exports = {
+	rules: {
+		'testing-library/no-debugging-utils': [
+			'error',
+			{
+				utilsToCheckFor: {
+					debug: false,
+					logRoles: true,
+					logDOM: true,
+				},
+			},
+		],
+	},
+};
 ```
 
 ## Further Reading

docs/rules/no-debugging-utils.md

@@ -74,10 +74,12 @@ This rule has an option in case you want to tell the user which framework to use
 
 ### Example
 
-```json
-{
-	"testing-library/no-dom-import": ["error", "react"]
-}
+```js
+module.exports = {
+	rules: {
+		'testing-library/no-dom-import': ['error', 'react'],
+	},
+};
 ```
 
 With the configuration above, if the user imports from `@testing-library/dom` or `dom-testing-library` instead of the used framework, ESLint will tell the user to import from `@testing-library/react` or `react-testing-library`.