fix: switch to getCommentsBefore over getJSDocComment (#160)

43081j · web-flow · commit 28eac22093a4 · 2026-02-09T12:22:21.000Z
ESLint 10.x removes this method and oxlint never had it. We only do
substring-matches anyway so can just use raw comments.
diff --git a/src/rules/attach-shadow-constructor.ts b/src/rules/attach-shadow-constructor.ts
@@ -39,7 +39,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/define-tag-after-class-definition.ts b/src/rules/define-tag-after-class-definition.ts
@@ -48,7 +48,7 @@ const rule: Rule.RuleModule = {
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
         if (
-          isCustomElement(context, node, source.getJSDocComment(node)) &&
+          isCustomElement(context, node, source.getCommentsBefore(node)) &&
           node.id?.type === 'Identifier'
         ) {
           seenClasses.add(node);
diff --git a/src/rules/expose-class-on-global.ts b/src/rules/expose-class-on-global.ts
@@ -46,7 +46,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           seenClasses.add(node);
         }
       },
diff --git a/src/rules/file-name-matches-element.ts b/src/rules/file-name-matches-element.ts
@@ -133,7 +133,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (!isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (!isCustomElement(context, node, source.getCommentsBefore(node))) {
           return;
         }
 
diff --git a/src/rules/guard-super-call.ts b/src/rules/guard-super-call.ts
@@ -118,7 +118,7 @@ const rule: Rule.RuleModule = {
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
         if (
-          isCustomElement(context, node, source.getJSDocComment(node)) &&
+          isCustomElement(context, node, source.getCommentsBefore(node)) &&
           !isNativeCustomElement(node)
         ) {
           insideNonNativeElement = true;
diff --git a/src/rules/max-elements-per-file.ts b/src/rules/max-elements-per-file.ts
@@ -52,7 +52,7 @@ const rule: Rule.RuleModule = {
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
         if (
-          isCustomElement(context, node, source.getJSDocComment(node)) &&
+          isCustomElement(context, node, source.getCommentsBefore(node)) &&
           ++elementCount > maxElements
         ) {
           context.report({
diff --git a/src/rules/no-child-traversal-in-attributechangedcallback.ts b/src/rules/no-child-traversal-in-attributechangedcallback.ts
@@ -52,7 +52,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-child-traversal-in-connectedcallback.ts b/src/rules/no-child-traversal-in-connectedcallback.ts
@@ -97,7 +97,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-constructor-attributes.ts b/src/rules/no-constructor-attributes.ts
@@ -123,7 +123,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-constructor-params.ts b/src/rules/no-constructor-params.ts
@@ -51,7 +51,7 @@ const rule: Rule.RuleModule = {
       [`ClassExpression > ${constructorQuery}`]: visitConstructor,
       [`ClassDeclaration > ${constructorQuery}`]: visitConstructor,
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-constructor.ts b/src/rules/no-constructor.ts
@@ -40,7 +40,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-customized-built-in-elements.ts b/src/rules/no-customized-built-in-elements.ts
@@ -41,7 +41,7 @@ const rule: Rule.RuleModule = {
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
         if (
-          isCustomElement(context, node, source.getJSDocComment(node)) &&
+          isCustomElement(context, node, source.getCommentsBefore(node)) &&
           node.superClass &&
           node.superClass.type === 'Identifier' &&
           node.superClass.name !== 'HTMLElement' &&
diff --git a/src/rules/no-exports-with-element.ts b/src/rules/no-exports-with-element.ts
@@ -34,7 +34,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           hasElement = true;
           seenClasses.add(node);
         }
diff --git a/src/rules/no-invalid-extends.ts b/src/rules/no-invalid-extends.ts
@@ -103,7 +103,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassExpression,ClassDeclaration': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           elementClasses.add(node);
         }
       },
diff --git a/src/rules/no-method-prefixed-with-on.ts b/src/rules/no-method-prefixed-with-on.ts
@@ -41,7 +41,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-self-class.ts b/src/rules/no-self-class.ts
@@ -83,7 +83,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/rules/no-typos.ts b/src/rules/no-typos.ts
@@ -47,7 +47,7 @@ const rule: Rule.RuleModule = {
 
     return {
       'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {
-        if (isCustomElement(context, node, source.getJSDocComment(node))) {
+        if (isCustomElement(context, node, source.getCommentsBefore(node))) {
           insideElement = true;
         }
       },
diff --git a/src/test/util_test.ts b/src/test/util_test.ts
@@ -25,8 +25,8 @@ describe('util', () => {
   describe('isCustomElement', () => {
     it('should parse direct sub classes of HTMLElement', () => {
       const doc = parseExpr<ESTree.Class>(`class Foo extends HTMLElement {}`);
-      util.isCustomElement(mockContext, doc); // Primes the cache
-      expect(util.isCustomElement(mockContext, doc)).to.equal(true);
+      util.isCustomElement(mockContext, doc, []); // Primes the cache
+      expect(util.isCustomElement(mockContext, doc, [])).to.equal(true);
     });
 
     it('should parse direct sub classes of custom bases', () => {
@@ -36,7 +36,7 @@ describe('util', () => {
           elementBaseClasses: ['MyBase']
         }
       };
-      expect(util.isCustomElement(mockContext, doc)).to.equal(true);
+      expect(util.isCustomElement(mockContext, doc, [])).to.equal(true);
     });
 
     it('should parse annotated classes', () => {
@@ -51,15 +51,15 @@ describe('util', () => {
       };
       const doc = parseExpr<ESTree.Class>(`/** @customElement **/
         class Foo extends Bar {}`);
-      expect(util.isCustomElement(mockContext, doc, jsdoc)).to.equal(true);
+      expect(util.isCustomElement(mockContext, doc, [jsdoc])).to.equal(true);
     });
 
     it('should be false for normal classes', () => {
       let doc = parseExpr<ESTree.Class>(`class Foo extends Bar {}`);
-      expect(util.isCustomElement(mockContext, doc)).to.equal(false);
+      expect(util.isCustomElement(mockContext, doc, [])).to.equal(false);
 
       doc = parseExpr<ESTree.Class>(`class Foo {}`);
-      expect(util.isCustomElement(mockContext, doc)).to.equal(false);
+      expect(util.isCustomElement(mockContext, doc, [])).to.equal(false);
     });
   });
 
diff --git a/src/util.ts b/src/util.ts
@@ -78,13 +78,13 @@ export function getElementBaseClasses(context: Rule.RuleContext): string[] {
  *
  * @param {Rule.RuleContext} context ESLint rule context
  * @param {ESTree.Class} node Node to test
- * @param {AST.Token=} jsdoc JSDoc to parse
+ * @param {ESTree.Comment[]} comments Comments before the node
  * @return {boolean}
  */
 export function isCustomElement(
   context: Rule.RuleContext,
   node: ESTree.Class,
-  jsdoc?: ESTree.Comment | null
+  comments: ESTree.Comment[]
 ): boolean {
   const asDecorated = node as WithDecorators<ESTree.Node>;
   const customElementBases = getElementBaseClasses(context);
@@ -102,7 +102,7 @@ export function isCustomElement(
     return true;
   }
 
-  if (jsdoc?.value.includes('@customElement')) {
+  if (comments.some((c) => c.value.includes('@customElement'))) {
     customElementsCache.set(node, true);
     return true;
   }

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ const rule: Rule.RuleModule = {`
`39`	`39`
`40`	`40`	`return {`
`41`	`41`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`42`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`42`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`43`	`43`	`insideElement = true;`
`44`	`44`	`}`
`45`	`45`	`},`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ const rule: Rule.RuleModule = {`
`46`	`46`
`47`	`47`	`return {`
`48`	`48`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`49`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`49`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`50`	`50`	`seenClasses.add(node);`
`51`	`51`	`}`
`52`	`52`	`},`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ const rule: Rule.RuleModule = {`
`133`	`133`
`134`	`134`	`return {`
`135`	`135`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`136`		`- if (!isCustomElement(context, node, source.getJSDocComment(node))) {`
	`136`	`+ if (!isCustomElement(context, node, source.getCommentsBefore(node))) {`
`137`	`137`	`return;`
`138`	`138`	`}`
`139`	`139`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ const rule: Rule.RuleModule = {`
`52`	`52`
`53`	`53`	`return {`
`54`	`54`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`55`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`55`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`56`	`56`	`insideElement = true;`
`57`	`57`	`}`
`58`	`58`	`},`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ const rule: Rule.RuleModule = {`
`97`	`97`
`98`	`98`	`return {`
`99`	`99`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`100`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`100`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`101`	`101`	`insideElement = true;`
`102`	`102`	`}`
`103`	`103`	`},`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ const rule: Rule.RuleModule = {`
`123`	`123`
`124`	`124`	`return {`
`125`	`125`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`126`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`126`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`127`	`127`	`insideElement = true;`
`128`	`128`	`}`
`129`	`129`	`},`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ const rule: Rule.RuleModule = {`
`51`	`51`	[`ClassExpression > ${constructorQuery}`]: visitConstructor,
`52`	`52`	[`ClassDeclaration > ${constructorQuery}`]: visitConstructor,
`53`	`53`	`'ClassDeclaration,ClassExpression': (node: ESTree.Class): void => {`
`54`		`- if (isCustomElement(context, node, source.getJSDocComment(node))) {`
	`54`	`+ if (isCustomElement(context, node, source.getCommentsBefore(node))) {`
`55`	`55`	`insideElement = true;`
`56`	`56`	`}`
`57`	`57`	`},`