Skip to content

feat: add support for multiple test id attributes #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2020
Merged

feat: add support for multiple test id attributes #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions docs/rules/consistent-data-testid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ const baz = props => <div>...</div>;

## Options

| Option | Required | Default | Details | Example |
| ----------------- | -------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| `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` | `^{fileName}(\_\_([A-Z]+[a-z]_?)+)_\$` |
| `testIdAttribute` | No | `data-testid` | A string 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` |
| Option | Required | Default | Details | Example |
| ----------------- | -------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `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` | `^{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"]` |

## Example

Expand All @@ -41,3 +41,14 @@ const baz = props => <div>...</div>;
]
}
```

```json
{
"testing-library/consistent-data-testid": [
2,
{
"testIdAttribute": ["data-testid", "testId"]
}
]
}
```
32 changes: 27 additions & 5 deletions lib/rules/consistent-data-testid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export type MessageIds = 'invalidTestId';
type Options = [
{
testIdPattern: string;
testIdAttribute: string;
testIdAttribute?: string | string[];
}
];

Expand Down Expand Up @@ -37,8 +37,18 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
type: 'string',
},
testIdAttribute: {
type: 'string',
default: 'data-testid',
oneOf: [
{
type: 'string',
},
{
type: 'array',
items: {
type: 'string',
},
},
],
},
},
},
Expand Down Expand Up @@ -70,9 +80,21 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
return new RegExp(testIdPattern.replace(FILENAME_PLACEHOLDER, fileName));
}

function isTestIdAttribute(name: string) {
if (typeof attr === 'string') {
return attr === name;
} else {
return attr.includes(name);
}
}

return {
[`JSXIdentifier[name=${attr}]`]: (node: TSESTree.JSXIdentifier) => {
if (!isJSXAttribute(node.parent) || !isLiteral(node.parent.value)) {
[`JSXIdentifier`]: (node: TSESTree.JSXIdentifier) => {
if (
!isJSXAttribute(node.parent) ||
!isLiteral(node.parent.value) ||
!isTestIdAttribute(node.name)
) {
return;
}

Expand All @@ -85,7 +107,7 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
node,
messageId: 'invalidTestId',
data: {
attr,
attr: node.name,
value,
regex,
},
Expand Down
57 changes: 57 additions & 0 deletions tests/lib/rules/consistent-data-testid.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,25 @@ ruleTester.run(RULE_NAME, rule, {
code: `
import React from 'react';

const TestComponent = props => {
return (
<div another-custom-attr="right-1" custom-attr="right-2">
Hello
</div>
)
};
`,
options: [
{
testIdPattern: '^right(.*)$',
testIdAttribute: ['custom-attr', 'another-custom-attr'],
},
],
},
{
code: `
import React from 'react';

const TestComponent = props => {
return (
<div data-test-id="Parent">
Expand Down Expand Up @@ -256,6 +275,44 @@ ruleTester.run(RULE_NAME, rule, {
code: `
import React from 'react';

const TestComponent = props => {
return (
<div custom-attr="wrong" another-custom-attr="wrong">
Hello
</div>
)
};
`,
options: [
{
testIdPattern: '^right$',
testIdAttribute: ['custom-attr', 'another-custom-attr'],
},
],
filename: '/my/cool/__tests__/Parent/index.js',
errors: [
{
messageId: 'invalidTestId',
data: {
attr: 'custom-attr',
value: 'wrong',
regex: '/^right$/',
},
},
{
messageId: 'invalidTestId',
data: {
attr: 'another-custom-attr',
value: 'wrong',
regex: '/^right$/',
},
},
],
},
{
code: `
import React from 'react';

const TestComponent = props => {
return (
<div data-testid="WrongComponent__cool">
Expand Down