@herb-tools/language-server 0.9.0 → 0.9.1

package/dist/types/diagnostics.d.ts

@@ -1,7 +1,5 @@
 import { TextDocument } from "vscode-languageserver-textdocument";
-import { Connection, Diagnostic } from "vscode-languageserver/node";
-import { Visitor } from "@herb-tools/core";
-import type { ERBCaseNode, ERBCaseMatchNode, ERBIfNode, ERBElseNode, ERBUnlessNode, ERBForNode, ERBWhileNode, ERBUntilNode, ERBWhenNode, ERBBeginNode, ERBRescueNode, ERBEnsureNode, ERBBlockNode, ERBInNode } from "@herb-tools/core";
+import { Connection } from "vscode-languageserver/node";
 import { ParserService } from "./parser_service";
 import { LinterService } from "./linter_service";
 import { DocumentService } from "./document_service";
@@ -15,38 +13,7 @@ export declare class Diagnostics {
     private diagnostics;
     constructor(connection: Connection, documentService: DocumentService, parserService: ParserService, linterService: LinterService, configService: ConfigService);
     validate(textDocument: TextDocument): Promise<void>;
-    private getUnreachableCodeDiagnostics;
     refreshDocument(document: TextDocument): Promise<void>;
     refreshAllDocuments(): Promise<void>;
     private sendDiagnosticsFor;
 }
-export declare class UnreachableCodeCollector extends Visitor {
-    diagnostics: Diagnostic[];
-    private processedIfNodes;
-    private processedElseNodes;
-    visitERBCaseNode(node: ERBCaseNode): void;
-    visitERBCaseMatchNode(node: ERBCaseMatchNode): void;
-    visitERBIfNode(node: ERBIfNode): void;
-    visitERBElseNode(node: ERBElseNode): void;
-    visitERBUnlessNode(node: ERBUnlessNode): void;
-    visitERBForNode(node: ERBForNode): void;
-    visitERBWhileNode(node: ERBWhileNode): void;
-    visitERBUntilNode(node: ERBUntilNode): void;
-    visitERBWhenNode(node: ERBWhenNode): void;
-    visitERBBeginNode(node: ERBBeginNode): void;
-    visitERBRescueNode(node: ERBRescueNode): void;
-    visitERBEnsureNode(node: ERBEnsureNode): void;
-    visitERBBlockNode(node: ERBBlockNode): void;
-    visitERBInNode(node: ERBInNode): void;
-    private checkUnreachableChildren;
-    private checkEmptyStatements;
-    private checkEmptyStatementsWithEndLocation;
-    private addDiagnostic;
-    private statementsHaveContent;
-    private checkAndMarkElseClause;
-    private markIfChainAsProcessed;
-    private markElseNodesInIfChain;
-    private traverseSubsequentNodes;
-    private checkIfChainParts;
-    private isEntireIfChainEmpty;
-}

package/dist/types/utils.d.ts

@@ -1,6 +1,8 @@
-import { DiagnosticSeverity } from "vscode-languageserver/node";
+import { DiagnosticSeverity, DiagnosticTag } from "vscode-languageserver/node";
 import type { LintSeverity } from "@herb-tools/linter";
+import type { DiagnosticSeverity as HerbDiagnosticSeverity, DiagnosticTag as HerbDiagnosticTag } from "@herb-tools/core";
 export declare function camelize(value: string): string;
 export declare function dasherize(value: string): string;
 export declare function capitalize(value: string): string;
-export declare function lintToDignosticSeverity(severity: LintSeverity): DiagnosticSeverity;
+export declare function lintToDignosticSeverity(severity: LintSeverity | HerbDiagnosticSeverity): DiagnosticSeverity;
+export declare function lintToDignosticTags(tags?: HerbDiagnosticTag[]): DiagnosticTag[];

package/dist/utils.js

@@ -1,4 +1,4 @@
-import { DiagnosticSeverity } from "vscode-languageserver/node";
+import { DiagnosticSeverity, DiagnosticTag } from "vscode-languageserver/node";
 export function camelize(value) {
     return value.replace(/(?:[_-])([a-z0-9])/g, (_, char) => char.toUpperCase());
 }
@@ -16,4 +16,15 @@ export function lintToDignosticSeverity(severity) {
         case "hint": return DiagnosticSeverity.Hint;
     }
 }
+export function lintToDignosticTags(tags) {
+    if (!tags)
+        return [];
+    return tags.flatMap(tag => {
+        switch (tag) {
+            case "unnecessary": return [DiagnosticTag.Unnecessary];
+            case "deprecated": return [DiagnosticTag.Deprecated];
+            default: return [];
+        }
+    });
+}
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAG/D,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAO,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;AAC9E,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACzE,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAAsB;IAC5D,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO,CAAC,CAAC,OAAO,kBAAkB,CAAC,KAAK,CAAA;QAC7C,KAAK,SAAS,CAAC,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAA;QACjD,KAAK,MAAM,CAAC,CAAC,OAAO,kBAAkB,CAAC,WAAW,CAAA;QAClD,KAAK,MAAM,CAAC,CAAC,OAAO,kBAAkB,CAAC,IAAI,CAAA;IAC7C,CAAC;AACH,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAI9E,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAO,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;AAC9E,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACzE,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACvD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAA+C;IACrF,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO,CAAC,CAAC,OAAO,kBAAkB,CAAC,KAAK,CAAA;QAC7C,KAAK,SAAS,CAAC,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAA;QACjD,KAAK,MAAM,CAAC,CAAC,OAAO,kBAAkB,CAAC,WAAW,CAAA;QAClD,KAAK,MAAM,CAAC,CAAC,OAAO,kBAAkB,CAAC,IAAI,CAAA;IAC7C,CAAC;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAA0B;IAC5D,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAA;IAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACxB,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,aAAa,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;YACtD,KAAK,YAAY,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;YACpD,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;QACpB,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@herb-tools/language-server",
   "description": "Herb HTML+ERB Language Tools and Language Server Protocol integration.",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "author": "Marco Roth",
   "license": "MIT",
   "engines": {
@@ -45,12 +45,12 @@
     "dist/"
   ],
   "dependencies": {
-    "@herb-tools/config": "0.9.0",
-    "@herb-tools/formatter": "0.9.0",
-    "@herb-tools/linter": "0.9.0",
-    "@herb-tools/node-wasm": "0.9.0",
-    "@herb-tools/printer": "0.9.0",
-    "@herb-tools/rewriter": "0.9.0",
+    "@herb-tools/config": "0.9.1",
+    "@herb-tools/formatter": "0.9.1",
+    "@herb-tools/linter": "0.9.1",
+    "@herb-tools/node-wasm": "0.9.1",
+    "@herb-tools/printer": "0.9.1",
+    "@herb-tools/rewriter": "0.9.1",
     "dedent": "^1.7.0",
     "vscode-languageserver": "^9.0.1",
     "vscode-languageserver-textdocument": "^1.0.12"

package/src/diagnostics.ts

@@ -1,33 +1,10 @@
 import { TextDocument } from "vscode-languageserver-textdocument"
-import { Connection, Diagnostic, DiagnosticSeverity, DiagnosticTag } from "vscode-languageserver/node"
-import { Visitor } from "@herb-tools/core"
-
-import type {
-  Node,
-  SerializedLocation,
-  ERBCaseNode,
-  ERBCaseMatchNode,
-  ERBIfNode,
-  ERBElseNode,
-  ERBUnlessNode,
-  ERBForNode,
-  ERBWhileNode,
-  ERBUntilNode,
-  ERBWhenNode,
-  ERBBeginNode,
-  ERBRescueNode,
-  ERBEnsureNode,
-  ERBBlockNode,
-  ERBInNode,
-} from "@herb-tools/core"
-
-import { isHTMLTextNode, isERBIfNode, isERBElseNode } from "@herb-tools/core"
+import { Connection, Diagnostic } from "vscode-languageserver/node"
 
 import { ParserService } from "./parser_service"
 import { LinterService } from "./linter_service"
 import { DocumentService } from "./document_service"
 import { ConfigService } from "./config_service"
-import { lspRangeFromLocation } from "./range_utils"
 
 export class Diagnostics {
   private readonly connection: Connection
@@ -59,12 +36,10 @@ export class Diagnostics {
     } else {
       const parseResult = this.parserService.parseDocument(textDocument)
       const lintResult = await this.linterService.lintDocument(textDocument)
-      const unreachableCodeDiagnostics = this.getUnreachableCodeDiagnostics(parseResult.document)
 
       allDiagnostics = [
         ...parseResult.diagnostics,
         ...lintResult.diagnostics,
-        ...unreachableCodeDiagnostics,
       ]
     }
 
@@ -72,12 +47,6 @@ export class Diagnostics {
     this.sendDiagnosticsFor(textDocument)
   }
 
-  private getUnreachableCodeDiagnostics(document: Node): Diagnostic[] {
-    const collector = new UnreachableCodeCollector()
-    collector.visit(document)
-    return collector.diagnostics
-  }
-
   async refreshDocument(document: TextDocument) {
     await this.validate(document)
   }
@@ -98,262 +67,3 @@ export class Diagnostics {
     this.diagnostics.delete(textDocument)
   }
 }
-
-export class UnreachableCodeCollector extends Visitor {
-  diagnostics: Diagnostic[] = []
-  private processedIfNodes: Set<ERBIfNode> = new Set()
-  private processedElseNodes: Set<ERBElseNode> = new Set()
-
-  visitERBCaseNode(node: ERBCaseNode): void {
-    this.checkUnreachableChildren(node.children)
-    this.checkAndMarkElseClause(node.else_clause)
-    this.visitChildNodes(node)
-  }
-
-  visitERBCaseMatchNode(node: ERBCaseMatchNode): void {
-    this.checkUnreachableChildren(node.children)
-    this.checkAndMarkElseClause(node.else_clause)
-    this.visitChildNodes(node)
-  }
-
-  visitERBIfNode(node: ERBIfNode): void {
-    if (this.processedIfNodes.has(node)) {
-      return
-    }
-
-    this.markIfChainAsProcessed(node)
-
-    this.markElseNodesInIfChain(node)
-
-    const entireChainEmpty = this.isEntireIfChainEmpty(node)
-
-    if (entireChainEmpty) {
-      this.checkEmptyStatements(node, node.statements, "if")
-    } else {
-      this.checkIfChainParts(node)
-    }
-
-    this.visitChildNodes(node)
-  }
-
-  visitERBElseNode(node: ERBElseNode): void {
-    if (this.processedElseNodes.has(node)) {
-      this.visitChildNodes(node)
-      return
-    }
-
-    this.checkEmptyStatements(node, node.statements, "else")
-    this.visitChildNodes(node)
-  }
-
-  visitERBUnlessNode(node: ERBUnlessNode): void {
-    const unlessHasContent = this.statementsHaveContent(node.statements)
-    const elseHasContent = node.else_clause && this.statementsHaveContent(node.else_clause.statements)
-
-    if (node.else_clause) {
-      this.processedElseNodes.add(node.else_clause)
-    }
-
-    const entireBlockEmpty = !unlessHasContent && !elseHasContent
-
-    if (entireBlockEmpty) {
-      this.checkEmptyStatements(node, node.statements, "unless")
-    } else {
-      if (!unlessHasContent) {
-        this.checkEmptyStatementsWithEndLocation(node, node.statements, "unless", node.else_clause)
-      }
-
-      if (node.else_clause && !elseHasContent) {
-        this.checkEmptyStatements(node.else_clause, node.else_clause.statements, "else")
-      }
-    }
-
-    this.visitChildNodes(node)
-  }
-
-  visitERBForNode(node: ERBForNode): void {
-    this.checkEmptyStatements(node, node.statements, "for")
-    this.visitChildNodes(node)
-  }
-
-  visitERBWhileNode(node: ERBWhileNode): void {
-    this.checkEmptyStatements(node, node.statements, "while")
-    this.visitChildNodes(node)
-  }
-
-  visitERBUntilNode(node: ERBUntilNode): void {
-    this.checkEmptyStatements(node, node.statements, "until")
-    this.visitChildNodes(node)
-  }
-
-  visitERBWhenNode(node: ERBWhenNode): void {
-    if (!node.then_keyword) {
-      this.checkEmptyStatements(node, node.statements, "when")
-    }
-
-    this.visitChildNodes(node)
-  }
-
-  visitERBBeginNode(node: ERBBeginNode): void {
-    this.checkEmptyStatements(node, node.statements, "begin")
-    this.visitChildNodes(node)
-  }
-
-  visitERBRescueNode(node: ERBRescueNode): void {
-    this.checkEmptyStatements(node, node.statements, "rescue")
-    this.visitChildNodes(node)
-  }
-
-  visitERBEnsureNode(node: ERBEnsureNode): void {
-    this.checkEmptyStatements(node, node.statements, "ensure")
-    this.visitChildNodes(node)
-  }
-
-  visitERBBlockNode(node: ERBBlockNode): void {
-    this.checkEmptyStatements(node, node.body, "block")
-    this.visitChildNodes(node)
-  }
-
-  visitERBInNode(node: ERBInNode): void {
-    if (!node.then_keyword) {
-      this.checkEmptyStatements(node, node.statements, "in")
-    }
-
-    this.visitChildNodes(node)
-  }
-
-  private checkUnreachableChildren(children: Node[]): void {
-    for (const child of children) {
-      if (isHTMLTextNode(child) && child.content.trim() === "") {
-        continue
-      }
-
-      this.addDiagnostic(
-        child.location,
-        "Unreachable code: content between case and when/in is never executed"
-      )
-    }
-  }
-
-  private checkEmptyStatements(node: Node, statements: Node[], blockType: string): void {
-    this.checkEmptyStatementsWithEndLocation(node, statements, blockType, null)
-  }
-
-  private checkEmptyStatementsWithEndLocation(node: Node, statements: Node[], blockType: string, subsequentNode: Node | null): void {
-    if (this.statementsHaveContent(statements)) {
-      return
-    }
-
-    const startLocation = node.location.start
-    const endLocation = subsequentNode
-      ? subsequentNode.location.start
-      : node.location.end
-
-    this.addDiagnostic(
-      { start: startLocation, end: endLocation },
-      `Empty ${blockType} block: this control flow statement has no content`
-    )
-  }
-
-  private addDiagnostic(location: SerializedLocation, message: string): void {
-    const diagnostic: Diagnostic = {
-      range: lspRangeFromLocation(location),
-      message,
-      severity: DiagnosticSeverity.Hint,
-      tags: [DiagnosticTag.Unnecessary],
-      source: "Herb Language Server"
-    }
-
-    this.diagnostics.push(diagnostic)
-  }
-
-  private statementsHaveContent(statements: Node[]): boolean {
-    return statements.some(statement => {
-      if (isHTMLTextNode(statement)) {
-        return statement.content.trim() !== ""
-      }
-
-      return true
-    })
-  }
-
-  private checkAndMarkElseClause(elseClause: ERBElseNode | null): void {
-    if (!elseClause) {
-      return
-    }
-
-    this.processedElseNodes.add(elseClause)
-    if (!this.statementsHaveContent(elseClause.statements)) {
-      this.checkEmptyStatements(elseClause, elseClause.statements, "else")
-    }
-  }
-
-  private markIfChainAsProcessed(node: ERBIfNode): void {
-    this.processedIfNodes.add(node)
-    this.traverseSubsequentNodes(node.subsequent, (current) => {
-      if (isERBIfNode(current)) {
-        this.processedIfNodes.add(current)
-      }
-    })
-  }
-
-  private markElseNodesInIfChain(node: ERBIfNode): void {
-    this.traverseSubsequentNodes(node.subsequent, (current) => {
-      if (isERBElseNode(current)) {
-        this.processedElseNodes.add(current)
-      }
-    })
-  }
-
-  private traverseSubsequentNodes(startNode: Node | null, callback: (node: ERBIfNode | ERBElseNode) => void): void {
-    let current: Node | null = startNode
-    while (current) {
-      if (isERBIfNode(current)) {
-        callback(current)
-        current = current.subsequent
-      } else if (isERBElseNode(current)) {
-        callback(current)
-        break
-      } else {
-        break
-      }
-    }
-  }
-
-  private checkIfChainParts(node: ERBIfNode): void {
-    if (!this.statementsHaveContent(node.statements)) {
-      this.checkEmptyStatementsWithEndLocation(node, node.statements, "if", node.subsequent)
-    }
-
-    this.traverseSubsequentNodes(node.subsequent, (current) => {
-      if (this.statementsHaveContent(current.statements)) {
-        return
-      }
-
-      const blockType = isERBIfNode(current) ? 'elsif' : 'else'
-      const nextSubsequent = isERBIfNode(current) ? current.subsequent : null
-
-      if (nextSubsequent) {
-        this.checkEmptyStatementsWithEndLocation(current, current.statements, blockType, nextSubsequent)
-      } else {
-        this.checkEmptyStatements(current, current.statements, blockType)
-      }
-    })
-  }
-
-  private isEntireIfChainEmpty(node: ERBIfNode): boolean {
-    if (this.statementsHaveContent(node.statements)) {
-      return false
-    }
-
-    let hasContent = false
-    this.traverseSubsequentNodes(node.subsequent, (current) => {
-      if (this.statementsHaveContent(current.statements)) {
-        hasContent = true
-      }
-    })
-
-    return !hasContent
-  }
-
-}

package/src/linter_service.ts

@@ -8,7 +8,7 @@ import { Config } from "@herb-tools/config"
 
 import { Settings } from "./settings"
 import { Project } from "./project"
-import { lintToDignosticSeverity } from "./utils"
+import { lintToDignosticSeverity, lintToDignosticTags } from "./utils"
 import { lspRangeFromLocation } from "./range_utils"
 
 const OPEN_CONFIG_ACTION = 'Open .herb.yml'
@@ -179,7 +179,7 @@ export class LinterService {
           : ruleDocumentationUrl(offense.rule)
       }
 
-      return {
+      const diagnostic: Diagnostic = {
         source: this.source,
         severity: lintToDignosticSeverity(offense.severity),
         range,
@@ -188,6 +188,14 @@ export class LinterService {
         data: { rule: offense.rule },
         codeDescription
       }
+
+      const tags = lintToDignosticTags(offense.tags)
+
+      if (tags.length > 0) {
+        diagnostic.tags = tags
+      }
+
+      return diagnostic
     })
 
     return { diagnostics }

package/src/server.ts

@@ -186,6 +186,9 @@ export class Server {
 
       if (!document) return []
 
+      const parseResult = this.service.parserService.parseDocument(document)
+      if (parseResult.diagnostics.length > 0) return []
+
       const diagnostics = params.context.diagnostics
       const documentText = document.getText()
 

package/src/utils.ts

@@ -1,5 +1,6 @@
-import { DiagnosticSeverity } from "vscode-languageserver/node"
+import { DiagnosticSeverity, DiagnosticTag } from "vscode-languageserver/node"
 import type { LintSeverity } from "@herb-tools/linter"
+import type { DiagnosticSeverity as HerbDiagnosticSeverity, DiagnosticTag as HerbDiagnosticTag } from "@herb-tools/core"
 
 export function camelize(value: string) {
   return value.replace(/(?:[_-])([a-z0-9])/g, (_, char) => char.toUpperCase())
@@ -13,7 +14,7 @@ export function capitalize(value: string) {
   return value.charAt(0).toUpperCase() + value.slice(1)
 }
 
-export function lintToDignosticSeverity(severity: LintSeverity): DiagnosticSeverity {
+export function lintToDignosticSeverity(severity: LintSeverity | HerbDiagnosticSeverity): DiagnosticSeverity {
   switch (severity) {
     case "error": return DiagnosticSeverity.Error
     case "warning": return DiagnosticSeverity.Warning
@@ -21,3 +22,15 @@ export function lintToDignosticSeverity(severity: LintSeverity): DiagnosticSever
     case "hint": return DiagnosticSeverity.Hint
   }
 }
+
+export function lintToDignosticTags(tags?: HerbDiagnosticTag[]): DiagnosticTag[] {
+  if (!tags) return []
+
+  return tags.flatMap(tag => {
+    switch (tag) {
+      case "unnecessary": return [DiagnosticTag.Unnecessary]
+      case "deprecated": return [DiagnosticTag.Deprecated]
+      default: return []
+    }
+  })
+}