@herb-tools/linter 0.7.4 → 0.8.0

package/src/types.ts

@@ -1,30 +1,97 @@
 import { Diagnostic, LexResult, ParseResult } from "@herb-tools/core"
-import type { defaultRules } from "./default-rules.js"
+
+import type { rules } from "./rules.js"
+import type { Node } from "@herb-tools/core"
+import type { RuleConfig } from "@herb-tools/config"
+import type { Mutable } from "@herb-tools/rewriter"
+
+export type { Mutable } from "@herb-tools/rewriter"
 
 export type LintSeverity = "error" | "warning" | "info" | "hint"
 
+export type FullRuleConfig = Required<Pick<RuleConfig, 'enabled' | 'severity'>> & Omit<RuleConfig, 'enabled' | 'severity'>
+
 /**
  * Automatically inferred union type of all available linter rule names.
  * This type extracts the 'name' property from each rule class instance.
  */
-export type LinterRule = InstanceType<typeof defaultRules[number]>['name']
+export type LinterRule = InstanceType<typeof rules[number]>['name']
 
-export interface LintOffense extends Diagnostic {
+
+/**
+ * Base context for autofix operations. Contains the offending node.
+ * Rules can extend this interface to include rule-specific autofix data.
+ * Note: The node is typed as Mutable to allow direct mutation in autofix methods.
+ */
+export interface BaseAutofixContext {
+  /** The AST node, token, or data structure that caused the offense (mutable) */
+  node: Mutable<Node>
+}
+
+/**
+ * A lint offense without severity bound. Rules produce these, and the Linter
+ * binds severity based on the rule's defaultConfig and user config overrides.
+ */
+export interface UnboundLintOffense<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> extends Omit<Diagnostic, 'severity'> {
   rule: LinterRule
+  /** Context data for autofix, including the offending node and rule-specific data */
+  autofixContext?: TAutofixContext
+}
+
+/**
+ * A lint offense with severity bound. The Linter produces these by binding
+ * severity to UnboundLintOffenses based on rule configuration.
+ */
+export interface LintOffense<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> extends UnboundLintOffense<TAutofixContext> {
   severity: LintSeverity
 }
 
-export interface LintResult {
-  offenses: LintOffense[]
+export interface LintResult<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> {
+  offenses: LintOffense<TAutofixContext>[]
   errors: number
   warnings: number
+  info: number
+  hints: number
+  ignored: number
+  wouldBeIgnored?: number
+}
+
+/**
+ * Result of applying autofixes to source code
+ */
+export interface AutofixResult<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> {
+  /** The corrected source code with all fixes applied */
+  source: string
+  /** Offenses that were successfully fixed */
+  fixed: LintOffense<TAutofixContext>[]
+  /** Offenses that could not be automatically fixed */
+  unfixed: LintOffense<TAutofixContext>[]
+}
+
+/**
+ * Default configuration for rules when defaultConfig is not specified.
+ * Custom rules can omit defaultConfig and will use these defaults.
+ */
+export const DEFAULT_RULE_CONFIG: FullRuleConfig = {
+  enabled: true,
+  severity: "error",
+  exclude: []
 }
 
-export abstract class ParserRule {
+/**
+ * Base class for parser rules.
+ */
+export abstract class ParserRule<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> {
   static type = "parser" as const
+  /** Indicates whether this rule supports autofix. Defaults to false. */
+  static autocorrectable = false
   abstract name: string
-  abstract check(result: ParseResult, context?: Partial<LintContext>): LintOffense[]
-  
+
+  get defaultConfig(): FullRuleConfig {
+    return DEFAULT_RULE_CONFIG
+  }
+  abstract check(result: ParseResult, context?: Partial<LintContext>): UnboundLintOffense<TAutofixContext>[]
+
   /**
    * Optional method to determine if this rule should run.
    * If not implemented, rule is always enabled.
@@ -33,13 +100,32 @@ export abstract class ParserRule {
    * @returns true if rule should run, false to skip
    */
   isEnabled?(result: ParseResult, context?: Partial<LintContext>): boolean
+
+  /**
+   * Optional method to automatically fix an offense by mutating the AST.
+   * If not implemented, the rule does not support autofix.
+   * @param offense - The offense to fix (includes autofixContext with node and rule-specific data)
+   * @param result - The parse result containing the AST (mutate it directly and return it)
+   * @param context - Optional context for linting
+   * @returns The mutated ParseResult if fixed, or null if the offense could not be fixed
+   */
+  autofix?(offense: LintOffense<TAutofixContext>, result: ParseResult, context?: Partial<LintContext>): ParseResult | null
 }
 
-export abstract class LexerRule {
+/**
+ * Base class for lexer rules.
+ */
+export abstract class LexerRule<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> {
   static type = "lexer" as const
+  /** Indicates whether this rule supports autofix. Defaults to false. */
+  static autocorrectable = false
   abstract name: string
-  abstract check(lexResult: LexResult, context?: Partial<LintContext>): LintOffense[]
-  
+
+  get defaultConfig(): FullRuleConfig {
+    return DEFAULT_RULE_CONFIG
+  }
+  abstract check(lexResult: LexResult, context?: Partial<LintContext>): UnboundLintOffense<TAutofixContext>[]
+
   /**
    * Optional method to determine if this rule should run.
    * If not implemented, rule is always enabled.
@@ -48,6 +134,16 @@ export abstract class LexerRule {
    * @returns true if rule should run, false to skip
    */
   isEnabled?(lexResult: LexResult, context?: Partial<LintContext>): boolean
+
+  /**
+   * Optional method to automatically fix an offense by mutating tokens.
+   * If not implemented, the rule does not support autofix.
+   * @param offense - The offense to fix (includes autofixContext with node and rule-specific data)
+   * @param lexResult - The lex result containing tokens (mutate them directly and return)
+   * @param context - Optional context for linting
+   * @returns The mutated LexResult if fixed, or null if the offense could not be fixed
+   */
+  autofix?(offense: LintOffense<TAutofixContext>, lexResult: LexResult, context?: Partial<LintContext>): LexResult | null
 }
 
 export interface LexerRuleConstructor {
@@ -61,20 +157,32 @@ export interface LexerRuleConstructor {
  */
 export interface LintContext {
   fileName: string | undefined
+  validRuleNames: string[] | undefined
+  ignoredOffensesByLine: Map<number, Set<string>> | undefined
+  ignoreDisableComments: boolean | undefined
 }
 
 /**
  * Default context object with all keys defined but set to undefined
  */
 export const DEFAULT_LINT_CONTEXT: LintContext = {
-  fileName: undefined
+  fileName: undefined,
+  validRuleNames: undefined,
+  ignoredOffensesByLine: undefined,
+  ignoreDisableComments: undefined
 } as const
 
-export abstract class SourceRule {
+export abstract class SourceRule<TAutofixContext extends BaseAutofixContext = BaseAutofixContext> {
   static type = "source" as const
+  /** Indicates whether this rule supports autofix. Defaults to false. */
+  static autocorrectable = false
   abstract name: string
-  abstract check(source: string, context?: Partial<LintContext>): LintOffense[]
-  
+
+  get defaultConfig(): FullRuleConfig {
+    return DEFAULT_RULE_CONFIG
+  }
+  abstract check(source: string, context?: Partial<LintContext>): UnboundLintOffense<TAutofixContext>[]
+
   /**
    * Optional method to determine if this rule should run.
    * If not implemented, rule is always enabled.
@@ -83,6 +191,16 @@ export abstract class SourceRule {
    * @returns true if rule should run, false to skip
    */
   isEnabled?(source: string, context?: Partial<LintContext>): boolean
+
+  /**
+   * Optional method to automatically fix an offense.
+   * If not implemented, the rule does not support autofix.
+   * @param offense - The offense to fix (includes autofixContext with node and rule-specific data)
+   * @param source - The original source code
+   * @param context - Optional context for linting
+   * @returns The corrected source if the offense can be fixed, null otherwise
+   */
+  autofix?(offense: LintOffense<TAutofixContext>, source: string, context?: Partial<LintContext>): string | null
 }
 
 export interface SourceRuleConstructor {

package/dist/src/default-rules.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"default-rules.js","sourceRoot":"","sources":["../../src/default-rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAA;AAClF,OAAO,EAAE,iCAAiC,EAAE,MAAM,gDAAgD,CAAA;AAClG,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAA;AACpF,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAA;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AACxF,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAA;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAA;AAC3F,OAAO,EAAE,gCAAgC,EAAE,MAAM,8CAA8C,CAAA;AAC/F,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAA;AACvF,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAA;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAA;AACrF,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAA;AACvF,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAA;AACzF,OAAO,EAAE,oCAAoC,EAAE,MAAM,iDAAiD,CAAA;AACtG,OAAO,EAAE,wCAAwC,EAAE,MAAM,uDAAuD,CAAA;AAChH,OAAO,EAAE,gCAAgC,EAAE,MAAM,6CAA6C,CAAA;AAC9F,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,oFAAoF;AACpF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAA;AAC7F,uFAAuF;AACvF,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAA;AACvF,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAA;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAA;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,gFAAgF;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAA;AACrF,OAAO,EAAE,qCAAqC,EAAE,MAAM,mDAAmD,CAAA;AAEzG,MAAM,CAAC,MAAM,YAAY,GAAgB;IACvC,kBAAkB;IAClB,0BAA0B;IAC1B,iCAAiC;IACjC,2BAA2B;IAC3B,8BAA8B;IAC9B,wBAAwB;IACxB,yBAAyB;IACzB,4BAA4B;IAC5B,gCAAgC;IAChC,4BAA4B;IAC5B,oCAAoC;IACpC,2BAA2B;IAC3B,6BAA6B;IAC7B,8BAA8B;IAC9B,oCAAoC;IACpC,wCAAwC;IACxC,gCAAgC;IAChC,sBAAsB;IACtB,qBAAqB;IACrB,8BAA8B;IAC9B,+BAA+B;IAC/B,+BAA+B;IAC/B,6BAA6B;IAC7B,sBAAsB;IACtB,yBAAyB;IACzB,uBAAuB;IACvB,qBAAqB;IACrB,0BAA0B;IAC1B,qBAAqB;IACrB,4BAA4B;IAC5B,wBAAwB;IACxB,kBAAkB;IAClB,4BAA4B;IAC5B,qCAAqC;CACtC,CAAA"}

package/dist/src/rules/erb-requires-trailing-newline.js

@@ -1,22 +0,0 @@
-import { BaseSourceRuleVisitor, createEndOfFileLocation } from "./rule-utils.js";
-import { SourceRule } from "../types.js";
-class ERBRequiresTrailingNewlineVisitor extends BaseSourceRuleVisitor {
-    visitSource(source) {
-        if (source.length === 0)
-            return;
-        if (source.endsWith('\n'))
-            return;
-        if (!this.context.fileName)
-            return;
-        this.addOffense("File must end with trailing newline", createEndOfFileLocation(source), "error");
-    }
-}
-export class ERBRequiresTrailingNewlineRule extends SourceRule {
-    name = "erb-requires-trailing-newline";
-    check(source, context) {
-        const visitor = new ERBRequiresTrailingNewlineVisitor(this.name, context);
-        visitor.visit(source);
-        return visitor.offenses;
-    }
-}
-//# sourceMappingURL=erb-requires-trailing-newline.js.map

package/dist/src/rules/erb-requires-trailing-newline.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"erb-requires-trailing-newline.js","sourceRoot":"","sources":["../../../src/rules/erb-requires-trailing-newline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAA;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGxC,MAAM,iCAAkC,SAAQ,qBAAqB;IACzD,WAAW,CAAC,MAAc;QAClC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAM;QAC/B,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAM;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YAAE,OAAM;QAElC,IAAI,CAAC,UAAU,CACb,qCAAqC,EACrC,uBAAuB,CAAC,MAAM,CAAC,EAC/B,OAAO,CACR,CAAA;IACH,CAAC;CACF;AAED,MAAM,OAAO,8BAA+B,SAAQ,UAAU;IAC5D,IAAI,GAAG,+BAA+B,CAAA;IAEtC,KAAK,CAAC,MAAc,EAAE,OAA8B;QAClD,MAAM,OAAO,GAAG,IAAI,iCAAiC,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAEzE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAErB,OAAO,OAAO,CAAC,QAAQ,CAAA;IACzB,CAAC;CACF"}

package/dist/types/default-rules.d.ts

@@ -1,2 +0,0 @@
-import type { RuleClass } from "./types.js";
-export declare const defaultRules: RuleClass[];

package/dist/types/rules/erb-requires-trailing-newline.d.ts

@@ -1,6 +0,0 @@
-import { SourceRule } from "../types.js";
-import type { LintOffense, LintContext } from "../types.js";
-export declare class ERBRequiresTrailingNewlineRule extends SourceRule {
-    name: string;
-    check(source: string, context?: Partial<LintContext>): LintOffense[];
-}

package/dist/types/src/default-rules.d.ts

@@ -1,2 +0,0 @@
-import type { RuleClass } from "./types.js";
-export declare const defaultRules: RuleClass[];

package/dist/types/src/rules/erb-requires-trailing-newline.d.ts

@@ -1,6 +0,0 @@
-import { SourceRule } from "../types.js";
-import type { LintOffense, LintContext } from "../types.js";
-export declare class ERBRequiresTrailingNewlineRule extends SourceRule {
-    name: string;
-    check(source: string, context?: Partial<LintContext>): LintOffense[];
-}

package/src/rules/erb-requires-trailing-newline.ts

@@ -1,29 +0,0 @@
-import { BaseSourceRuleVisitor, createEndOfFileLocation } from "./rule-utils.js"
-import { SourceRule } from "../types.js"
-import type { LintOffense, LintContext } from "../types.js"
-
-class ERBRequiresTrailingNewlineVisitor extends BaseSourceRuleVisitor {
-  protected visitSource(source: string): void {
-    if (source.length === 0) return
-    if (source.endsWith('\n')) return
-    if (!this.context.fileName) return
-
-    this.addOffense(
-      "File must end with trailing newline",
-      createEndOfFileLocation(source),
-      "error"
-    )
-  }
-}
-
-export class ERBRequiresTrailingNewlineRule extends SourceRule {
-  name = "erb-requires-trailing-newline"
-
-  check(source: string, context?: Partial<LintContext>): LintOffense[] {
-    const visitor = new ERBRequiresTrailingNewlineVisitor(this.name, context)
-
-    visitor.visit(source)
-
-    return visitor.offenses
-  }
-}