Skip to content

Commit 0d11ebd

Browse files
author
Thomas Lombart
committed
docs: change rule name
1 parent 333e1c8 commit 0d11ebd

File tree

5 files changed

+16
-20
lines changed

5 files changed

+16
-20
lines changed

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -134,16 +134,16 @@ To enable this configuration use the `extends` property in your
134134

135135
## Supported Rules
136136

137-
| Rule | Description | Configurations | Fixable |
138-
| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------ |
139-
| [await-async-query](docs/rules/await-async-query.md) | Enforce async queries to have proper `await` | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
140-
| [await-fire-event](docs/rules/await-fire-event.md) | Enforce async fire event methods to be awaited | ![vue-badge][] | |
141-
| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
142-
| [no-debug](docs/rules/no-debug.md) | Disallow the use of `debug` | ![angular-badge][] ![react-badge][] ![vue-badge][] | |
143-
| [no-dom-import](docs/rules/no-dom-import.md) | Disallow importing from DOM Testing Library | ![angular-badge][] ![react-badge][] ![vue-badge][] | ![fixable-badge][] |
144-
| [prefer-explicit-assert](docs/rules/prefer-explicit-assert.md) | Suggest using explicit assertions rather than just `getBy*` queries | | |
145-
| [consistent-data-testid](docs/rules/consistent-data-testid.md) | Ensure `data-testid` values match a provided regex. | | |
146-
| [no-get-by-for-absent-elements](docs/rules/no-get-by-for-absent-elements) | Disallow the use of `expect(getBy*)` when elements may be asbent | | |
137+
| Rule | Description | Configurations | Fixable |
138+
| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------ |
139+
| [await-async-query](docs/rules/await-async-query.md) | Enforce async queries to have proper `await` | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
140+
| [await-fire-event](docs/rules/await-fire-event.md) | Enforce async fire event methods to be awaited | ![vue-badge][] | |
141+
| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
142+
| [no-debug](docs/rules/no-debug.md) | Disallow the use of `debug` | ![angular-badge][] ![react-badge][] ![vue-badge][] | |
143+
| [no-dom-import](docs/rules/no-dom-import.md) | Disallow importing from DOM Testing Library | ![angular-badge][] ![react-badge][] ![vue-badge][] | ![fixable-badge][] |
144+
| [prefer-explicit-assert](docs/rules/prefer-explicit-assert.md) | Suggest using explicit assertions rather than just `getBy*` queries | | |
145+
| [consistent-data-testid](docs/rules/consistent-data-testid.md) | Ensure `data-testid` values match a provided regex. | | |
146+
| [no-get-by-for-asserting-element-not-present](docs/rules/no-get-by-for-asserting-element-not-present) | Disallow the use of `expect(getBy*)` when elements are not present | | |
147147

148148
[build-badge]: https://img.shields.io/travis/testing-library/eslint-plugin-testing-library?style=flat-square
149149
[build-url]: https://travis-ci.org/testing-library/eslint-plugin-testing-library

‎docs/rules/no-get-by-for-absent-elements.md‎ renamed to ‎docs/rules/no-get-by-for-asserting-element-not-present.md‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Disallow the use of `expect(getBy*)` when elements may be asbent (no-get-by-for-absent-elements)
1+
# Disallow the use of `expect(getBy*)` when elements are not present (no-get-by-for-asserting-element-not-present)
22

33
The (DOM) Testing Library allows to query DOM elements using different types of queries such as `getBy*` and `queryBy*`. Using `getBy*` throws an error in case the element is not found. This is useful when:
44

@@ -51,12 +51,8 @@ test('some test', () => {
5151
```js
5252
test('some test', async () => {
5353
const utils = render(<App />);
54-
await waitForElementToBeRemoved(() => {
55-
expect(utils.queryByText('Foo')).toBeInTheDocument();
56-
});
57-
await waitForElementToBeRemoved(() => {
58-
expect(utils.queryAllByText('Foo')).toBeInTheDocument();
59-
});
54+
await waitForElementToBeRemoved(() => utils.queryByText('Foo'));
55+
await waitForElementToBeRemoved(() => utils.queryAllByText('Foo'));
6056
});
6157
```
6258

‎lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const rules = {
77
'no-await-sync-query': require('./rules/no-await-sync-query'),
88
'no-debug': require('./rules/no-debug'),
99
'no-dom-import': require('./rules/no-dom-import'),
10-
'no-get-by-for-absent-elements': require('./rules/no-get-by-for-absent-elements'),
10+
'no-get-by-for-asserting-element-not-present': require('./rules/no-get-by-for-asserting-element-not-present'),
1111
'prefer-explicit-assert': require('./rules/prefer-explicit-assert'),
1212
};
1313

‎lib/rules/no-get-by-for-absent-elements.js‎ renamed to ‎lib/rules/no-get-by-for-asserting-element-not-present.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module.exports = {
1111
description:
1212
'Disallow the use of getBy* queries in expect calls when elements may be absent',
1313
recommended: 'error',
14-
url: getDocsUrl('no-get-by-for-absent-elements'),
14+
url: getDocsUrl('no-get-by-for-asserting-element-not-present'),
1515
},
1616
messages: {
1717
expectQueryBy:

‎tests/lib/rules/no-get-by-for-absent-elements.js‎ renamed to ‎tests/lib/rules/no-get-by-for-asserting-element-not-present.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
'use strict';
22

33
const RuleTester = require('eslint').RuleTester;
4-
const rule = require('../../../lib/rules/no-get-by-for-absent-elements');
4+
const rule = require('../../../lib/rules/no-get-by-for-asserting-element-not-present');
55
const { ALL_QUERIES_METHODS } = require('../../../lib/utils');
66

77
const ruleTester = new RuleTester({

0 commit comments

Comments
 (0)