Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: autofix shouldn't produce template literals with \8 or \9 #13737

Merged
merged 2 commits into from Oct 24, 2020

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

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

[ ] Documentation update
[X] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

This PR fixes auto-fixing in two rules:

  • prefer-template
  • quotes (with option "backtick")

The example is with prefer-template.

Tell us about your environment

  • ESLint Version: v7.10.0
  • Node Version: v12.18.4
  • npm Version: v6.14.6

What parser (default, @babel/eslint-parser, @typescript-eslint/parser, etc.) are you using?

default

Please show your full configuration:

Configuration
module.exports = {
  parserOptions: {
    ecmaVersion: 2015
  }
};

What did you do? Please include the actual source code causing the issue.

Online Demo

/* eslint prefer-template: "error" */

foo + "\8"

What did you expect to happen?

1 error without autofix, similar to how it already works with octal escape sequences.

8 and 9 were never valid escape sequences or valid legacy octal escape sequences per the specification. However, they were not an explicitly disallowed language extension.

Since tc39/ecma262#2054, they are defined as NonOctalDecimalEscapeSequence and explicitly disallowed in untagged template literals:

TemplateCharacter must not be extended to include LegacyOctalEscapeSequence or NonOctalDecimalEscapeSequence as defined in B.1.2.

NonOctalDecimalEscapeSequence :: one of
89

What actually happened? Please include the actual, raw output from ESLint.

1 error and autofix to:

/* eslint prefer-template: "error" */

`${foo  }\8`

Error after the autofix:

  3:11  error  Parsing error: Invalid escape sequence in template string

(this is a parsing error as of Acorn v7.1.1)

What changes did you make? (Give an overview)

Fixed the pattern used by astUtils.hasOctalEscapeSequence to include \8 and \9.

This will prevent invalid autofixes in prefer-template and quotes rules in cases where the original string literal had at least one of \8 or \9. The rules will still report errors, but without fixing.

Also simplified the start of the pattern.

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

@mdjermanovic mdjermanovic added bug ESLint is working incorrectly rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion autofix This change is related to ESLint's autofixing capabilities labels Oct 5, 2020
Copy link
Member

@btmills btmills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for figuring out how to handle these safely.


if (!isStringLiteral) {
return false;
function hasOctalOrNonOctalDecimalEscapeSequence(node) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how you simplified these two helpers down to a single recursive function. It's easier to follow.

@btmills btmills merged commit 256f656 into master Oct 24, 2020
@btmills btmills deleted the hasoctalescape-89 branch October 24, 2020 00:26
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Apr 23, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Apr 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion autofix This change is related to ESLint's autofixing capabilities bug ESLint is working incorrectly rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants