Update for eslint v8 #29

klassm · 2021-10-28T11:44:51Z

Changes for making the eslint rule compatible with eslint 8. In general this is about setting hasSuggestion to true for suggestion rules.
In your case it looks like the rule is actually not a suggestion. More details at the respective line.

klassm · 2021-10-28T12:18:39Z

.eslintrc.js

@@ -47,6 +47,7 @@ module.exports = {
                    { devDependencies: true }
                ],
                "no-console": "off",
+                "@typescript-eslint/no-unsafe-argument": "off",


This is for the e2e test - jest objectContaining will return an any. I did not find a way around it.

See the example.serial-test.ts changes in commit [7840c91] of the release/v2.0 branch, I used a type-cast since that is the only way to override jest's poor decision to explicitly return any rather than a generic.

https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/release/v2.0/tests/example.serial-test.ts

lib/rules/expect-expect.ts

klassm · 2021-10-28T12:20:06Z

lib/rules/no-skip.ts

@@ -17,11 +17,10 @@ export default createRule({
        messages: {
            noSkip: "Do not use the `.skip` hook."
        },
-        type: "suggestion",
+        type: "problem",


A suggestion needs to also provide a suggestion array - at least if I understood the docs correctly.
This is actually also the underlying error - if you have a suggestion, you need to set hasSuggestion also to true. But if you do that the require-meta-has-suggestions rule will break.

I did not run into this error about suggestions when I worked on the update to eslint@v8. Will this be a breaking change for v7?

codejedi365 · 2021-10-28T19:52:38Z

@klassm, Good work and good effort trying to resolve everything for an update. Surprisingly, I attempted the same thing this past weekend as part of the release/v2.0 branch. I did not run into an issue related to a suggestion rule. Could you provide some insight how you found that?

I did find a couple of issues that held up the expansion to support eslint@v8.

eslint-config-airbnb-base#2478 is not ready for eslint@v8 which means I do not want to bump all the devDependencies yet since it is for developers use, BUT in terms of the production plugin when used by others, I want to support v7.0 || v8.0.
I also found the plugin is actually not compatible with v6.8 even though the peer dependency says it is. Not sure when that broke, It might just be for v2.0 refactor but likely not. Given I'm restricting compatibility, I feel it should be a part of a major version update.

I do appreciate the effort you put forth. I think I will need to think a bit more about what is the best method to release your PR and the v2.0 features. I hoped to release v2.0 this past weekend but I kept hitting snags and so there is still stuff to work through. You might be able to rebase or branch from release/v2.0 (I think it's clean enough) and help transition to eslint@v8.

With that said, I will be unavailable to work through next week meaning I would anticipate a release date around Nov 13th.

klassm · 2021-10-28T20:10:12Z

Hey hey. Sure, you also put a lot of thinking into this already :-). Maybe the info why I changed the plugin - probably I noted this because I pulled everything to eslint 8. This meant that also the eslint configuration for the project is suddenly eslint 8. When I did that eslint itself started to complain that the rule is actually not a suggestion role. You could also add the hasSuggestion flag - but it did not help, then it complained about something else. In the end I found that the rule itself does not really provide any suggestions, does it? So probably problem is more fitting.

I did not totally get your comment about airbnb. When I pulled up everything to v8, I also pulled up all the plugins. The project compiled just fine :-)

codejedi365 · 2021-10-28T21:44:30Z

Not sure how familiar you are with dependency types but plugins usually use the peerDependencies category. DevDependencies define packages only used for development purposes which is why they are not installed in a production install (a install as a dependency for another project).

In relation to AirBnB's configuration as a plugin, they have a set peerDependency:

{
  "peerDependencies": {
      "eslint": "^5.0.0 || ^6.8.0 || ^7.32.0"
  }
}

There is an open issue for an update. Since I use eslint-plugin-airbnb-typescript and eslint-plugin-airbnb-base they require the dependency of eslint@^7. You bumped this package's devDependency to eslint@^8.1.0. If you run my dev run-script npm run lint, AirBnb will not work. This is key for maintaining a familiar codebase for PRs and such.

What I combined into the same statement was my desire to support eslint@v8 as a listed entry in the peerDependencies of eslint-plugin-testcafe-community. AirBnB not making an update to support v8 is not a limiting factor for testcafe-community plugin to update to support v8.

Ultimately, what I did in release/v2.0 was only update testcafe-community to support eslint@v8 through manual testing in the example package but not actually bump any devDependencies. I only added to the peerDependency listing:

{
  "peerDependencies": {
      "eslint": "^7 || ^8"
  }
}

codejedi365

I merged this branch into a working branch with some improvements off of next. Made the changes we discussed and luckily overcame any issues with TS compilation.

This is now in version v1.3.0 of the eslint-plugin-testcafe-community@next package.

codejedi365 · 2021-10-28T19:04:50Z

.eslintrc.js

@@ -47,6 +47,7 @@ module.exports = {
                    { devDependencies: true }
                ],
                "no-console": "off",
+                "@typescript-eslint/no-unsafe-argument": "off",


See the example.serial-test.ts changes in commit [7840c91] of the release/v2.0 branch, I used a type-cast since that is the only way to override jest's poor decision to explicitly return any rather than a generic.

https://github.com/testcafe-community/eslint-plugin-testcafe-community/blob/release/v2.0/tests/example.serial-test.ts

codejedi365 · 2021-10-28T19:09:13Z

lib/rules/no-skip.ts

@@ -17,11 +17,10 @@ export default createRule({
        messages: {
            noSkip: "Do not use the `.skip` hook."
        },
-        type: "suggestion",
+        type: "problem",


I did not run into this error about suggestions when I worked on the update to eslint@v8. Will this be a breaking change for v7?

codejedi365 · 2021-10-28T19:12:17Z

package.json

+        "@typescript-eslint/eslint-plugin": "^5.2.0",
+        "@typescript-eslint/parser": "^5.2.0",
+        "@typescript-eslint/types": "^5.2.0",
+        "eslint": "^8.1.0",
        "eslint-config-airbnb-base": "^14.2.1",
        "eslint-config-airbnb-typescript": "^14.0.0",


Not ready yet to make the switch to v8 within the devDependencies. eslint-config-airbnb is not yet compatible with v8.

github-actions · 2021-10-30T21:17:05Z

🎉 This PR is included in version 1.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

klassm force-pushed the eslint8 branch 2 times, most recently from 5481a30 to 6891e41 Compare October 28, 2021 12:17

klassm commented Oct 28, 2021

View reviewed changes

lib/rules/expect-expect.ts Show resolved Hide resolved

klassm commented Oct 28, 2021

View reviewed changes

feat: update for eslint v8

cadf662

klassm force-pushed the eslint8 branch from 6891e41 to cadf662 Compare October 28, 2021 12:22

codejedi365 self-requested a review October 28, 2021 18:51

codejedi365 reviewed Oct 30, 2021

View reviewed changes

codejedi365 merged commit 8717cc3 into testcafe-community:master Oct 30, 2021

github-actions bot added the released label Oct 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update for eslint v8 #29

Update for eslint v8 #29

klassm commented Oct 28, 2021 •

edited

klassm Oct 28, 2021

codejedi365 Oct 28, 2021

klassm Oct 28, 2021

codejedi365 Oct 28, 2021

codejedi365 commented Oct 28, 2021 •

edited

klassm commented Oct 28, 2021

codejedi365 commented Oct 28, 2021

codejedi365 left a comment

codejedi365 Oct 28, 2021

codejedi365 Oct 28, 2021

codejedi365 Oct 28, 2021

github-actions bot commented Oct 30, 2021

Update for eslint v8 #29

Update for eslint v8 #29

Conversation

klassm commented Oct 28, 2021 • edited

klassm Oct 28, 2021

Choose a reason for hiding this comment

codejedi365 Oct 28, 2021

Choose a reason for hiding this comment

klassm Oct 28, 2021

Choose a reason for hiding this comment

codejedi365 Oct 28, 2021

Choose a reason for hiding this comment

codejedi365 commented Oct 28, 2021 • edited

klassm commented Oct 28, 2021

codejedi365 commented Oct 28, 2021

codejedi365 left a comment

Choose a reason for hiding this comment

codejedi365 Oct 28, 2021

Choose a reason for hiding this comment

codejedi365 Oct 28, 2021

Choose a reason for hiding this comment

codejedi365 Oct 28, 2021

Choose a reason for hiding this comment

github-actions bot commented Oct 30, 2021

klassm commented Oct 28, 2021 •

edited

codejedi365 commented Oct 28, 2021 •

edited