feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364

JoshuaKGoldberg · 2024-02-04T14:22:12Z

PR Checklist

Addresses an existing open issue: fixes Configs: Allow strict configs to have more strict options than recommended? #7318
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

The gist of the changes are in the first two commits:

43943d2: Pipes through a TOptions through meta.docs's RuleMetaDataDocs type to allow a RuleRecommendationAcrossConfigs interface.
daa3513: Updates the generate:configs script to handle those options

Note that this is not a breaking change:

Existing values for meta.docs.recommended will still work, as the type is now a more permissive union
strict* configs explicitly indicate they can be modified as non-breaking changes

~~Sending as reference for triaging #7318.~~ ✅

…fig options

typescript-eslint · 2024-02-04T14:22:15Z

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.

netlify · 2024-02-04T14:22:17Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`0e8aafa`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/65f6e0fbe3b73a00085fe80c
😎 Deploy Preview	https://deploy-preview-8364--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 96 (🟢 up 3 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

nx-cloud · 2024-02-04T14:23:39Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 0e8aafa. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 from NxCloud.

codecov · 2024-03-05T15:41:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.23%. Comparing base (994812b) to head (0e8aafa).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8364      +/-   ##
==========================================
- Coverage   88.02%   87.23%   -0.79%     
==========================================
  Files         401      251     -150     
  Lines       13934    12334    -1600     
  Branches     4087     3881     -206     
==========================================
- Hits        12265    10760    -1505     
+ Misses       1370     1305      -65     
+ Partials      299      269      -30

Flag	Coverage Δ
unittest	`87.23% <ø> (-0.79%)`	⬇️

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

Files	Coverage Δ
packages/eslint-plugin/src/rules/ban-ts-comment.ts	`97.29% <ø> (ø)`
...es/eslint-plugin/src/rules/no-floating-promises.ts	`100.00% <ø> (ø)`
.../eslint-plugin/src/rules/restrict-plus-operands.ts	`100.00% <ø> (ø)`
...-plugin/src/rules/restrict-template-expressions.ts	`100.00% <ø> (ø)`
packages/utils/src/eslint-utils/RuleCreator.ts	`75.00% <ø> (ø)`

... and 150 files with indirect coverage changes

JoshuaKGoldberg · 2024-03-05T16:32:02Z

I don't know why linting is failing in Nx Cloud but not for me locally. From https://github.com/typescript-eslint/typescript-eslint/actions/runs/8159357644/job/22303718471?pr=8364:

❌ > nx run eslint-plugin-internal:lint
  
  
  Linting "eslint-plugin-internal"...
  
   >  NX   _
  
     Occurred while linting /home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/tests/rules/no-typescript-estree.test.ts:12
     Rule: "@typescript-eslint/internal/plugin-test-formatting"
  
  AtomicsWaitError: _
  Occurred while linting /home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/tests/rules/no-typescript-estree.test.ts:12
  Rule: "@typescript-eslint/internal/plugin-test-formatting"
      at _Lock.lock (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:128:11)
      at request (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:161:8)
      at #sendActionToWorker (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:218:61)
      at ThreadsWorker.sendAction (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:177:36)
      at _Synchronizer.apply (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:297:25)
      at Module.<anonymous> (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/make-synchronized/index.cjs:303:40)
      at prettierFormat (/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/dist/rules/plugin-test-formatting.js:127:22)
      at checkLiteral (/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/dist/rules/plugin-test-formatting.js:177:32)
      at checkExpression (/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/dist/rules/plugin-test-formatting.js:162:21)
      at checkValidTest (/home/runner/work/typescript-eslint/typescript-eslint/packages/eslint-plugin-internal/dist/rules/plugin-test-formatting.js:[364](https://github.com/typescript-eslint/typescript-eslint/actions/runs/8159357644/job/22303718471?pr=8364#step:5:399):25)
 >  NX   Nx Cloud: Cache miss 6517040724990785659.

cc @JamesHenry

bradzacher · 2024-03-05T21:02:22Z

@JoshuaKGoldberg thats the same intermittent thing I mentioned on discord the other day. It's something to do with the combination of nx + @prettier/sync, I think?

JoshuaKGoldberg · 2024-03-05T22:42:54Z

That sounds plausible to me!

bradzacher · 2024-03-16T01:56:35Z

packages/utils/src/ts-eslint/Rule.ts

+export interface RuleRecommendationAcrossConfigs<
+  Options extends readonly unknown[],
+> {
+  recommended: true;
+  strict: Partial<Options>;
+}


🤔 Part of me doesn't like that we're leaking our internal documentation implementation details into our public types.

I wonder if there's a way for us to privatise these types to avoid leaking them to users?

That would be nice. I don't know though 😞 and it's already there.

Filed #8695.

llllvvuu · 2024-03-19T03:01:02Z

packages/eslint-plugin/src/rules/restrict-template-expressions.ts

+            allowAny: false,
+            allowBoolean: false,
+            allowNullish: false,
+            allowNumber: false,


Is allowNumber: false intended? If so, should this doc be updated?

This rule reports on values used in a template literal string that aren't strings, numbers, or BigInts, optionally allowing other data types that provide useful stringification results.

If you think there's a small typo in the docs like that, we'd welcome a PR :) thanks

feat(eslint-plugin): add meta.docs.recommended setting for strict con…

43943d2

…fig options

JoshuaKGoldberg mentioned this pull request Feb 4, 2024

Configs: Allow strict configs to have more strict options than recommended? #7318

Closed

2 tasks

JoshuaKGoldberg added 7 commits February 4, 2024 09:31

Also updated generate:configs script

daa3513

Merge branch 'main'

d4491b8

fix: use recommended, not strict, in recommended configs

50ba30a

fix: no-floating-promises disables ignoreVoid in strict

98d1aa2

fix: no-floating-promises disables ignoreVoid in strict

60ef412

fix introduced build and lint issues

2c2f724

Fix configs.test.ts tests

df0bdfb

Merge branch 'main'

3bc01ee

JoshuaKGoldberg marked this pull request as ready for review March 5, 2024 16:32

bradzacher previously approved these changes Mar 16, 2024

View reviewed changes

bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Mar 16, 2024

JoshuaKGoldberg added 2 commits March 17, 2024 08:07

Merge branch 'main' into meta-docs-recommended-strict

b8ecd76

Fix test conflict post-merge

0e8aafa

JoshuaKGoldberg dismissed bradzacher’s stale review via 0e8aafa March 17, 2024 12:24

JoshuaKGoldberg merged commit ce79c55 into typescript-eslint:main Mar 17, 2024
59 checks passed

JoshuaKGoldberg deleted the meta-docs-recommended-strict branch March 17, 2024 14:35

llllvvuu reviewed Mar 19, 2024

View reviewed changes

llllvvuu mentioned this pull request Mar 19, 2024

docs: restrict-template-expressions - remove mention of numbers being allowed #8734

Merged

JoshuaKGoldberg mentioned this pull request Mar 25, 2024

Add a “recommended-next” preset for rules that will be recommended in next major #8676

Open

2 tasks

github-actions bot locked as resolved and limited conversation to collaborators Mar 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364

feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364

JoshuaKGoldberg commented Feb 4, 2024 •

edited

Loading

typescript-eslint bot commented Feb 4, 2024

netlify bot commented Feb 4, 2024 •

edited

Loading

nx-cloud bot commented Feb 4, 2024 •

edited

Loading

codecov bot commented Mar 5, 2024 •

edited

Loading

JoshuaKGoldberg commented Mar 5, 2024

bradzacher commented Mar 5, 2024

JoshuaKGoldberg commented Mar 5, 2024

bradzacher Mar 16, 2024

JoshuaKGoldberg Mar 17, 2024

JoshuaKGoldberg Mar 17, 2024

llllvvuu Mar 19, 2024 •

edited

Loading

JoshuaKGoldberg Mar 19, 2024

feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364

feat(eslint-plugin): add meta.docs.recommended setting for strict config options #8364

Conversation

JoshuaKGoldberg commented Feb 4, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Feb 4, 2024

netlify bot commented Feb 4, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Feb 4, 2024 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Mar 5, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg commented Mar 5, 2024

bradzacher commented Mar 5, 2024

JoshuaKGoldberg commented Mar 5, 2024

bradzacher Mar 16, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 17, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 17, 2024

Choose a reason for hiding this comment

llllvvuu Mar 19, 2024 • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg Mar 19, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg commented Feb 4, 2024 •

edited

Loading

netlify bot commented Feb 4, 2024 •

edited

Loading

nx-cloud bot commented Feb 4, 2024 •

edited

Loading

codecov bot commented Mar 5, 2024 •

edited

Loading

llllvvuu Mar 19, 2024 •

edited

Loading