Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docs: How to test PR changes to rules #4875

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
Zamiell opened this issue Apr 27, 2022 · 5 comments · Fixed by #8033
Closed

Docs: How to test PR changes to rules #4875

Zamiell opened this issue Apr 27, 2022 · 5 comments · Fixed by #8033
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating good first issue Good for newcomers

Comments

@Zamiell
Copy link
Contributor

Zamiell commented Apr 27, 2022 •
edited
Loading

I am doing a PR for a new linter rule.
I would like to test this new linter rule on an existing repository, but it is unclear how to do that.
Normally, I would use npm link for this purpose, but that doesn't seem to be working properly, presumably because this is a monorepo.

Please enumerate the steps for testing a PR in CONTRIBUTING.md.
@Zamiell Zamiell added documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look labels Apr 27, 2022
@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels Apr 29, 2022
@JoshuaKGoldberg
Copy link
Member

Great idea!

@c0sta
Copy link
Contributor

c0sta commented Dec 6, 2023 •
edited
Loading

I'd be happy to help on this one! But since Idk how to test the PR changes too, I would need some guidance or reference to somewhere I can get this info

(Edit) - I just found this Local Developmenmt and it seems exactly what the issue asks, @JoshuaKGoldberg maybe it's already done?

@JoshuaKGoldberg
Copy link
Member

We filled out much of how to link locally https://typescript-eslint.io/contributing/local-development/local-linking. Once a project is linked with the steps there, what's next would be enabling the relevant lint rule in the project's ESLint config file and running the project's lint command.

Does that make sense as a starting direction?

@c0sta
Copy link
Contributor

c0sta commented Dec 6, 2023

Yeah, makes total sense to me!

So I assume this would be a new section right under the Repository Linking, correct? Or just an extension of the Repository Linking section?

@JoshuaKGoldberg
Copy link
Member

Yeah I think having a section in that same page about testing rules would be great!

@JoshuaKGoldberg JoshuaKGoldberg changed the title Docs: How to test PR changes Docs: How to test PR changes to rules Dec 6, 2023
@c0sta c0sta mentioned this issue Dec 7, 2023
Merged
3 tasks
@github-project-automation github-project-automation bot moved this from Todo to Done in Documentation Jan 9, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 17, 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 good first issue Good for newcomers
Projects
No open projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: base Testing Rules documentation c0sta/typescript-eslint
3 participants
@JoshuaKGoldberg @Zamiell @c0sta