use a special warning message for @@ notation

tc39 · Jun 20, 2024 · 10d2cf9 · 10d2cf9
1 parent bc712bc
commit 10d2cf9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/src/lint/collect-header-diagnostics.ts b/src/lint/collect-header-diagnostics.ts
@@ -58,12 +58,15 @@ export function collectHeaderDiagnostics(
 
     if (!nameMatches) {
       const { line, column } = offsetToLineAndColumn(contents, 0);
+      let message = `expected operation to have a name like 'Example', 'Runtime Semantics: Foo', 'Example.prop', etc, but found ${JSON.stringify(name)}`;
+      let oldSymbolMatch = name.match(/@@([a-z][a-zA-Z]+)/);
+      if (oldSymbolMatch != null) {
+        message = `found use of unsupported legacy well-known Symbol notation ${oldSymbolMatch[0]}; use %Symbol.${oldSymbolMatch[1]}% instead`;
+      }
       report({
         type: 'contents',
         ruleId,
-        message: `expected operation to have a name like 'Example', 'Runtime Semantics: Foo', 'Example.prop', etc, but found ${JSON.stringify(
-          name,
-        )}`,
+        message,
         node: element,
         nodeRelativeLine: line,
         nodeRelativeColumn: column,

diff --git a/test/lint.js b/test/lint.js
@@ -299,7 +299,7 @@ describe('linting whole program', () => {
           ruleId: 'header-format',
           nodeType: 'h1',
           message:
-            "expected operation to have a name like 'Example', 'Runtime Semantics: Foo', 'Example.prop', etc, but found \"Example [ @@baz ] \"",
+            'found use of unsupported legacy well-known Symbol notation @@baz; use %Symbol.baz% instead',
         },
       );
     });