@herb-tools/linter 0.7.4 → 0.7.5

package/src/rules/erb-require-whitespace-inside-tags.ts

@@ -1,20 +1,12 @@
-import type { ParseResult, Token, Node } from "@herb-tools/core"
-import { isERBNode } from "@herb-tools/core";
 import { ParserRule } from "../types.js"
-import type { LintOffense, LintContext } from "../types.js"
 import { BaseRuleVisitor } from "./rule-utils.js"
 
-class RequireWhitespaceInsideTags extends BaseRuleVisitor {
+import type { LintOffense, LintContext } from "../types.js"
+import type { ParseResult, Token, ERBNode } from "@herb-tools/core"
 
-  visitChildNodes(node: Node): void {
-    this.checkWhitespace(node)
-    super.visitChildNodes(node)
-  }
+class RequireWhitespaceInsideTags extends BaseRuleVisitor {
 
-  private checkWhitespace(node: Node): void {
-    if (!isERBNode(node)) {
-      return
-    }
+  visitERBNode(node: ERBNode): void {
     const openTag = node.tag_opening
     const closeTag = node.tag_closing
     const content = node.content

package/src/rules/erb-right-trim.ts

@@ -0,0 +1,44 @@
+import { BaseRuleVisitor } from "./rule-utils.js"
+import { ParserRule } from "../types.js"
+import { isERBOutputNode } from "@herb-tools/core"
+
+import type { LintOffense, LintContext } from "../types.js"
+import type { ERBNode, ParseResult } from "@herb-tools/core"
+
+class ERBRightTrimVisitor extends BaseRuleVisitor {
+  visitERBNode(node: ERBNode): void {
+    if (!node.tag_closing) return
+
+    const trimClosing = node.tag_closing.value
+
+    if (trimClosing !== "=%>" && trimClosing !== "-%>") return
+
+    if (!isERBOutputNode(node)) {
+      this.addOffense(
+        `Right-trimming with \`${trimClosing}\` has no effect on non-output ERB tags. Use \`%>\` instead`,
+        node.tag_closing.location
+      )
+
+      return
+    }
+
+    if (trimClosing === "=%>") {
+      this.addOffense(
+        "Use `-%>` instead of `=%>` for right-trimming. The `=%>` syntax is obscure and not well-supported in most ERB engines",
+        node.tag_closing.location
+      )
+    }
+  }
+}
+
+export class ERBRightTrimRule extends ParserRule {
+  name = "erb-right-trim"
+
+  check(result: ParseResult, context?: Partial<LintContext>): LintOffense[] {
+    const visitor = new ERBRightTrimVisitor(this.name, context)
+
+    visitor.visit(result.value)
+
+    return visitor.offenses
+  }
+}

package/src/rules/index.ts

@@ -1,4 +1,5 @@
 export * from "./rule-utils.js"
+export * from "./erb-comment-syntax.js"
 export * from "./erb-no-empty-tags.js"
 export * from "./erb-no-output-control-flow.js"
 export * from "./erb-no-silent-tag-in-attribute-name.js"
@@ -30,3 +31,4 @@ export * from "./html-no-title-attribute.js"
 export * from "./html-tag-name-lowercase.js"
 export * from "./svg-tag-name-capitalization.js"
 export * from "./html-no-underscores-in-attribute-names.js"
+export * from "./erb-right-trim.js"

package/src/rules/rule-utils.ts

@@ -13,7 +13,7 @@ import {
 } from "@herb-tools/core"
 
 import type {
-  ERBNode,
+  ERBContentNode,
   HTMLAttributeNameNode,
   HTMLAttributeNode,
   HTMLAttributeValueNode,
@@ -300,7 +300,7 @@ export function getAttributeValue(attributeNode: HTMLAttributeNode): string | nu
   for (const child of valueNode.children) {
     switch (child.type) {
       case "AST_ERB_CONTENT_NODE": {
-        const erbNode = child as ERBNode
+        const erbNode = child as ERBContentNode
 
         if (erbNode.content) {
           result += `${erbNode.tag_opening?.value}${erbNode.content.value}${erbNode.tag_closing?.value}`