chore: enabled eslint-plugin-perfectionist on utils #9698

JoshuaKGoldberg · 2024-08-01T21:23:08Z

PR Checklist

Addresses an existing open issue: starts on Repo: Enable alphabetical (natural) sorting of fields #8479 ... in that it starts on it; I figure we'd want to split out followup issues for other packages
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Enables eslint-plugin-perfectionist on just one package to start: packages/utils.

typescript-eslint · 2024-08-01T21:23:11Z

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-08-01T21:23:25Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`59df291`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66c4d3ece10e120008a55209
😎 Deploy Preview	https://deploy-preview-9698--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (🟢 up 1 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (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-08-01T21:23:57Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 59df291. 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 30 targets

Sent with 💌 from NxCloud.

packages/utils/src/ast-utils/helpers.ts

codecov · 2024-08-01T21:45:42Z

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 88.01%. Comparing base (94f7c99) to head (59df291).
Report is 2 commits behind head on main.

Files	Patch %	Lines
packages/utils/src/ast-utils/predicates.ts	0.00%	3 Missing ⚠️
packages/utils/src/ts-eslint/ESLint.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9698   +/-   ##
=======================================
  Coverage   88.01%   88.01%           
=======================================
  Files         406      406           
  Lines       13879    13879           
  Branches     4055     4055           
=======================================
  Hits        12216    12216           
  Misses       1354     1354           
  Partials      309      309

Flag	Coverage Δ
unittest	`88.01% <42.85%> (ø)`

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

Files	Coverage Δ
...utils/src/ast-utils/eslint-utils/PatternMatcher.ts	`66.66% <ø> (ø)`
...ils/src/ast-utils/eslint-utils/ReferenceTracker.ts	`85.71% <ø> (ø)`
...s/utils/src/ast-utils/eslint-utils/astUtilities.ts	`53.33% <ø> (ø)`
...ges/utils/src/ast-utils/eslint-utils/predicates.ts	`51.11% <ø> (ø)`
packages/utils/src/ast-utils/helpers.ts	`68.18% <ø> (ø)`
packages/utils/src/eslint-utils/RuleCreator.ts	`66.66% <ø> (ø)`
...ckages/utils/src/eslint-utils/getParserServices.ts	`94.11% <ø> (ø)`
packages/utils/src/eslint-utils/index.ts	`100.00% <100.00%> (ø)`
packages/utils/src/ts-eslint/Linter.ts	`50.00% <ø> (ø)`
packages/utils/src/ts-eslint/RuleTester.ts	`50.00% <ø> (ø)`
... and 4 more

eslint.config.mjs

Co-authored-by: Brad Zacher <brad.zacher@gmail.com>

kirkwaiblinger · 2024-08-15T00:18:42Z

I'm -0.5 on proceeding with this due to the null | string behavior that exists for now (#9698 (comment)). But if that's deemed an accepted drawback, then I approve this PR.

bradzacher · 2024-08-15T00:25:16Z

Have we got an issue filed upstream?
I feel like a "put nullish types last" option probably would be a good default.

JoshuaKGoldberg · 2024-08-19T12:12:39Z

Filed azat-io/eslint-plugin-perfectionist#223. There's a groups option but I couldn't tell from the docs what the sanctioned way to do this is.

Edit: shoutout & thanks @hugop95 for azat-io/eslint-plugin-perfectionist#223 (comment) !

kirkwaiblinger

🚀😁

eslint.config.mjs

FloEdelmann · 2024-08-21T14:11:30Z

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

  export type GlobalVariableOptionBase =
    | 'off'
+    | 'readable'
    | 'readonly'
-    | 'writable'
-    | /** @deprecated use `'writable'` */ 'writeable'
-    | /** @deprecated use `'readonly'` */ 'readable';
+    | /** @deprecated use `'writable'` */ 'writable'
+    | /** @deprecated use `'readonly'` */ 'writeable';
  export type GlobalVariableOptionBoolean =
-    | /** @deprecated use `'writable'` */ true
-    | /** @deprecated use `'readonly'` */ false;
+    | /** @deprecated use `'writable'` */ false
+    | /** @deprecated use `'readonly'` */ true;


The comments are out of place now.

Oh, nice! Thanks for the catch :)

FloEdelmann · 2024-08-21T14:11:54Z

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

    files?: (
-      | string
-      // yes, a single layer of array nesting is supported
      | string[]
+      // yes, a single layer of array nesting is supported
+      | string


The comment should still be before string[].

chore: enabled eslint-plugin-perfectionist on utils

9acdfef

Josh-Cena reviewed Aug 1, 2024

View reviewed changes

packages/utils/src/ast-utils/helpers.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg mentioned this pull request Aug 12, 2024

Feature: Allow specifying cross-rule default settings azat-io/eslint-plugin-perfectionist#202

Closed

2 tasks

Set ignoreCase to false

c450608

JoshuaKGoldberg requested review from Josh-Cena and abrahamguo August 12, 2024 16:32

JoshuaKGoldberg marked this pull request as ready for review August 12, 2024 16:32

JoshuaKGoldberg requested review from a team and removed request for abrahamguo August 12, 2024 17:03

bradzacher previously approved these changes Aug 13, 2024

View reviewed changes

eslint.config.mjs Outdated Show resolved Hide resolved

eslint.config.mjs Outdated Show resolved Hide resolved

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

Apply suggestions from code review

6f157e9

Co-authored-by: Brad Zacher <brad.zacher@gmail.com>

JoshuaKGoldberg dismissed bradzacher’s stale review via 6f157e9 August 13, 2024 14:25

JoshuaKGoldberg requested review from abrahamguo and bradzacher August 14, 2024 19:24

bradzacher previously approved these changes Aug 14, 2024

View reviewed changes

JoshuaKGoldberg mentioned this pull request Aug 19, 2024

Docs: Explain & show examples of 'groups' azat-io/eslint-plugin-perfectionist#223

Closed

2 tasks

JoshuaKGoldberg added blocked by another issue Issues which are not ready because another issue needs to be resolved first and removed 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labels Aug 19, 2024

JoshuaKGoldberg marked this pull request as draft August 19, 2024 12:41

Merge branch 'main'

a5a8959

JoshuaKGoldberg dismissed bradzacher’s stale review via a5a8959 August 20, 2024 06:27

Put nullish last

81888f5

kirkwaiblinger previously approved these changes Aug 20, 2024

View reviewed changes

eslint.config.mjs Outdated Show resolved Hide resolved

JoshuaKGoldberg removed the blocked by another issue Issues which are not ready because another issue needs to be resolved first label Aug 20, 2024

Remove ignoreCase

6032d90

JoshuaKGoldberg marked this pull request as ready for review August 20, 2024 16:12

JoshuaKGoldberg dismissed kirkwaiblinger’s stale review via 6032d90 August 20, 2024 16:12

JoshuaKGoldberg requested a review from kirkwaiblinger August 20, 2024 16:12

kirkwaiblinger previously approved these changes Aug 20, 2024

View reviewed changes

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

Bump to version with fixed types

59df291

JoshuaKGoldberg dismissed kirkwaiblinger’s stale review via 59df291 August 20, 2024 17:35

JoshuaKGoldberg merged commit 6250dab into typescript-eslint:main Aug 20, 2024
60 checks passed

JoshuaKGoldberg deleted the eslint-plugin-perfectionist-utils branch August 20, 2024 17:55

FloEdelmann reviewed Aug 21, 2024

View reviewed changes

JoshuaKGoldberg mentioned this pull request Aug 21, 2024

chore: correct a few comment placements in utils #9856

Merged

github-actions bot locked as resolved and limited conversation to collaborators Aug 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore: enabled eslint-plugin-perfectionist on utils #9698

chore: enabled eslint-plugin-perfectionist on utils #9698

Uh oh!

JoshuaKGoldberg commented Aug 1, 2024 •

edited

Loading

Uh oh!

typescript-eslint bot commented Aug 1, 2024

Uh oh!

netlify bot commented Aug 1, 2024 •

edited

Loading

Uh oh!

nx-cloud bot commented Aug 1, 2024 •

edited

Loading

Uh oh!

Uh oh!

codecov bot commented Aug 1, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commented Aug 15, 2024

Uh oh!

bradzacher commented Aug 15, 2024

Uh oh!

JoshuaKGoldberg commented Aug 19, 2024 •

edited

Loading

Uh oh!

kirkwaiblinger left a comment

Uh oh!

Uh oh!

Uh oh!

FloEdelmann Aug 21, 2024

Uh oh!

JoshuaKGoldberg Aug 21, 2024

Uh oh!

JoshuaKGoldberg Aug 21, 2024

Uh oh!

FloEdelmann Aug 21, 2024

Uh oh!

Uh oh!

Uh oh!

chore: enabled eslint-plugin-perfectionist on utils #9698

chore: enabled eslint-plugin-perfectionist on utils #9698

Uh oh!

Conversation

JoshuaKGoldberg commented Aug 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Aug 1, 2024

Uh oh!

netlify bot commented Aug 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented Aug 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

Uh oh!

codecov bot commented Aug 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commented Aug 15, 2024

Uh oh!

bradzacher commented Aug 15, 2024

Uh oh!

JoshuaKGoldberg commented Aug 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kirkwaiblinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

FloEdelmann Aug 21, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Aug 21, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Aug 21, 2024

Choose a reason for hiding this comment

Uh oh!

FloEdelmann Aug 21, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JoshuaKGoldberg commented Aug 1, 2024 •

edited

Loading

netlify bot commented Aug 1, 2024 •

edited

Loading

nx-cloud bot commented Aug 1, 2024 •

edited

Loading

codecov bot commented Aug 1, 2024 •

edited

Loading

JoshuaKGoldberg commented Aug 19, 2024 •

edited

Loading