@herb-tools/language-server 0.8.3 → 0.8.4

package/src/diagnostics.ts

@@ -1,5 +1,15 @@
 import { TextDocument } from "vscode-languageserver-textdocument"
-import { Connection, Diagnostic } from "vscode-languageserver/node"
+import { Connection, Diagnostic, DiagnosticSeverity, DiagnosticTag } from "vscode-languageserver/node"
+import { Visitor } from "@herb-tools/core"
+
+import type {
+  Node,
+  ERBCaseNode,
+  ERBCaseMatchNode,
+  HTMLTextNode,
+} from "@herb-tools/core"
+
+import { isHTMLTextNode } from "@herb-tools/core"
 
 import { ParserService } from "./parser_service"
 import { LinterService } from "./linter_service"
@@ -36,10 +46,12 @@ 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,
       ]
     }
 
@@ -47,6 +59,12 @@ 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)
   }
@@ -67,3 +85,48 @@ export class Diagnostics {
     this.diagnostics.delete(textDocument)
   }
 }
+
+export class UnreachableCodeCollector extends Visitor {
+  diagnostics: Diagnostic[] = []
+
+  visitERBCaseNode(node: ERBCaseNode): void {
+    this.checkUnreachableChildren(node.children)
+    this.visitChildNodes(node)
+  }
+
+  visitERBCaseMatchNode(node: ERBCaseMatchNode): void {
+    this.checkUnreachableChildren(node.children)
+    this.visitChildNodes(node)
+  }
+
+  private checkUnreachableChildren(children: Node[]): void {
+    for (const child of children) {
+      if (isHTMLTextNode(child) && child.content.trim() === "") {
+        continue
+      }
+
+      const diagnostic: Diagnostic = {
+        range: {
+          start: {
+            line: this.toZeroBased(child.location.start.line),
+            character: child.location.start.column
+          },
+          end: {
+            line: this.toZeroBased(child.location.end.line),
+            character: child.location.end.column
+          }
+        },
+        message: "Unreachable code: content between case and when/in is never executed",
+        severity: DiagnosticSeverity.Hint,
+        tags: [DiagnosticTag.Unnecessary],
+        source: "Herb Language Server"
+      }
+
+      this.diagnostics.push(diagnostic)
+    }
+  }
+
+  private toZeroBased(line: number): number {
+    return line - 1
+  }
+}

package/src/document_save_service.ts

@@ -18,12 +18,31 @@ export class DocumentSaveService {
     this.formattingService = formattingService
   }
 
+  /**
+   * Apply only autofix edits on save.
+   * Called by willSaveWaitUntil - formatting is handled separately by editor.formatOnSave
+   */
+  async applyFixes(document: TextDocument): Promise<TextEdit[]> {
+    const settings = await this.settings.getDocumentSettings(document.uri)
+    const fixOnSave = settings?.linter?.fixOnSave !== false
+
+    this.connection.console.log(`[DocumentSave] applyFixes fixOnSave=${fixOnSave}`)
+
+    if (!fixOnSave) return []
+
+    return this.autofixService.autofix(document)
+  }
+
+  /**
+   * Apply autofix and formatting.
+   * Called by onDocumentFormatting (manual format or editor.formatOnSave)
+   */
   async applyFixesAndFormatting(document: TextDocument, reason: TextDocumentSaveReason): Promise<TextEdit[]> {
     const settings = await this.settings.getDocumentSettings(document.uri)
     const fixOnSave = settings?.linter?.fixOnSave !== false
     const formatterEnabled = settings?.formatter?.enabled ?? false
 
-    this.connection.console.log(`[DocumentSave] fixOnSave=${fixOnSave}, formatterEnabled=${formatterEnabled}`)
+    this.connection.console.log(`[DocumentSave] applyFixesAndFormatting fixOnSave=${fixOnSave}, formatterEnabled=${formatterEnabled}`)
 
     let autofixEdits: TextEdit[] = []
 

package/src/formatting_service.ts

@@ -210,6 +210,9 @@ export class FormattingService {
     if (filePath.endsWith('.herb.yml')) return false
     if (!this.config) return true
 
+    const hasConfigFile = Config.exists(this.config.projectPath)
+    if (!hasConfigFile) return true
+
     const relativePath = filePath.replace('file://', '').replace(this.project.projectPath + '/', '')
 
     return this.config.isFormatterEnabledForPath(relativePath)

package/src/server.ts

@@ -12,15 +12,12 @@ import {
   DocumentRangeFormattingParams,
   CodeActionParams,
   CodeActionKind,
-  TextEdit,
 } from "vscode-languageserver/node"
 
 import { Service } from "./service"
 import { PersonalHerbSettings } from "./settings"
 import { Config } from "@herb-tools/config"
 
-import type { TextDocument } from "vscode-languageserver-textdocument"
-
 export class Server {
   private service!: Service
   private connection: Connection
@@ -37,7 +34,7 @@ export class Server {
       await this.service.init()
 
       this.service.documentService.documents.onWillSaveWaitUntil(async (event) => {
-        return this.service.documentSaveService.applyFixesAndFormatting(event.document, event.reason)
+        return this.service.documentSaveService.applyFixes(event.document)
       })
 
       const result: InitializeResult = {
@@ -89,7 +86,6 @@ export class Server {
         watchers: [
           ...patterns,
           { globPattern: `**/.herb.yml` },
-          { globPattern: `**/**/.herb-lsp/config.json` },
           { globPattern: `**/.herb/rules/**/*.mjs` },
           { globPattern: `**/.herb/rewriters/**/*.mjs` },
         ],
@@ -119,7 +115,7 @@ export class Server {
 
     this.connection.onDidChangeWatchedFiles(async (params) => {
       for (const event of params.changes) {
-        const isConfigChange = event.uri.endsWith("/.herb.yml") || event.uri.endsWith("/.herb-lsp/config.json")
+        const isConfigChange = event.uri.endsWith("/.herb.yml")
         const isCustomRuleChange = event.uri.includes("/.herb/rules/")
         const isCustomRewriterChange = event.uri.includes("/.herb/rewriters/")
 

package/src/settings.ts

@@ -87,8 +87,9 @@ export class Settings {
   // TODO: ideally we can just use Config all the way through
   private mergeSettings(userSettings: PersonalHerbSettings | null, projectConfig?: Config): PersonalHerbSettings {
     const settings = userSettings || this.defaultSettings
+    const hasConfigFile = projectConfig ? Config.exists(projectConfig.projectPath) : false
 
-    if (!projectConfig) {
+    if (!projectConfig || !hasConfigFile) {
       return {
         trace: settings.trace,
         linter: {

package/dist/config.js

@@ -1,73 +0,0 @@
-import path from "path";
-import { version } from "../package.json";
-import { promises as fs } from "fs";
-export class Config {
-    constructor(projectPath, config) {
-        this.path = Config.configPathFromProjectPath(projectPath);
-        this.config = config;
-    }
-    get version() {
-        return this.config.version;
-    }
-    get createdAt() {
-        return new Date(this.config.createdAt);
-    }
-    get updatedAt() {
-        return new Date(this.config.updatedAt);
-    }
-    get options() {
-        return this.config.options;
-    }
-    toJSON() {
-        return JSON.stringify(this.config, null, "  ");
-    }
-    updateTimestamp() {
-        this.config.updatedAt = new Date().toISOString();
-    }
-    updateVersion() {
-        this.config.version = version;
-    }
-    async write() {
-        this.updateVersion();
-        this.updateTimestamp();
-        const folder = path.dirname(this.path);
-        fs.stat(folder)
-            .then(() => { })
-            .catch(async () => await fs.mkdir(folder))
-            .finally(async () => await fs.writeFile(this.path, this.toJSON()));
-    }
-    async read() {
-        return await fs.readFile(this.path, "utf8");
-    }
-    static configPathFromProjectPath(projectPath) {
-        return path.join(projectPath, this.configPath);
-    }
-    static async fromPathOrNew(projectPath) {
-        try {
-            return await this.fromPath(projectPath);
-        }
-        catch {
-            return Config.newConfig(projectPath);
-        }
-    }
-    static async fromPath(projectPath) {
-        const configPath = Config.configPathFromProjectPath(projectPath);
-        try {
-            const config = JSON.parse(await fs.readFile(configPath, "utf8"));
-            return new Config(projectPath, config);
-        }
-        catch (error) {
-            throw new Error(`Error reading config file at: ${configPath}. Error: ${error.message}`);
-        }
-    }
-    static newConfig(projectPath) {
-        return new Config(projectPath, {
-            version,
-            createdAt: new Date().toISOString(),
-            updatedAt: new Date().toISOString(),
-            options: {}
-        });
-    }
-}
-Config.configPath = ".herb-lsp/config.json";
-//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAiBA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAA;AAEnC,MAAM,OAAO,MAAM;IAMjB,YAAY,WAAmB,EAAE,MAAqB;QACpD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;IAC5B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;IAC5B,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAChD,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IAClD,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,aAAa,EAAE,CAAA;QACpB,IAAI,CAAC,eAAe,EAAE,CAAA;QAEtB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEtC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;aACZ,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;aACd,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;aACzC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAED,MAAM,CAAC,yBAAyB,CAAC,WAAmB;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAChD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,WAAmB;QAC5C,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACzC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAmB;QACvC,MAAM,UAAU,GAAG,MAAM,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;QAEhE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA;YAEhE,OAAO,IAAI,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;QACxC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,UAAU,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QACzF,CAAC;IACH,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,WAAmB;QAClC,OAAO,IAAI,MAAM,CAAC,WAAW,EAAE;YAC7B,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO,EAAE,EAAE;SACZ,CAAC,CAAA;IACJ,CAAC;;AArFM,iBAAU,GAAG,uBAAuB,CAAA"}

package/dist/types/config.d.ts

@@ -1,34 +0,0 @@
-export type HerbConfigOptions = {
-    formatter?: {
-        enabled?: boolean;
-        include?: string[];
-        exclude?: string[];
-        indentWidth?: number;
-        maxLineLength?: number;
-    };
-};
-export type HerbLSPConfig = {
-    version: string;
-    createdAt: string;
-    updatedAt: string;
-    options: HerbConfigOptions;
-};
-export declare class Config {
-    static configPath: string;
-    readonly path: string;
-    config: HerbLSPConfig;
-    constructor(projectPath: string, config: HerbLSPConfig);
-    get version(): string;
-    get createdAt(): Date;
-    get updatedAt(): Date;
-    get options(): HerbConfigOptions;
-    toJSON(): string;
-    private updateTimestamp;
-    private updateVersion;
-    write(): Promise<void>;
-    read(): Promise<string>;
-    static configPathFromProjectPath(projectPath: string): string;
-    static fromPathOrNew(projectPath: string): Promise<Config>;
-    static fromPath(projectPath: string): Promise<Config>;
-    static newConfig(projectPath: string): Config;
-}

package/src/config.ts

@@ -1,109 +0,0 @@
-export type HerbConfigOptions = {
-  formatter?: {
-    enabled?: boolean
-    include?: string[]
-    exclude?: string[]
-    indentWidth?: number
-    maxLineLength?: number
-  }
-}
-
-export type HerbLSPConfig = {
-  version: string
-  createdAt: string
-  updatedAt: string
-  options: HerbConfigOptions
-}
-
-import path from "path"
-import { version } from "../package.json"
-import { promises as fs } from "fs"
-
-export class Config {
-  static configPath = ".herb-lsp/config.json"
-
-  public readonly path: string
-  public config: HerbLSPConfig
-
-  constructor(projectPath: string, config: HerbLSPConfig) {
-    this.path = Config.configPathFromProjectPath(projectPath)
-    this.config = config
-  }
-
-  get version(): string {
-    return this.config.version
-  }
-
-  get createdAt(): Date {
-    return new Date(this.config.createdAt)
-  }
-
-  get updatedAt(): Date {
-    return new Date(this.config.updatedAt)
-  }
-
-  get options(): HerbConfigOptions {
-    return this.config.options
-  }
-
-  public toJSON() {
-    return JSON.stringify(this.config, null, "  ")
-  }
-
-  private updateTimestamp() {
-    this.config.updatedAt = new Date().toISOString()
-  }
-
-  private updateVersion() {
-    this.config.version = version
-  }
-
-  async write() {
-    this.updateVersion()
-    this.updateTimestamp()
-
-    const folder = path.dirname(this.path)
-
-    fs.stat(folder)
-      .then(() => {})
-      .catch(async () => await fs.mkdir(folder))
-      .finally(async () => await fs.writeFile(this.path, this.toJSON()))
-  }
-
-  async read() {
-    return await fs.readFile(this.path, "utf8")
-  }
-
-  static configPathFromProjectPath(projectPath: string) {
-    return path.join(projectPath, this.configPath)
-  }
-
-  static async fromPathOrNew(projectPath: string) {
-    try {
-      return await this.fromPath(projectPath)
-    } catch {
-      return Config.newConfig(projectPath)
-    }
-  }
-
-  static async fromPath(projectPath: string) {
-    const configPath = Config.configPathFromProjectPath(projectPath)
-
-    try {
-      const config = JSON.parse(await fs.readFile(configPath, "utf8"))
-
-      return new Config(projectPath, config)
-    } catch (error: any) {
-      throw new Error(`Error reading config file at: ${configPath}. Error: ${error.message}`)
-    }
-  }
-
-  static newConfig(projectPath: string): Config {
-    return new Config(projectPath, {
-      version,
-      createdAt: new Date().toISOString(),
-      updatedAt: new Date().toISOString(),
-      options: {}
-    })
-  }
-}