Chore: use ids for messages #12859

G-Rath · 2020-02-01T08:02:44Z

Prerequisites checklist

I have read the contributing guidelines.
The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Other: Helping to bring the codebase closer to standardisation.

What changes did you make? (Give an overview)

I went through the rules and added messages to a number of older rules.
I picked non-deprecated rules, and rules that could be simply changed (i.e. essentially just a prop change in context.report).

I also made a couple of changes to some of the data props, to better align them (i.e name instead of moduleName for no-restricted-modules).

There should be no functionality changes at all from this PR.
No new tests have been added, and no tests have been changed (apart from switching from hardcoded message to messageId + data).

I did change some tests to use messageId instead of message.

Is there anything you'd like reviewers to focus on?

Continues on from #12715

kaicataldo · 2020-02-04T01:42:49Z

lib/rules/no-underscore-dangle.js

@@ -204,7 +208,7 @@ module.exports = {
            if (typeof identifier !== "undefined" && enforceInMethodNames && isMethod && hasTrailingUnderscore(identifier)) {
                context.report({
                    node,
-                    message: "Unexpected dangling '_' in '{{identifier}}'.",


kaicataldo

Wow, thanks for working on this! This requires some dedication 😄 I have a few small comments, but otherwise this LGTM!

lib/rules/space-before-blocks.js

tests/lib/rules/no-octal-escape.js

tests/lib/rules/no-unused-vars.js

kaicataldo

Aside from resolving the discussion above, this LGTM! Thanks for doing this hero's work 💪

mdjermanovic

LGTM, thanks!

Non-blocking, it might be correct to have multiple messageId's in some rules (e.g., no-restricted-syntax) instead of a text in the code, at some point in the future.

G-Rath · 2020-02-04T23:12:01Z

it might be correct to have multiple messageId's in some rules (e.g., no-restricted-syntax) instead of a text in the code, at some point in the future.

Agreed - I noticed a couple of rules that I think could be made a bit cleaner by having them use seperate messages rather than being clever with placeholders, which I'll be aiming to improve on in my follow up PR :)

mdjermanovic · 2020-02-05T00:43:45Z

Agreed - I noticed a couple of rules that I think could be made a bit cleaner by having them use seperate messages rather than being clever with placeholders, which I'll be aiming to improve on in my follow up PR :)

That would be great 👍

kaicataldo · 2020-02-05T22:07:52Z

Thanks for working on this! I know this isn't the most fun thing to work on and really appreciate you took the time :)

G-Rath · 2020-02-05T22:12:31Z

No problem :)

I know this isn't the most fun thing to work on

To be honest, I actually enjoy this sort of work (most of the time) - theres something about tidying & updating code bases that I find rather cathartic 😄

* Chore: refactor `sort-vars` to use messageIds * Chore: refactor `space-infix-ops` to use messageIds * Chore: refactor `space-before-function-paren` to use messageIds * Chore: refactor `space-before-blocks` to use messageIds * Chore: refactor `spaced-comment` to use messageIds * Chore: refactor `sort-keys` to use messageIds * Chore: refactor `sort-imports` to use messageIds * Chore: refactor `semi-style` to use messageIds * Chore: refactor `semi-spacing` to use messageIds * Chore: refactor `rest-spread-spacing` to use messageIds * Chore: refactor `require-yield` to use messageIds * Chore: refactor `require-jsdoc` to use messageIds * Chore: refactor `radix` to use messageIds * Chore: refactor `quote-props` to use messageIds * Chore: refactor `prefer-template` to use messageIds * Chore: refactor `prefer-spread` to use messageIds * Chore: refactor `prefer-rest-params` to use messageIds * Chore: refactor `prefer-reflect` to use messageIds * Chore: refactor `prefer-promise-reject-errors` to use messageIds * Chore: refactor `prefer-destructuring` to use messageIds * Chore: refactor `prefer-arrow-callback` to use messageIds * Chore: refactor `padding-line-between-statements` to use messageIds * Chore: refactor `padded-blocks` to use messageIds * Chore: refactor `operator-linebreak` to use messageIds * Chore: refactor `one-var` to use messageIds * Chore: refactor `one-var-declaration-per-line` to use messageIds * Chore: refactor `object-shorthand` to use messageIds * Chore: refactor `object-property-newline` to use messageIds * Chore: refactor `object-curly-spacing` to use messageIds * Chore: refactor `object-curly-newline` to use messageIds * Chore: refactor `nonblock-statement-body-position` to use messageIds * Chore: refactor `no-with` to use messageIds * Chore: refactor `no-whitespace-before-property` to use messageIds * Chore: refactor `no-warning-comments` to use messageIds * Chore: refactor `no-var` to use messageIds * Chore: refactor `no-useless-return` to use messageIds * Chore: refactor `no-useless-rename` to use messageIds * Chore: refactor `no-useless-concat` to use messageIds * Chore: refactor `no-useless-computed-key` to use messageIds * Chore: refactor `no-useless-catch` to use messageIds * Chore: refactor `no-useless-call` to use messageIds * Chore: refactor `no-unused-vars` to use messageIds * Chore: refactor `no-unused-expressions` to use messageIds * Chore: refactor `no-unsafe-finally` to use messageIds * Chore: refactor `no-unreachable` to use messageIds * Chore: refactor `no-unneeded-ternary` to use messageIds * Chore: refactor `no-unmodified-loop-condition` to use messageIds * Chore: refactor `no-underscore-dangle` to use messageIds * Chore: refactor `no-undefined` to use messageIds * Chore: refactor `no-undef-init` to use messageIds * Chore: refactor `no-trailing-spaces` to use messageIds * Chore: refactor `no-this-before-super` to use messageIds * Chore: refactor `no-sync` to use messageIds * Chore: refactor `no-ternary` to use messageIds * Chore: refactor `no-template-curly-in-string` to use messageIds * Chore: refactor `no-tabs` to use messageIds * Chore: refactor `no-sparse-arrays` to use messageIds * Chore: refactor `no-spaced-func` to use messageIds * Chore: refactor `no-shadow-restricted-names` to use messageIds * Chore: refactor `no-sequences` to use messageIds * Chore: refactor `no-self-compare` to use messageIds * Chore: refactor `no-self-assign` to use messageIds * Chore: refactor `no-script-url` to use messageIds * Chore: refactor `no-return-await` to use messageIds * Chore: refactor `no-return-assign` to use messageIds * Chore: refactor `no-restricted-properties` to use messageIds * Chore: refactor `no-restricted-modules` to use messageIds * Chore: refactor `no-regex-spaces` to use messageIds * Chore: refactor `no-prototype-builtins` to use messageIds * Chore: refactor `no-proto` to use messageIds * Chore: refactor `no-process-exit` to use messageIds * Chore: refactor `no-process-env` to use messageIds * Chore: refactor `no-restricted-syntax` to use messageIds * Chore: refactor `no-native-reassign` to use messageIds * Chore: refactor `no-negated-in-lhs` to use messageIds * Chore: refactor `no-invalid-regexp` to use messageIds * Chore: refactor some tests to use `messageId`s * Chore: update `linter` tests to include `messageId` * Chore: correct message for `space-before-blocks` * Chore: use default values intead of `||`

eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Feb 1, 2020

G-Rath requested a review from kaicataldo February 1, 2020 08:02

kaicataldo reviewed Feb 4, 2020

View reviewed changes

kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion chore This change is not user-facing and removed triage An ESLint team member will look at this issue soon labels Feb 4, 2020

kaicataldo suggested changes Feb 4, 2020

View reviewed changes

lib/rules/space-before-blocks.js Outdated Show resolved Hide resolved

tests/lib/rules/no-octal-escape.js Show resolved Hide resolved

tests/lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

tests/lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

kaicataldo approved these changes Feb 4, 2020

View reviewed changes

mdjermanovic approved these changes Feb 4, 2020

View reviewed changes

G-Rath added 20 commits February 5, 2020 12:12

Chore: refactor spaced-comment to use messageIds

747de7f

Chore: refactor space-infix-ops to use messageIds

21a3e0e

Chore: refactor space-before-function-paren to use messageIds

35e85af

Chore: refactor space-before-blocks to use messageIds

f5a6783

Chore: refactor sort-vars to use messageIds

db21f0b

Chore: refactor sort-keys to use messageIds

bd8e597

Chore: refactor sort-imports to use messageIds

1a7a21c

Chore: refactor semi-style to use messageIds

81aa282

Chore: refactor semi-spacing to use messageIds

d8a2b07

Chore: refactor rest-spread-spacing to use messageIds

1628c9d

Chore: refactor require-yield to use messageIds

e6d816f

Chore: refactor require-jsdoc to use messageIds

1ebe6a0

Chore: refactor radix to use messageIds

f2d34d8

Chore: refactor quote-props to use messageIds

3a9ed16

Chore: refactor prefer-template to use messageIds

2a6e4f0

Chore: refactor prefer-spread to use messageIds

3ba7e3f

Chore: refactor prefer-rest-params to use messageIds

090fae4

Chore: refactor prefer-reflect to use messageIds

be7d77e

Chore: refactor prefer-promise-reject-errors to use messageIds

f5d563f

Chore: refactor prefer-destructuring to use messageIds

3aa590a

G-Rath added 20 commits February 5, 2020 12:19

Chore: refactor no-self-compare to use messageIds

bfdf00f

Chore: refactor no-self-assign to use messageIds

0fcc04a

Chore: refactor no-script-url to use messageIds

bfea4ba

Chore: refactor no-return-await to use messageIds

fd40ed8

Chore: refactor no-return-assign to use messageIds

f941ac7

Chore: refactor no-restricted-syntax to use messageIds

a28da66

Chore: refactor no-restricted-properties to use messageIds

2c0590c

Chore: refactor no-restricted-modules to use messageIds

7af8b74

Chore: refactor no-regex-spaces to use messageIds

b9029eb

Chore: refactor no-prototype-builtins to use messageIds

1d28d98

Chore: refactor no-proto to use messageIds

9403506

Chore: refactor no-process-exit to use messageIds

6aba6ec

Chore: refactor no-process-env to use messageIds

ce0f5ac

Chore: refactor no-native-reassign to use messageIds

10cd6cb

Chore: refactor no-negated-in-lhs to use messageIds

0e49a71

Chore: refactor no-invalid-regexp to use messageIds

5cc33c7

Chore: refactor some tests to use messageIds

9ac28fd

Chore: update linter tests to include messageId

ba42b59

Chore: correct message for space-before-blocks

ae289f1

Chore: use default values intead of ||

981a401

nzakas approved these changes Feb 5, 2020

View reviewed changes

kaicataldo merged commit 3734a66 into eslint:master Feb 5, 2020

kaicataldo changed the title ~~Use ids for messages~~ Chore: use ids for messages Feb 5, 2020

G-Rath deleted the use-ids-for-messages branch February 5, 2020 22:10

eslint-deprecated bot locked and limited conversation to collaborators Aug 5, 2020

eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: use ids for messages #12859

Chore: use ids for messages #12859

G-Rath commented Feb 1, 2020

kaicataldo Feb 4, 2020

kaicataldo left a comment

kaicataldo left a comment

mdjermanovic left a comment

G-Rath commented Feb 4, 2020

mdjermanovic commented Feb 5, 2020

kaicataldo commented Feb 5, 2020

G-Rath commented Feb 5, 2020

Chore: use ids for messages #12859

Chore: use ids for messages #12859

Conversation

G-Rath commented Feb 1, 2020

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

kaicataldo Feb 4, 2020

Choose a reason for hiding this comment

kaicataldo left a comment

Choose a reason for hiding this comment

kaicataldo left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

G-Rath commented Feb 4, 2020

mdjermanovic commented Feb 5, 2020

kaicataldo commented Feb 5, 2020

G-Rath commented Feb 5, 2020