Files
Josh Goldberg ✨andGitHub 36a353c719 chore: formatted files with Prettier via trunk fmt (#19355)
* chore: remove formatting-related lint rules internally

* chore: formatted files with Prettier via trunk fmt

* rm .prettierrc.json

* chore: correct comment directives and formatting

* Apply introduced fmt changes post-merge

* Also disable MD010 and MD030 in preparation for 19355

* Also disable MD013 in preparation for 19355

* Updated tools/update-rule-type-headers.js to print tabs

* Fix introduced issues from the main merge

* Manually format conf/*.json

* Switch conf/*.json files back to two spaces, per prettier config

* chore: empty commit to hopefully unblock GitHub
2025-03-19 11:18:08 -04:00

333 lines
8.8 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* @fileoverview Tests for dot-notation rule.
* @author Josh Perez
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/dot-notation"),
RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({
languageOptions: {
ecmaVersion: 5,
sourceType: "script",
},
});
/**
* Quote a string in "double quotes" because it’s painful
* with a double-quoted string literal
* @param {string} str The string to quote
* @returns {string} `"${str}"`
*/
function q(str) {
return `"${str}"`;
}
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
ruleTester.run("dot-notation", rule, {
valid: [
"a.b;",
"a.b.c;",
"a['12'];",
"a[b];",
"a[0];",
{ code: "a.b.c;", options: [{ allowKeywords: false }] },
{ code: "a.arguments;", options: [{ allowKeywords: false }] },
{ code: "a.let;", options: [{ allowKeywords: false }] },
{ code: "a.yield;", options: [{ allowKeywords: false }] },
{ code: "a.eval;", options: [{ allowKeywords: false }] },
{ code: "a[0];", options: [{ allowKeywords: false }] },
{ code: "a['while'];", options: [{ allowKeywords: false }] },
{ code: "a['true'];", options: [{ allowKeywords: false }] },
{ code: "a['null'];", options: [{ allowKeywords: false }] },
{ code: "a[true];", options: [{ allowKeywords: false }] },
{ code: "a[null];", options: [{ allowKeywords: false }] },
{ code: "a.true;", options: [{ allowKeywords: true }] },
{ code: "a.null;", options: [{ allowKeywords: true }] },
{
code: "a['snake_case'];",
options: [{ allowPattern: "^[a-z]+(_[a-z]+)+$" }],
},
{
code: "a['lots_of_snake_case'];",
options: [{ allowPattern: "^[a-z]+(_[a-z]+)+$" }],
},
{ code: "a[`time${range}`];", languageOptions: { ecmaVersion: 6 } },
{
code: "a[`while`];",
options: [{ allowKeywords: false }],
languageOptions: { ecmaVersion: 6 },
},
{ code: "a[`time range`];", languageOptions: { ecmaVersion: 6 } },
"a.true;",
"a.null;",
"a[undefined];",
"a[void 0];",
"a[b()];",
{ code: "a[/(?<zero>0)/];", languageOptions: { ecmaVersion: 2018 } },
{
code: "class C { foo() { this['#a'] } }",
languageOptions: { ecmaVersion: 2022 },
},
{
code: "class C { #in; foo() { this.#in; } }",
options: [{ allowKeywords: false }],
languageOptions: { ecmaVersion: 2022 },
},
],
invalid: [
{
code: "a.true;",
output: 'a["true"];',
options: [{ allowKeywords: false }],
errors: [{ messageId: "useBrackets", data: { key: "true" } }],
},
{
code: "a['true'];",
output: "a.true;",
errors: [{ messageId: "useDot", data: { key: q("true") } }],
},
{
code: "a[`time`];",
output: "a.time;",
languageOptions: { ecmaVersion: 6 },
errors: [{ messageId: "useDot", data: { key: "`time`" } }],
},
{
code: "a[null];",
output: "a.null;",
errors: [{ messageId: "useDot", data: { key: "null" } }],
},
{
code: "a[true];",
output: "a.true;",
errors: [{ messageId: "useDot", data: { key: "true" } }],
},
{
code: "a[false];",
output: "a.false;",
errors: [{ messageId: "useDot", data: { key: "false" } }],
},
{
code: "a['b'];",
output: "a.b;",
errors: [{ messageId: "useDot", data: { key: q("b") } }],
},
{
code: "a.b['c'];",
output: "a.b.c;",
errors: [{ messageId: "useDot", data: { key: q("c") } }],
},
{
code: "a['_dangle'];",
output: "a._dangle;",
options: [{ allowPattern: "^[a-z]+(_[a-z]+)+$" }],
errors: [{ messageId: "useDot", data: { key: q("_dangle") } }],
},
{
code: "a['SHOUT_CASE'];",
output: "a.SHOUT_CASE;",
options: [{ allowPattern: "^[a-z]+(_[a-z]+)+$" }],
errors: [{ messageId: "useDot", data: { key: q("SHOUT_CASE") } }],
},
{
code: "a\n" + " ['SHOUT_CASE'];",
output: "a\n" + " .SHOUT_CASE;",
errors: [
{
messageId: "useDot",
data: { key: q("SHOUT_CASE") },
line: 2,
column: 4,
},
],
},
{
code:
"getResource()\n" +
" .then(function(){})\n" +
' ["catch"](function(){})\n' +
" .then(function(){})\n" +
' ["catch"](function(){});',
output:
"getResource()\n" +
" .then(function(){})\n" +
" .catch(function(){})\n" +
" .then(function(){})\n" +
" .catch(function(){});",
errors: [
{
messageId: "useDot",
data: { key: q("catch") },
line: 3,
column: 6,
},
{
messageId: "useDot",
data: { key: q("catch") },
line: 5,
column: 6,
},
],
},
{
code: "foo\n" + " .while;",
output: "foo\n" + ' ["while"];',
options: [{ allowKeywords: false }],
errors: [{ messageId: "useBrackets", data: { key: "while" } }],
},
{
code: "foo[ /* comment */ 'bar' ]",
output: null, // Not fixed due to comment
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "foo[ 'bar' /* comment */ ]",
output: null, // Not fixed due to comment
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "foo[ 'bar' ];",
output: "foo.bar;",
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "foo. /* comment */ while",
output: null, // Not fixed due to comment
options: [{ allowKeywords: false }],
errors: [{ messageId: "useBrackets", data: { key: "while" } }],
},
{
code: "foo[('bar')]",
output: "foo.bar",
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "foo[(null)]",
output: "foo.null",
errors: [{ messageId: "useDot", data: { key: "null" } }],
},
{
code: "(foo)['bar']",
output: "(foo).bar",
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "1['toString']",
output: "1 .toString",
errors: [{ messageId: "useDot", data: { key: q("toString") } }],
},
{
code: "foo['bar']instanceof baz",
output: "foo.bar instanceof baz",
errors: [{ messageId: "useDot", data: { key: q("bar") } }],
},
{
code: "let.if()",
output: null, // `let["if"]()` is a syntax error because `let[` indicates a destructuring variable declaration
options: [{ allowKeywords: false }],
errors: [{ messageId: "useBrackets", data: { key: "if" } }],
},
{
code: "5['prop']",
output: "5 .prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "-5['prop']",
output: "-5 .prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "01['prop']",
output: "01.prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "01234567['prop']",
output: "01234567.prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "08['prop']",
output: "08 .prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "090['prop']",
output: "090 .prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "018['prop']",
output: "018 .prop",
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "5_000['prop']",
output: "5_000 .prop",
languageOptions: { ecmaVersion: 2021 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "5_000_00['prop']",
output: "5_000_00 .prop",
languageOptions: { ecmaVersion: 2021 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "5.000_000['prop']",
output: "5.000_000.prop",
languageOptions: { ecmaVersion: 2021 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "0b1010_1010['prop']",
output: "0b1010_1010.prop",
languageOptions: { ecmaVersion: 2021 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
// Optional chaining
{
code: "obj?.['prop']",
output: "obj?.prop",
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "0?.['prop']",
output: "0?.prop",
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "useDot", data: { key: q("prop") } }],
},
{
code: "obj?.true",
output: 'obj?.["true"]',
options: [{ allowKeywords: false }],
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "useBrackets", data: { key: "true" } }],
},
{
code: "let?.true",
output: 'let?.["true"]',
options: [{ allowKeywords: false }],
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "useBrackets", data: { key: "true" } }],
},
],
});