8000 Docs: Incorrect part of the description regarding node:test setup in RuleTester · Issue #9822 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

Docs: Incorrect part of the description regarding node:test setup in RuleTester #9822 8000

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

Jump to bottom
Closed
2 tasks done
erm1116 opened this issue Aug 19, 2024 · 0 comments · Fixed by #9825
Closed
2 tasks done

Docs: Incorrect part of the description regarding node:test setup in RuleTester #9822

erm1116 opened this issue Aug 19, 2024 · 0 comments · Fixed by #9825
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

Comments

@erm1116
Copy link
Contributor
erm1116 commented Aug 19, 2024

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

In the document, setup.js is written like below

// setup.js
import * as test from 'node:test';
import { RuleTester } from '@typescript-eslint/rule-tester';

RuleTester.afterAll = test.afterAll;
RuleTester.describe = test.describe;
RuleTester.it = test.it;
RuleTester.itOnly = test.it.only;

However, node test-runner doesn’t have afterAll function, it is after. (Node.js Test runner doc)
So it should be fixed with after.

Affected URL(s)

https://typescript-eslint.io/packages/rule-tester/#node-built-in-test-runner
@erm1116 erm1116 added documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look labels Aug 19, 2024
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels Aug 19, 2024
@erm1116 erm1116 mentioned this issue Aug 19, 2024
Merged
3 tasks
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label Aug 28, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: fix setup example for node:test in RuleTester erm1116/typescript-eslint
2 participants
@JoshuaKGoldberg @erm1116
0