Enable "react/recommended" lint ruleset and fix/suppress violations #1937
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremywiebe
commented
Nov 30, 2024
.eslintrc.js
Outdated
Comment on lines
312
to
315
| "react/no-string-refs": "off", // on in recommended, but #legacy-code | ||
| "react/no-find-dom-node": "off", // on in recommended, but #legacy-code | ||
| "react/display-name": "off", // on in recommended, but we have many components that don't have a displayName | ||
| "react/no-unescaped-entities": "off", // on in recommended, but #legacy-code |
There was a problem hiding this comment.
I've turned off a few of the react/recommended rules because they were pretty pervasive. Some adventurous person can pick these off if that sounds like fun. :)
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (af19345) and published it to npm. You Example: yarn add @khanacademy/perseus@PR1937If you are working in Khan Academy's webapp, you can run: ./dev/tools/bump_perseus_version.sh -t PR1937 |
|
Size Change: +53 B (0%) Total Size: 1.29 MB
ℹ️ View Unchanged
|
jeremywiebe
commented
Nov 30, 2024
| @@ -4,7 +4,7 @@ import { | |||
| } from "@khanacademy/perseus"; | |||
| import {View} from "@khanacademy/wonder-blocks-core"; | |||
| import {spacing} from "@khanacademy/wonder-blocks-tokens"; | |||
| import {useState} from "react"; | |||
| import * as React from "react"; | |||
There was a problem hiding this comment.
Not importing React was violating the react/react-in-jsx-scope rule. React 18 apparently uses the new JSX runtime which doesn't require this, but I'm not 100% sure if we are using the new JSX runtime (we are in Storybook/Vite, but not sure about in our production builds). I'm going to add this here for now instead of disabling the rule.
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
benchristel
approved these changes
Dec 2, 2024
.eslintrc.js
Outdated
| "react/no-string-refs": "off", // on in react/recommended, but we have #legacy-code | ||
| "react/no-find-dom-node": "off", // on in react/recommended, but we have #legacy-code | ||
| "react/display-name": "off", // on in react/recommended, but doesn't seem that useful to fix | ||
| "react/no-unescaped-entities": "off", // on in react/recommended, but we have #legacy-code |
There was a problem hiding this comment.
It seems like unescaped HTML entities should be easy to fix, though it also seems low-value to fix them if they're in code that we're not actively working on.
There was a problem hiding this comment.
They were easy to fix. I enabled this rule, took 20 min and fixed them all. Thanks for the nudge. :)
jeremywiebe
force-pushed
the
jer/eslint-react-recommended
branch
from
3cf01eb to
af19345
Compare
Merged
mark-fitzgerald
pushed a commit
that referenced
this pull request
Dec 5, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/[email protected] ### Minor Changes - [#1901](#1901) [`051c50cf7`](051c50c) Thanks [@Myranae](https://github.com/Myranae)! - Introduces a validation function for the number line widget (extracted from the scoring function). - [#1936](#1936) [`d05272661`](d052726) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Changes the PerseusWidgetsMap to be extensible so that widgets can be registered outside of Perseus and still have full type safety. - [#1832](#1832) [`e3062b3c8`](e3062b3) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Update the UI to match Expression widget ### Patch Changes - [#1937](#1937) [`3cdabf1a3`](3cdabf1) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - TypeScript fixes - [#1948](#1948) [`e21a3a39b`](e21a3a3) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Refactor internally used object mapping utilities to use ES6 exports - [#1938](#1938) [`5e8d8468b`](5e8d846) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Type fixes - [#1942](#1942) [`1d2b4e7bf`](1d2b4e7) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Ensure that zoomed-in images retain alt text - [#1861](#1861) [`763a4ba38`](763a4ba) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Show format options as a list - [#1947](#1947) [`b8926e38a`](b8926e3) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Minor refactoring of ServerItemRenderer's componentDidUpdate to reduce duplication - [#1946](#1946) [`f35512786`](f355127) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Refactor scoring for `group` widget to follow the same pattern as all other widgets - [#1891](#1891) [`ef819ea95`](ef819ea) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Numeric Input] - Associate format options tooltip content with input field for assistive technologies - [#1945](#1945) [`e69ca3146`](e69ca31) Thanks [@nishasy](https://github.com/nishasy)! - Add global styles to reflect prod styling - [#1923](#1923) [`be8c06c75`](be8c06c) Thanks [@benchristel](https://github.com/benchristel)! - Internal: convert backgroundImage dimensions to numbers during parsing. - [#1934](#1934) [`129adebef`](129adeb) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Improve comments on some Perseus types - [#1924](#1924) [`2d89ef87d`](2d89ef8) Thanks [@benchristel](https://github.com/benchristel)! - Internal: add and pass regression tests for PerseusItem parser's handling of legacy data ## @khanacademy/[email protected] ### Patch Changes - [#1938](#1938) [`5e8d8468b`](5e8d846) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Type fixes - [#1937](#1937) [`3cdabf1a3`](3cdabf1) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Ensure links opening to style guide (Google Docs) set `rel="noreferrer"` - [#1946](#1946) [`f35512786`](f355127) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Remove debugging call in GraphSettings component - Updated dependencies \[[`3cdabf1a3`](3cdabf1), [`e21a3a39b`](e21a3a3), [`5e8d8468b`](5e8d846), [`1d2b4e7bf`](1d2b4e7), [`763a4ba38`](763a4ba), [`b8926e38a`](b8926e3), [`f35512786`](f355127), [`ef819ea95`](ef819ea), [`e69ca3146`](e69ca31), [`be8c06c75`](be8c06c), [`051c50cf7`](051c50c), [`129adebef`](129adeb), [`d05272661`](d052726), [`2d89ef87d`](2d89ef8), [`e3062b3c8`](e3062b3)]: - @khanacademy/[email protected] Author: khan-actions-bot Reviewers: mark-fitzgerald Required Reviewers: Approved By: mark-fitzgerald Checks: ⏭️ Publish npm snapshot, ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ gerald Pull Request URL: #1944
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
While running tests I saw warnings that React components rendered in a list were missing
keys. This lead me down a path of "is there an ESLint rule for this?" Turns out, there's a nice ruleset for the React ESLint plugin that includes a rule for ensuring JSX elements have akeywhen in a list.So, this PR enables the
react/recommendedESLint rules and fixes/suppresses things.Issue: "none"
Test plan:
yarn lintAlso, I opened the affected stories to double-check things.