@herb-tools/linter 0.7.4 → 0.7.5

package/dist/index.cjs

@@ -682,6 +682,23 @@ class BaseSourceRuleVisitor {
     }
 }
 
+class ERBCommentSyntaxVisitor extends BaseRuleVisitor {
+    visitERBContentNode(node) {
+        if (node.content?.value.startsWith(" #")) {
+            const openingTag = node.tag_opening?.value;
+            this.addOffense(`Use \`<%#\` instead of \`${openingTag} #\`. Ruby comments immediately after ERB tags can cause parsing issues.`, node.location);
+        }
+    }
+}
+class ERBCommentSyntax extends ParserRule {
+    name = "erb-comment-syntax";
+    check(result, context) {
+        const visitor = new ERBCommentSyntaxVisitor(this.name, context);
+        visitor.visit(result.value);
+        return visitor.offenses;
+    }
+}
+
 class ERBNoEmptyTagsVisitor extends BaseRuleVisitor {
     visitERBContentNode(node) {
         this.visitChildNodes(node);
@@ -1533,14 +1550,7 @@ class ERBRequiresTrailingNewlineRule extends SourceRule {
 }
 
 class RequireWhitespaceInsideTags extends BaseRuleVisitor {
-    visitChildNodes(node) {
-        this.checkWhitespace(node);
-        super.visitChildNodes(node);
-    }
-    checkWhitespace(node) {
-        if (!core.isERBNode(node)) {
-            return;
-        }
+    visitERBNode(node) {
         const openTag = node.tag_opening;
         const closeTag = node.tag_closing;
         const content = node.content;
@@ -2649,7 +2659,33 @@ class HTMLNoUnderscoresInAttributeNamesRule extends ParserRule {
     }
 }
 
+class ERBRightTrimVisitor extends BaseRuleVisitor {
+    visitERBNode(node) {
+        if (!node.tag_closing)
+            return;
+        const trimClosing = node.tag_closing.value;
+        if (trimClosing !== "=%>" && trimClosing !== "-%>")
+            return;
+        if (!core.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);
+        }
+    }
+}
+class ERBRightTrimRule extends ParserRule {
+    name = "erb-right-trim";
+    check(result, context) {
+        const visitor = new ERBRightTrimVisitor(this.name, context);
+        visitor.visit(result.value);
+        return visitor.offenses;
+    }
+}
+
 const defaultRules = [
+    ERBCommentSyntax,
     ERBNoEmptyTagsRule,
     ERBNoOutputControlFlowRule,
     ERBNoSilentTagInAttributeNameRule,
@@ -2684,6 +2720,7 @@ const defaultRules = [
     ParserNoErrorsRule,
     SVGTagNameCapitalizationRule,
     HTMLNoUnderscoresInAttributeNamesRule,
+    ERBRightTrimRule,
 ];
 
 class Linter {
@@ -2911,11 +2948,13 @@ exports.BaseRuleVisitor = BaseRuleVisitor;
 exports.BaseSourceRuleVisitor = BaseSourceRuleVisitor;
 exports.ControlFlowTrackingVisitor = ControlFlowTrackingVisitor;
 exports.DEFAULT_LINT_CONTEXT = DEFAULT_LINT_CONTEXT;
+exports.ERBCommentSyntax = ERBCommentSyntax;
 exports.ERBNoEmptyTagsRule = ERBNoEmptyTagsRule;
 exports.ERBNoOutputControlFlowRule = ERBNoOutputControlFlowRule;
 exports.ERBNoSilentTagInAttributeNameRule = ERBNoSilentTagInAttributeNameRule;
 exports.ERBPreferImageTagHelperRule = ERBPreferImageTagHelperRule;
 exports.ERBRequiresTrailingNewlineRule = ERBRequiresTrailingNewlineRule;
+exports.ERBRightTrimRule = ERBRightTrimRule;
 exports.HEADING_TAGS = HEADING_TAGS;
 exports.HTMLAnchorRequireHrefRule = HTMLAnchorRequireHrefRule;
 exports.HTMLAriaLabelIsWellFormattedRule = HTMLAriaLabelIsWellFormattedRule;