chore: enable recommended ESLint plugin rules

[nschonni]

Turn on the recommended set of rules for the current plugins and turn off the currently failing rules. The rules should be enabled/fixed later.

🤖 Generated by Copilot at b950006

Summary

🔧✨♻️

This pull request improves the linting configuration for the project by updating the .eslintrc.json file and removing the eslintConfig property from the package.json file. These changes enhance the code quality, accessibility, and testing of the React app.

To make our code linting more pleasant
We removed eslintConfig from package.json
And updated .eslintrc.json with care
To fix some issues and make rules more fair
Now our code quality is more consistent

Walkthrough

• Configure ESLint for React, React Hooks, and accessibility rules (link)
• Move Jest plugin settings to test file overrides (link, link)
• Simplify plugin loading and disable some recommended rules (link)
• Remove redundant eslintConfig property from package.json (link)

[anth-volk]

@nschonni Apologies for the delay in addressing this PR. Would you mind providing a bit of context as to what/why things were failing? I joined a bit after this issue and am wondering if it's still relevant. Thanks so much.

[anth-volk]

@nikhilwoodruff Should we move ahead with this?

[nikhilwoodruff]

Yep I think this is still worthwhile!

[abhcs]

I had not seen this PR before writing PRs #1080 and #1098 (sorry about the overlap!).

The first change in the new PRs is the use of the eslint-react-app config. This includes accessibility checks and optional jest rules (that I have not activated).

The second change is that I have not disabled any rules but instead fixed the errors in the code.

In light of these changes, we have to figure out which parts of this PR still apply or need modification. I can see that the Jest and jsx-a11y parts still apply but disabling is not needed for many of the rules.

[anth-volk]

Thanks for your input, @abhcs, I had meant to raise this with you early next week as I went through cleaning out a few almost-stale PRs. Since you teed it up, though, do you think there's value in separating out these recommended plugins as separate PRs? I'm anticipating that at least in a couple cases, there should be some pretty significant fixes that would have to be implemented should we activate them.

[abhcs]

"plugin:jest/recommended" has been enabled properly in this PR by fixing the errors.

"plugin:jsx-a11y/recommended" has been enabled too but by disabling some of the rules. I am not sure what rules lie in

"plugin:jsx-a11y/recommended" - "react-app" - {disabled rules in this PR}.

If this set is non-empty, then there is value in adding "plugin:jsx-a11y/recommended" with the disabled rules. For simplicity, we can ignore "plugin:jsx-a11y/recommended" in this PR and handle it separately. I agree with your assessment that enabling these rules will require significant effort.

[anth-volk]

Because of the previous lint-related PRs, this PR is now also like 50% merge conflicts...

@abhcs What if instead we close this, then you open a new one enabling plugin:jest/recommended first; we merge that, then move to a11y with an aim toward actually meeting all of the rules (if you're willing to take on that herculean task)?

Alternatively, would you be willing to handle the merge conflicts of this PR, drop a11y, and ensure that jest/recommended still functions properly?

And what of the prettier plugin?

[abhcs]

"plugin:prettier/recommended" runs Prettier as an ESLint rule and reports differences as individual ESLint issues.

This would be valuable if we were using prettier through eslint but we are using prettier with eslint everywhere. So, it can be ignored.

How about the following suggestion? I can open a PR that enables the plugins a11y and jest but with the following offending rules disabled:

    "jsx-a11y/mouse-events-have-key-events": "off",
    "jsx-a11y/click-events-have-key-events": "off",
    "jsx-a11y/no-static-element-interactions": "off",
    "jsx-a11y/no-noninteractive-element-interactions": "off"

and with @nschonni 's fixes for jest.

Then, you can open four new issues -- one for each of the rules -- hopefully people will volunteer and fix the rules one by one.

[anth-volk]

@abhcs Thanks for the details on prettier, and that sounds like a great plan

[anth-volk]

Superseded by #1114. Closing.