import{ESLintUtils}from'@typescript-eslint/experimental-utils';constmyRule=ESLintUtils.RuleCreator.withoutDocs({create(context){// ...},meta:{// ...},});

I'm not 100% attached to this particular API. I chose it because it forces people to importRuleCreator anyway and has a"you're not documenting this" name.

Adds a bit of JSDoc around the two functions to help make them clear in IDEs.

feat: add RuleCreator.withoutDocs

d068cd5

Copy link

Contributor

typescript-eslintbot commentedNov 13, 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 13, 2021•
edited
Loading

✔️ Deploy Preview fortypescript-eslint ready!

🔨 Explore the source changes:ba132ea

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

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

Copy link

nx-cloudbot commentedNov 13, 2021•
edited
Loading

Nx Cloud Report

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

📂 See all runs for this branch

Status	Command
	`Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin-internal`
	`Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 14.x - nx test @typescript-eslint/eslint-plugin`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin`
	`Node 16.x - nx test @typescript-eslint/eslint-plugin`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint`
	`Node 12.x - nx test @typescript-eslint/eslint-plugin`
	`Node 12.x - nx run-many --target=typecheck --all --parallel`
	`Node 14.x - nx test @typescript-eslint/parser`
	`Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website`
	`Node 14.x - nx test @typescript-eslint/experimental-utils`
	`Node 16.x - nx test @typescript-eslint/parser`
	`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 12.x - nx test @typescript-eslint/parser`
	`Node 14.x - nx run-many --target=build --all --parallel --exclude website --exclude website`
	`Node 12.x - nx test @typescript-eslint/parser`

Sent with 💌 fromNxCloud.

JoshuaKGoldberg marked this pull request as draft

November 13, 2021 19:25

Copy link

codecovbot commentedNov 13, 2021•
edited
Loading

Codecov Report

Merging#4136 (ba132ea) intomaster (ae0fb5a) willdecrease coverage by0.21%.
The diff coverage is100.00%.

@@            Coverage Diff             @@##           master    #4136      +/-   ##==========================================- Coverage   93.35%   93.14%   -0.22%==========================================  Files         152      157       +5       Lines        8035     8251     +216       Branches     2579     2640      +61     ==========================================+ Hits         7501     7685     +184- Misses        180      192      +12- Partials      354      374      +20

Flag	Coverage Δ
unittest	`93.14% <100.00%> (-0.22%)`	⬇️

Flags with carried forward coverage won't be shown.Click here to find out more.

Impacted Files	Coverage Δ
...lugin/src/rules/no-confusing-non-null-assertion.ts	`82.60% <ø> (ø)`
...rc/rules/no-unnecessary-boolean-literal-compare.ts	`93.50% <ø> (ø)`
packages/eslint-plugin/src/rules/prefer-for-of.ts	`90.00% <ø> (ø)`
...plugin/src/rules/prefer-string-starts-ends-with.ts	`97.83% <ø> (ø)`
.../eslint-plugin/src/rules/restrict-plus-operands.ts	`100.00% <ø> (ø)`
...kages/eslint-plugin/src/rules/no-base-to-string.ts	`98.48% <100.00%> (+0.02%)`	⬆️
...gin-internal/src/rules/no-poorly-typed-ts-props.ts	`88.88% <0.00%> (ø)`
...lugin-internal/src/rules/plugin-test-formatting.ts	`81.34% <0.00%> (ø)`
...plugin-internal/src/rules/prefer-ast-types-enum.ts	`91.30% <0.00%> (ø)`
...-internal/src/rules/no-typescript-estree-import.ts	`87.50% <0.00%> (ø)`
... and1 more