Code Quality: Remove no-undef eslint rule
#577
Merged
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
t-hamano
commented
Apr 21, 2024
| @@ -28,6 +29,8 @@ export const ThemeMetadataEditorModal = ( { onRequestClose } ) => { | |||
| recommended_plugins: '', | |||
| } ); | |||
|
|
|||
| const { createErrorNotice } = useDispatch( noticesStore ); | |||
There was a problem hiding this comment.
This is one example of preventing a critical error. If this code is missing and the theme metadata update fails, an error like the one below will occur and no message will be displayed.
Uncaught (in promise) ReferenceError: createErrorNotice is not defined
|
Thank you. I have followed the reasoning back when the linting rules were added and I see how this is a better (and important fix). Everything continues to build and run as expected following this change. 🚢 |
pbking
approved these changes
Apr 23, 2024
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.
This PR removes the disabled
no-undefrule in the eslint rules and fixes the lint errors that occurred with it.Disabling the
no-undefrule globally is dangerous. This is because you can use variables and functions that have not been previously defined or imported, making it easier to overlook critical errors.In fact, there were already variables and functions that were not defined. The reason these didn't cause an error was probably because the variable or function happened to be defined in another JavaScript.
Instead of removing the
no-undefrule, I added the following configuration to the eslint:globals: Suppresses warning errors that occur in the two constructorsFontFaceandFileReader.overrides: To preventitanddescribefrom causing warning errors in unit tests, add unit test rules to the javascript files in thetestdirectory.Testing Instructions
This PR does not add or change any functionality, so it should work correctly as before, but please test the following:
<Test />that doesn't exist. When you runnpm run lint:jsyou should get the following error:error 'Test' is not defined react/jsx-no-undeftest()that is not predefined. trunk does not warn this statement as an error, but when you runnpm run :linton this PR, you should get the following error:error 'test' is not defined no-undef