docs: fleshed out experimental-utils usage in Custom Rules docs#4137

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

bradzacher merged 3 commits intotypescript-eslint:mainfromJoshuaKGoldberg:custom-rules-utils-package

Nov 23, 2021

Merged

docs: fleshed out experimental-utils usage in Custom Rules docs#4137

bradzacher merged 3 commits intotypescript-eslint:mainfromJoshuaKGoldberg:custom-rules-utils-package

Nov 23, 2021

Conversation

Copy link

Member

JoshuaKGoldberg commentedNov 14, 2021

PR Checklist

Addresses an existing issue: documents followingRuleCreator's types do not support rules without a documentation URL #4133 ->feat: add RuleCreator.withoutDocs #4136
That issue was marked asaccepting prs
Steps inCONTRIBUTING.md were taken

Overview

Adds more details aroundRuleCreator usage, replacing any mention of usingrule: RuleModule<...> = ... directly.

Relies on#4136 being merged forwithoutDocs.

docs: fleshed out experimental-utils usage in Custom Rules docs

92afd2c

Copy link

Contributor

typescript-eslintbot commentedNov 14, 2021

Thanks for the PR,@JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day.

Copy link

netlifybot commentedNov 14, 2021•
edited
Loading

✔️ Deploy Preview fortypescript-eslint ready!

🔨 Explore the source changes:a9526cf

🔍 Inspect the deploy log:https://app.netlify.com/sites/typescript-eslint/deploys/6194b695cd6e9d0007fdd126

😎 Browse the preview:https://deploy-preview-4137--typescript-eslint.netlify.app

Copy link

nx-cloudbot commentedNov 14, 2021•
edited
Loading

Nx Cloud Report

CI ran the following commands for commita9526cf. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status	Command
	`Node 12.x - nx run-many --target=typecheck --all --parallel`
	`Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 14.x - nx test @typescript-eslint/eslint-plugin`
	`Node 14.x - nx test @typescript-eslint/parser`
	`Node 14.x - nx test @typescript-eslint/experimental-utils`
	`Node 14.x - nx test @typescript-eslint/scope-manager`
	`Node 14.x - nx test @typescript-eslint/visitor-keys`
	`Node 14.x - nx test @typescript-eslint/typescript-estree`
	`Node 14.x - nx run-many --target=build --all --parallel --exclude website --exclude website`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin`
	`Node 12.x - nx test @typescript-eslint/parser`
	`Node 12.x - nx test @typescript-eslint/experimental-utils`
	`Node 12.x - nx test @typescript-eslint/scope-manager`
	`Node 12.x - nx test @typescript-eslint/visitor-keys`
	`Node 12.x - nx test @typescript-eslint/typescript-estree`
	`Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website`
	`Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website`
	`Node 12.x - nx prebuild @typescript-eslint/types`
	`Node 12.x - nx prebuild @typescript-eslint/types`