feat: :sparkles: Support ESLint 8 by idahogurl · Pull Request #696 · prettier/prettier-eslint

idahogurl · 2022-01-24T21:35:13Z

Closes #656

These are breaking changes as the ESLint API has changed with version 8.

Major change is that format is now asynchronous. This is because the executeOnText function (now lintText) https://github.com/eslint/eslint/blob/851f1f18bd1a5da32c1b645bfcb28fadc627ad9e/lib/eslint/eslint.js#L572 is asynchronous. I would have made my changes backward compatible, but there is no backward compatible method for the asynchronous change.

These are breaking changes as the ESLint API has changed with version 8

idahogurl · 2022-01-24T21:48:32Z

+    if (Array.isArray(eslintConfig.globals)) {
+      const tempGlobals = {};
+      eslintConfig.globals.forEach(g => {
+        const [key,value] = g.split(':');
+        tempGlobals[key] = value;
+      });
+      eslintConfig.globals = tempGlobals;
+    }
+
+    eslintConfig.overrideConfig = { 
+      rules: eslintConfig.rules,
+      parser: eslintConfig.parser,
+      globals: eslintConfig.globals,
+      parserOptions: eslintConfig.parserOptions,
+      ignorePatterns: eslintConfig.ignorePattern,
+      ...eslintConfig.overrideConfig,
+    };
+
+    delete eslintConfig.rules;
+    delete eslintConfig.parser;
+    delete eslintConfig.parserOptions;
+    delete eslintConfig.globals;
+    delete eslintConfig.ignorePattern;


The config accepted by the ESLint API is different now. Anything that overrides the config (rules, parser, parserOptions, globals, ignorePattern, etc) needs to be in overrideConfig not the root object. To lessen the upgrade overhead, I chose to transform the arguments and not make the user change their parameters.

Also, globals must be an object now and not an array.

idahogurl · 2022-02-01T00:04:43Z

      }
-    ]
+    ],
+    "import/no-import-module-exports": "off"


Updated eslint-config-kentcdodds package is set to error on this rule.

idahogurl · 2022-02-01T02:58:12Z

@@ -0,0 +1,4 @@
+module.exports = {


The eslint-config-kentcdodds update changed some rules including removing the quotes and arrow parenthesis rules.

gdibble · 2022-03-02T00:43:00Z

🙏 TY @DanielKlys7

sheuertz · 2022-03-31T18:42:03Z

Is there a timeframe for this release?

bernardocs · 2022-04-12T18:44:33Z

Bump 🙌🏽
Merging this would be wonderful! :))

davy-tw · 2022-04-16T14:01:03Z

any updates?

bernardocs · 2022-04-16T16:29:49Z

Friendly ping @DanielKlys7 @idahogurl

idahogurl · 2022-04-17T15:52:13Z

@bernardocs I do not have write permissions to this repo so I cannot merge.

bernardocs · 2022-04-18T16:32:24Z

Maybe a friendly ping to some of the guys who merge other PR's ... @zimme @hamzahamidi @kylemh 👀

zimme · 2022-04-18T17:45:45Z

I haven't touched this codebase in so long I'm not really comfortable reviewing anything without having the time to get familiar with it again first and I'm sorry to say I don't really have time as I'm too busy with my startup and my family currently.

I can probably help with repo write access, for anyone that's created a few PRs and want to help maintain the package.

idahogurl · 2022-04-18T17:48:03Z

@zimme Completely understandable. Could I get write access?

kylemh · 2022-04-18T21:53:46Z

@zimme I'm not gonna be able to address this one until early May. I'm traveling a little too much to have time for OSS right now. I wouldn't mind another member 😁

If you can add @idahogurl , I say go for it. I don't have the ability.

kylemh · 2022-04-18T21:57:07Z

For reference, @idahogurl I'd recommend not simply merging your PR if you do get write access. For some reason, your PR didn't go through our CI.

I tried tackling this one awhile ago in #505 but have had no luck passing CI with the brief time I had available for this project.

Maybe a git commit -m "run you dumb bot" --allow-empty could get things running 👀

BREAKING CHANGES: The `format` function is now asynchronous. Closes prettier#656

kylemh · 2022-04-18T23:24:35Z

ah interesting i still need to manually tell GitHub actions you're allowed to run?!

codecov-commenter · 2022-04-18T23:25:24Z

Codecov Report

Merging #696 (bed24b6) into master (c62769e) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #696   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          262       281   +19     
  Branches        67        77   +10     
=========================================
+ Hits           262       281   +19

Impacted Files	Coverage Δ
src/index.js	`100.00% <100.00%> (ø)`
src/utils.js	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c62769e...bed24b6. Read the comment docs.

kylemh

nice. this will decrease the scope of that other PR

gdibble · 2022-04-18T23:38:13Z

gdibble · 2022-04-18T23:43:11Z

🙏 My sincere thanks on behalf of the community and personally

kylemh · 2022-04-19T01:11:27Z

looks like the release didn't automatically occur. I'll sort this out ASAP, but if @idahogurl gets write permissions then I presume she'll fix it ASAP!

idahogurl · 2022-04-19T01:13:13Z

@kylemh Already have a PR up 😄 #724

github-actions · 2022-04-21T14:59:51Z

🎉 This PR is included in version 14.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

zimme · 2022-04-21T15:41:56Z

Don't forget to check if prettier-eslint-cli needs updating to work with the new prettier-eslint.

georgecrawford · 2022-04-25T20:48:36Z

I'm struggling to get this working, as I posted here: prettier/prettier-eslint-cli#427 (comment)

"eslint": "8.13.0",
"prettier": "2.6.2",
"prettier-eslint": "14.0.0",
"prettier-eslint-cli": "5.0.1",

... and yet I'm still seeing:

$ ./node_modules/.bin/prettier-eslint file.js
prettier-eslint [ERROR]: There was trouble creating the ESLint CLIEngine.
prettier-eslint-cli [ERROR]: There was an error formatting "file.js":
    TypeError: CLIEngine is not a constructor
        at getESLintCLIEngine (./node_modules/prettier-eslint-cli/node_modules/prettier-eslint/dist/utils.js:403:12)
        at getESLintConfig (./node_modules/prettier-eslint-cli/node_modules/prettier-eslint/dist/index.js:210:51)
        at format (./node_modules/prettier-eslint-cli/node_modules/prettier-eslint/dist/index.js:75:71)
        at MapSubscriber.project (./node_modules/prettier-eslint-cli/dist/format-files.js:268:54)
        at MapSubscriber._next (./node_modules/rxjs/internal/operators/map.js:49:35)
        at MapSubscriber.Subscriber.next (./node_modules/rxjs/internal/Subscriber.js:66:18)
        at AsyncSubject.Subject.next (./node_modules/rxjs/internal/Subject.js:60:25)
        at AsyncSubject.complete (./node_modules/rxjs/internal/AsyncSubject.js:53:35)
        at handler (./node_modules/rxjs/internal/observable/bindNodeCallback.js:53:33)
        at FSReqCallback.readFileAfterClose [as oncomplete] (node:internal/fs/read_file_context:68:3)
failure formatting 1 file with prettier-eslint

Is there anything obvious that I've done wrong?

idahogurl · 2022-04-26T14:33:57Z

@georgecrawford There was a hotfix that came out. Upgrade to 14.0.1

georgecrawford · 2022-04-26T21:17:45Z

Hmm. Thanks @idahogurl but I still have the exact same problem with:

"eslint": "8.13.0",
"prettier": "2.6.2",
"prettier-eslint": "14.0.1",
"prettier-eslint-cli": "5.0.1",

Looking further into it, the issue seems to be that prettier-eslint-cli is very out of date. The package.json lists the following:

"eslint": "^5.0.0",
"prettier-eslint": "^9.0.0",

I know prettier-eslint-cli is a separate project entirely, but it seems to have stalled. Are you aware of other ways in which I can run prettier-eslint on the CLI which don't use this package, and therefore don't lock us into old ESLint and prettier-eslint?

Thanks for any advice you can give!

idahogurl · 2022-04-27T15:17:56Z

@georgecrawford I'm going to create a PR to update the CLI.

georgecrawford · 2022-04-27T15:22:23Z

Amazing. Thanks so much!

…

____________________ George

On 27 Apr 2022, at 16:18, Rebecca Vest ***@***.***> wrote: @georgecrawford <https://github.com/georgecrawford> I'm going to create a PR to update the CLI. — Reply to this email directly, view it on GitHub <#696 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAUWAJJFST3O536MW4SIHDVHFLC7ANCNFSM5MWQYIGA>. You are receiving this because you were mentioned.

idahogurl · 2022-04-27T17:37:49Z

@georgecrawford Appears this is going to be harder than I thought. I ran the tests after I installed the packages and all the tests are failing for me. It uses RxJs which I am not familiar with whatsoever. I'm using Node 12 not Node 8 so don't know if that affects it.

You could write a Node script that loops through files, runs the format function on each, and then overwrites the files like the CLI does. I'm not sure about performance. I think @kentcdodds used RxJs to improve performance.

You could look into using worker threads which requires Node 14+

smartdev322 · 2022-05-06T16:20:20Z

Hello, @idahogurl
Can you give me a detailed description and the scripts?
I am just a starter of prettier.

idahogurl · 2022-05-11T16:56:03Z

@georgecrawford @smartdev322 prettier-eslint-cli version 6.01 is now out. https://github.com/prettier/prettier-eslint-cli/releases/tag/v6.0.0

feat: ✨ Support ESLint 8

fa7437d

These are breaking changes as the ESLint API has changed with version 8

idahogurl commented Jan 24, 2022

View reviewed changes

idahogurl mentioned this pull request Jan 24, 2022

Error: r is not a constructor idahogurl/vs-code-prettier-eslint#26

Closed

Fix tests

009b377

idahogurl commented Feb 1, 2022

View reviewed changes

Rebecca Vest added 3 commits January 31, 2022 18:12

Fix test coverage

4f47189

Add to contributors

745e42e

Prettier

c71310f

idahogurl commented Feb 1, 2022

View reviewed changes

idahogurl marked this pull request as ready for review February 1, 2022 03:11

DanielKlys7 approved these changes Feb 17, 2022

View reviewed changes

Rebecca Vest added 2 commits April 18, 2022 16:41

feat: ⬆️ Upgrade to ESLint 8

f3ef24e

BREAKING CHANGES: The `format` function is now asynchronous. Closes prettier#656

Run CI on pull requests

bed24b6

kylemh approved these changes Apr 18, 2022

View reviewed changes

hamzahamidi approved these changes Apr 18, 2022

View reviewed changes

kylemh merged commit d8bf1e3 into prettier:master Apr 18, 2022

idahogurl deleted the eslint-8-support branch April 18, 2022 23:52

idahogurl mentioned this pull request Apr 21, 2022

Error after updating eslint to 8.1.0 prettier/prettier-eslint-cli#427

Closed

github-actions bot added the released label Apr 21, 2022

IronBlood mentioned this pull request May 25, 2022

Fix the return type of format: string -> Promise<string> #751

Merged

JounQin mentioned this pull request Aug 15, 2022

Support TypeScript v4.x #402

Closed

qyurila mentioned this pull request Oct 16, 2022

Error: reportUnusedDisableDirectives must be any of "error", "warn", "off", and null #802

Closed

Uh oh!

Conversation

idahogurl commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

idahogurl Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

idahogurl Feb 1, 2022

Choose a reason for hiding this comment

Uh oh!

idahogurl Feb 1, 2022

Choose a reason for hiding this comment

Uh oh!

gdibble commented Mar 2, 2022

Uh oh!

sheuertz commented Mar 31, 2022

Uh oh!

bernardocs commented Apr 12, 2022

Uh oh!

davy-tw commented Apr 16, 2022

Uh oh!

bernardocs commented Apr 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

idahogurl commented Apr 17, 2022

Uh oh!

bernardocs commented Apr 18, 2022

Uh oh!

zimme commented Apr 18, 2022

Uh oh!

idahogurl commented Apr 18, 2022

Uh oh!

kylemh commented Apr 18, 2022

Uh oh!

kylemh commented Apr 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kylemh commented Apr 18, 2022

Uh oh!

codecov-commenter commented Apr 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kylemh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gdibble commented Apr 18, 2022

Uh oh!

gdibble commented Apr 18, 2022

Uh oh!

kylemh commented Apr 19, 2022

Uh oh!

idahogurl commented Apr 19, 2022

Uh oh!

github-actions bot commented Apr 21, 2022

Uh oh!

zimme commented Apr 21, 2022

Uh oh!

georgecrawford commented Apr 25, 2022

Uh oh!

idahogurl commented Apr 26, 2022

Uh oh!

georgecrawford commented Apr 26, 2022

Uh oh!

idahogurl commented Apr 27, 2022

Uh oh!

georgecrawford commented Apr 27, 2022 via email

Uh oh!

idahogurl commented Apr 27, 2022

Uh oh!

smartdev322 commented May 6, 2022

Uh oh!

idahogurl commented May 11, 2022

Uh oh!

Reviewers

Assignees

Labels

idahogurl commented Jan 24, 2022 •

edited

Loading

idahogurl Jan 24, 2022 •

edited

Loading

bernardocs commented Apr 16, 2022 •

edited

Loading

kylemh commented Apr 18, 2022 •

edited

Loading

codecov-commenter commented Apr 18, 2022 •

edited

Loading

kylemh left a comment •

edited

Loading