Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop providing configuration for deprecated formatting rules #148

Open
m-akinc opened this issue Jun 26, 2024 · 2 comments
Open

Stop providing configuration for deprecated formatting rules #148

m-akinc opened this issue Jun 26, 2024 · 2 comments

Comments

@m-akinc
Copy link
Contributor

m-akinc commented Jun 26, 2024

Formatting rules were deprecated in ESLint 8.53.0. As suggested in the linked document, we should probably replace these with their counterparts from @stylistic/eslint-plugin-js(ts).

@jattasNI
Copy link
Collaborator

Consensus among our working group is to migrate to the new stylistic packages in order to get off of deprecated rules. But we have until ESLint v10 to do so since that's when the deprecated rules will be deleted.

Longer term we could look at using one of the formatters in the linked blog post instead. Probably not prettier since it isn't very fast or configurable, but the dprint one looks worth exploring.

We don't anticipate major client impact. If any clients were overriding any of the now deprecated rules, they may need to do a bit of work to uptake this migration. We should inspect a couple client projects to see if that's the case, but it doesn't seem likely.

This is available to work on when someone has bandwidth.

@jattasNI jattasNI removed the triage label Jun 27, 2024
@jattasNI
Copy link
Collaborator

I scanned Skyline for usages of the deprecated rules. The only instances I found were:

  • two projects configure eol-last: error
  • one inline disable of function-paren-newline
  • one inline disable and one project-wide configuration of indent
  • one project disables lines-between-class-members
  • one project unnecesarily sets no-trailing-spaces: error
  • a few inline disables of object-curly-newline
  • one inline disable of quote-props
  • one override of spaced-comment

In summary: nothing that should stop us from doing this work but a handful of places that might need to be looked at when uptaking this change if the rule names or configurations change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants