Add linting using eslint with standard as the base #948
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
jonathangoulding
force-pushed
the
lint-add-standards-and-rules-eslint
branch
2 times, most recently
from
711d2da to
fbee471
Compare
jonathangoulding
force-pushed
the
lint-add-standards-and-rules-eslint
branch
2 times, most recently
from
6ee8a97 to
aaeb3f7
Compare
jonathangoulding
changed the title
jonathangoulding
added
the
housekeeping
Where possible we want to enforce the coding standards - https://github.com/DEFRA/water-abstraction-team/blob/main/coding_conventions.md This change introduces eslint using standard as a base (enforcing all the standard js rule). Switching to eslint allows us to extend standard js. A new command is added to only lint changed files. This will allow us to gradually change and enforce the new linting rules.
jonathangoulding
force-pushed
the
lint-add-standards-and-rules-eslint
branch
from
aaeb3f7 to
802e35a
Compare
…int' into lint-add-standards-and-rules-eslint
Cruikshanks
approved these changes
Apr 30, 2024
Cruikshanks
added a commit
that referenced
this pull request
May 8, 2024
DEFRA/water-abstraction-team#115 In [Add linting using eslint with standard as the base](#948) we switched from using [standard](https://www.npmjs.com/package/standard) directly for linting to using [ESlint](https://eslint.org/). This is all part of work we are doing to start codifying our conventions rather than writing them up for no one to read! 😁 As a start, we enabled the rule [max-len](https://eslint.org/docs/latest/rules/max-len) which **standard** doesn't have. That flagged some long text strings we have, and we don't want to break them up just for the sake of the linter. So, we went to check what options there are for the rule and found this > This rule was **deprecated** in ESLint v8.53.0. Please use the [corresponding rule](https://eslint.style/rules/js/max-len) in [@stylistic/eslint-plugin-js](https://eslint.style/packages/js). But it looks like ESLint has moved on a bit since we last used it and has chosen to [move some of its core stylistic based rules to a plugin](https://eslint.style/packages/js). This change switches to using the plugin to lint `max-len`. It also updates the config to exclude strings and template literals from the rule.
Cruikshanks
added a commit
that referenced
this pull request
May 8, 2024
DEFRA/water-abstraction-team#115 In [Add linting using eslint with standard as the base](#948) we switched from using [standard](https://www.npmjs.com/package/standard) directly for linting to using [ESlint](https://eslint.org/). This is all part of the work we are doing to start codifying our conventions rather than writing them up for no one to read! 😁 As a start, we enabled the rule [max-len](https://eslint.org/docs/latest/rules/max-len) which **standard** doesn't have. That flagged some long text strings we have, and we don't want to break them up just for the sake of the linter. So, we went to check what options there were for the rule and found this > This rule was **deprecated** in ESLint v8.53.0. Please use the [corresponding rule](https://eslint.style/rules/js/max-len) in [@stylistic/eslint-plugin-js](https://eslint.style/packages/js). But it looks like ESLint has moved on a bit since we last used it and has chosen to [move some of its core stylistic-based rules to a plugin](https://eslint.org/blog/2023/10/deprecating-formatting-rules/). This change switches to using the plugin to lint `max-len`.
Cruikshanks
added a commit
that referenced
this pull request
May 8, 2024
DEFRA/water-abstraction-team#115 In [Add linting using eslint with standard as the base](#948) we switched from using [standard](https://www.npmjs.com/package/standard) directly for linting to using [ESlint](https://eslint.org/). This is all part of the work we are doing to start codifying our conventions rather than writing them up for no one to read! 😁 We then went to make a config change but saw that we were using a deprecated core rule and instead needed to [use @stylistic/eslint-plugin-js for max-len rule](#989). So, we fixed that! 💪 But then we clocked ESLint was telling us our `.eslintrc.js` [config file format is deprecated](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated)! 😩 We instead should be using the `eslint.config.js` [flat file config](https://eslint.org/docs/latest/use/configure/configuration-files). So, before we start making changes to our config this change gets us using the latest supported format.
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.
DEFRA/water-abstraction-team#115
Add linting using eslint with standard as the base
Where possible we want to enforce the coding standards - https://github.com/DEFRA/water-abstraction-team/blob/main/coding_conventions.md
This change introduces eslint using standard as a base (enforcing all the standard js rule). Switching to eslint allows us to extend standard js.
A new command is added to only lint changed files. This will allow us to gradually change and enforce the new linting rules.