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

@mdjermanovic mdjermanovic commented Oct 5, 2020

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?

Copy link
Member

@btmills btmills left a comment

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


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

This comment has been minimized.

@btmills

btmills Oct 24, 2020
Member

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
12 checks passed
12 checks passed
Verify Files
Details
Test (ubuntu-latest, 14.x)
Details
Test (ubuntu-latest, 13.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 10.12.0)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message PR title follows commit message guidelines
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@btmills btmills deleted the hasoctalescape-89 branch Oct 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.