test: extend cypress examples linting to javascript styles #1385
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.
Situation
ESLint is already used to lint JavaScript files (see eslint.config.mjs for configuration).
JavaScript source files that are part of the core action are already formatted using Prettier.
JavaScript source files in the examples directory are not yet linted for formatting.
ESLint offers a consolidated plugin @stylistic/eslint-plugin for Stylistic Formatting.
Change
Add linting using @stylistic/eslint-plugin using its recommended rules for the examples directory. Additionally use the following rules for alignment with .prettierrc.json. In the case of the comma-dangle rule, this is aligned instead with the settings in @cypress/eslint-plugin-dev since scaffolded Cypress config files are generated with dangling commas.
Use
npx eslint --fix
on examples to move to consistent JavaScript formatting.Add JavaScript related files in the examples directory to .prettierignore to avoid a management conflict between ESLint and Prettier. ESLint is responsible for formatting examples, not Prettier.
Verify
and confirm that no linting errors are reported.
and confirm that:
*.js
JavaScript files in the examples directory are being touched by Prettier