@intentius/chant 0.0.4 → 0.0.8

package/src/lint/rules/enforce-barrel-import.test.ts

@@ -1,169 +0,0 @@
-import { describe, test, expect, mock, beforeEach, afterEach } from "bun:test";
-import * as ts from "typescript";
-import { enforceBarrelImportRule } from "./enforce-barrel-import";
-import type { LintContext } from "../rule";
-import { writeFileSync, mkdirSync, rmSync } from "fs";
-import { join } from "path";
-
-const TEST_DIR = join(import.meta.dir, "__test_barrel_import__");
-
-function createContext(code: string, filePath = "test.ts"): LintContext {
-  const sourceFile = ts.createSourceFile(
-    filePath,
-    code,
-    ts.ScriptTarget.Latest,
-    true
-  );
-
-  return {
-    sourceFile,
-    entities: [],
-    filePath,
-    lexicon: undefined,
-  };
-}
-
-describe("COR014: enforce-barrel-import", () => {
-  beforeEach(() => {
-    mkdirSync(TEST_DIR, { recursive: true });
-  });
-
-  afterEach(() => {
-    rmSync(TEST_DIR, { recursive: true, force: true });
-  });
-
-  test("rule metadata", () => {
-    expect(enforceBarrelImportRule.id).toBe("COR014");
-    expect(enforceBarrelImportRule.severity).toBe("warning");
-    expect(enforceBarrelImportRule.category).toBe("style");
-  });
-
-  test("flags lexicon import in non-barrel file", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].ruleId).toBe("COR014");
-    expect(diagnostics[0].severity).toBe("warning");
-  });
-
-  test("skips barrel file named _.ts", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "_.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("skips barrel file with path prefix", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "infra", "_.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("allows barrel import", () => {
-    const code = `import * as _ from "./_";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("allows non-chant imports", () => {
-    const code = `import * as ts from "typescript";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("message includes barrel content when barrel missing", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const filePath = join(TEST_DIR, "my-stack.ts");
-    const context = createContext(code, filePath);
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].message).toContain("Create _.ts");
-    expect(diagnostics[0].message).toContain(`export * from "@intentius/chant-lexicon-testdom"`);
-    expect(diagnostics[0].message).toContain("barrel");
-  });
-
-  test("message is shorter when barrel exists", () => {
-    // Create a barrel file in TEST_DIR
-    writeFileSync(join(TEST_DIR, "_.ts"), `export * from "@intentius/chant-lexicon-testdom";`);
-
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const filePath = join(TEST_DIR, "my-stack.ts");
-    const context = createContext(code, filePath);
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].message).not.toContain("Create _.ts");
-    expect(diagnostics[0].message).toContain("use the barrel");
-  });
-
-  test("provides auto-fix when barrel exists", () => {
-    writeFileSync(join(TEST_DIR, "_.ts"), `export * from "@intentius/chant-lexicon-testdom";`);
-
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].fix).toBeDefined();
-    expect(diagnostics[0].fix!.replacement).toBe(`import * as _ from "./_"`);
-  });
-
-  test("does not provide auto-fix when barrel is missing", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].fix).toBeUndefined();
-  });
-
-  test("flags type-only lexicon import", () => {
-    const code = `import type { Code } from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].ruleId).toBe("COR014");
-  });
-
-  test("skips subpath imports from core", () => {
-    const code = `import type { LintRule } from "@intentius/chant/lint/rule";`;
-    const context = createContext(code, join(TEST_DIR, "my-rule.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("skips deep subpath imports from lexicon", () => {
-    const code = `import { helper } from "@intentius/chant-lexicon-aws/internal/util";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("flags multiple lexicon imports", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";
-import * as core from "@intentius/chant";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(2);
-    expect(diagnostics[0].message).toContain("@intentius/chant-lexicon-testdom");
-    expect(diagnostics[1].message).toContain("@intentius/chant");
-  });
-
-  test("reports correct line and column numbers", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code, join(TEST_DIR, "my-stack.ts"));
-    const diagnostics = enforceBarrelImportRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].line).toBe(1);
-    expect(diagnostics[0].column).toBe(1);
-  });
-});

package/src/lint/rules/enforce-barrel-import.ts

@@ -1,81 +0,0 @@
-import * as ts from "typescript";
-import { existsSync } from "fs";
-import { dirname, join, basename } from "path";
-import type { LintRule, LintContext, LintDiagnostic } from "../rule";
-
-/**
- * COR014: enforce-barrel-import
- *
- * Flags direct lexicon imports (`import * as <name> from "@intentius/chant-lexicon-<name>"`)
- * in non-barrel files. Use the barrel (`import * as _ from "./_"`) instead.
- *
- * Triggers on: import * as <name> from "@intentius/chant-lexicon-<name>" (in non-barrel files)
- * OK: import * as _ from "./_"
- * OK: import * as <name> from "@intentius/chant-lexicon-<name>" (in _.ts barrel files)
- */
-
-export const enforceBarrelImportRule: LintRule = {
-  id: "COR014",
-  severity: "warning",
-  category: "style",
-  check(context: LintContext): LintDiagnostic[] {
-    const diagnostics: LintDiagnostic[] = [];
-    const sf = context.sourceFile;
-
-    // Skip barrel files
-    if (basename(context.filePath).startsWith("_")) return diagnostics;
-
-    // Check if barrel exists
-    const dir = dirname(context.filePath);
-    const barrelExists = existsSync(join(dir, "_.ts"));
-
-    for (const stmt of sf.statements) {
-      if (!ts.isImportDeclaration(stmt)) continue;
-      if (!ts.isStringLiteral(stmt.moduleSpecifier)) continue;
-
-      const modulePath = stmt.moduleSpecifier.text;
-      if (!modulePath.startsWith("@intentius/chant") && !modulePath.startsWith("@intentius/chant-lexicon-")) continue;
-
-      // Skip subpath imports (e.g., @intentius/chant/lint/rule) — these are
-      // framework internals not available through the barrel
-      const parts = modulePath.split("/");
-      if (parts.length > 2) continue;
-
-      const { line, character } = sf.getLineAndCharacterOfPosition(stmt.getStart(sf));
-      const importText = stmt.getText(sf);
-
-      let message: string;
-      if (barrelExists) {
-        message = `Direct lexicon import — use the barrel.\n    - ${importText}\n    + import * as _ from "./_";`;
-      } else {
-        const lexiconPkg = modulePath;
-        message =
-          `Direct lexicon import — use a barrel file.\n\n` +
-          `  Create _.ts:\n\n` +
-          `    export * from "${lexiconPkg}";\n` +
-          `    import { barrel } from "@intentius/chant";\n` +
-          `    export const $ = barrel(import.meta.dir);\n\n` +
-          `  Then replace this file's import:\n` +
-          `    - ${importText}\n` +
-          `    + import * as _ from "./_";`;
-      }
-
-      diagnostics.push({
-        file: context.filePath,
-        line: line + 1,
-        column: character + 1,
-        ruleId: "COR014",
-        severity: "warning",
-        message,
-        // Only provide auto-fix when barrel exists — replacing the import
-        // when no barrel is present corrupts the file
-        fix: barrelExists ? {
-          range: [stmt.getStart(sf), stmt.getEnd()],
-          replacement: `import * as _ from "./_"`,
-        } : undefined,
-      });
-    }
-
-    return diagnostics;
-  },
-};

package/src/lint/rules/enforce-barrel-ref.test.ts

@@ -1,114 +0,0 @@
-import { describe, test, expect } from "bun:test";
-import * as ts from "typescript";
-import { enforceBarrelRefRule } from "./enforce-barrel-ref";
-import type { LintContext } from "../rule";
-
-function createContext(code: string, filePath = "test.ts"): LintContext {
-  const sourceFile = ts.createSourceFile(
-    filePath,
-    code,
-    ts.ScriptTarget.Latest,
-    true
-  );
-
-  return {
-    sourceFile,
-    entities: [],
-    filePath,
-    lexicon: undefined,
-  };
-}
-
-describe("COR007: enforce-barrel-ref", () => {
-  test("rule metadata", () => {
-    expect(enforceBarrelRefRule.id).toBe("COR007");
-    expect(enforceBarrelRefRule.severity).toBe("warning");
-    expect(enforceBarrelRefRule.category).toBe("style");
-  });
-
-  test("flags named import from sibling", () => {
-    const code = `import { dataBucket } from "./data-bucket";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].ruleId).toBe("COR007");
-    expect(diagnostics[0].severity).toBe("warning");
-  });
-
-  test("flags namespace import from sibling", () => {
-    const code = `import * as db from "./data-bucket";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].ruleId).toBe("COR007");
-  });
-
-  test("skips barrel import", () => {
-    const code = `import * as _ from "./_";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("skips lexicon imports", () => {
-    const code = `import * as td from "@intentius/chant-lexicon-testdom";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("skips barrel file", () => {
-    const code = `import { dataBucket } from "./data-bucket";`;
-    const context = createContext(code, "_.ts");
-    const diagnostics = enforceBarrelRefRule.check(context);
-    expect(diagnostics).toHaveLength(0);
-  });
-
-  test("message includes suggestion with _.$ prefix", () => {
-    const code = `import { dataBucket } from "./data-bucket";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].message).toContain("_.$.dataBucket");
-  });
-
-  test("flags multiple sibling imports", () => {
-    const code = `import { dataBucket } from "./data-bucket";
-import { logGroup } from "./log-group";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(2);
-  });
-
-  test("flags parent relative imports", () => {
-    const code = `import { x } from "../other";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].ruleId).toBe("COR007");
-  });
-
-  test("does not provide auto-fix", () => {
-    const code = `import { dataBucket } from "./data-bucket";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].fix).toBeUndefined();
-  });
-
-  test("reports correct line and column numbers", () => {
-    const code = `import { dataBucket } from "./data-bucket";`;
-    const context = createContext(code);
-    const diagnostics = enforceBarrelRefRule.check(context);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0].line).toBe(1);
-    expect(diagnostics[0].column).toBe(1);
-  });
-});

package/src/lint/rules/enforce-barrel-ref.ts

@@ -1,75 +0,0 @@
-import * as ts from "typescript";
-import { basename } from "path";
-import type { LintRule, LintContext, LintDiagnostic } from "../rule";
-
-/**
- * COR007: enforce-barrel-ref
- *
- * Flags direct sibling imports (`import { dataBucket } from "./data-bucket"`)
- * in non-barrel files. Use `_.$` instead.
- *
- * Triggers on: import { dataBucket } from "./data-bucket"
- * OK: import * as _ from "./_"
- * OK: import { dataBucket } from "./data-bucket" (in _.ts barrel files)
- */
-
-const barrelPattern = /^\.\/(_|_\..*)$/;
-
-export const enforceBarrelRefRule: LintRule = {
-  id: "COR007",
-  severity: "warning",
-  category: "style",
-  check(context: LintContext): LintDiagnostic[] {
-    const diagnostics: LintDiagnostic[] = [];
-    const sf = context.sourceFile;
-
-    // Skip barrel files
-    if (basename(context.filePath).startsWith("_")) return diagnostics;
-
-    for (const stmt of sf.statements) {
-      if (!ts.isImportDeclaration(stmt)) continue;
-      if (!ts.isStringLiteral(stmt.moduleSpecifier)) continue;
-
-      const modulePath = stmt.moduleSpecifier.text;
-
-      // Skip non-relative imports
-      if (!modulePath.startsWith("./") && !modulePath.startsWith("../")) continue;
-
-      // Skip barrel imports
-      if (barrelPattern.test(modulePath)) continue;
-
-      // This is a direct sibling import — flag it
-      const { line, character } = sf.getLineAndCharacterOfPosition(stmt.getStart(sf));
-      const importText = stmt.getText(sf);
-
-      // Extract imported names for the suggestion
-      const importedNames: string[] = [];
-      const clause = stmt.importClause;
-      if (clause?.namedBindings) {
-        if (ts.isNamedImports(clause.namedBindings)) {
-          for (const el of clause.namedBindings.elements) {
-            importedNames.push(el.name.text);
-          }
-        } else if (ts.isNamespaceImport(clause.namedBindings)) {
-          importedNames.push(clause.namedBindings.name.text + ".*");
-        }
-      }
-
-      const refSuggestion =
-        importedNames.length > 0
-          ? `\n  Access via: ${importedNames.map((n) => `_.$.${n}`).join(", ")}`
-          : "";
-
-      diagnostics.push({
-        file: context.filePath,
-        line: line + 1,
-        column: character + 1,
-        ruleId: "COR007",
-        severity: "warning",
-        message: `Direct sibling import — use _.$ instead.\n    - ${importText}${refSuggestion}`,
-      });
-    }
-
-    return diagnostics;
-  },
-};

package/src/lint/rules/evl006-barrel-usage.test.ts

@@ -1,63 +0,0 @@
-import { describe, test, expect } from "bun:test";
-import * as ts from "typescript";
-import { evl006BarrelUsageRule } from "./evl006-barrel-usage";
-import type { LintContext } from "../rule";
-
-function createContext(code: string, filePath = "test.ts"): LintContext {
-  const sourceFile = ts.createSourceFile(filePath, code, ts.ScriptTarget.Latest, true);
-  return { sourceFile, entities: [], filePath, lexicon: undefined };
-}
-
-describe("EVL006: barrel-usage", () => {
-  test("rule metadata", () => {
-    expect(evl006BarrelUsageRule.id).toBe("EVL006");
-    expect(evl006BarrelUsageRule.severity).toBe("error");
-    expect(evl006BarrelUsageRule.category).toBe("correctness");
-  });
-
-  test("allows correct barrel usage", () => {
-    const ctx = createContext(`export const $ = barrel(import.meta.dir);`);
-    expect(evl006BarrelUsageRule.check(ctx)).toHaveLength(0);
-  });
-
-  test("flags string literal argument", () => {
-    const ctx = createContext(`export const $ = barrel("./src");`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("import.meta.dir"))).toBe(true);
-  });
-
-  test("flags variable argument", () => {
-    const ctx = createContext(`export const $ = barrel(myDir);`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("import.meta.dir"))).toBe(true);
-  });
-
-  test("flags non-exported barrel", () => {
-    const ctx = createContext(`const $ = barrel(import.meta.dir);`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("export const $"))).toBe(true);
-  });
-
-  test("flags barrel not assigned to $", () => {
-    const ctx = createContext(`export const myBarrel = barrel(import.meta.dir);`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("export const $"))).toBe(true);
-  });
-
-  test("flags let instead of const", () => {
-    const ctx = createContext(`export let $ = barrel(import.meta.dir);`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("export const $"))).toBe(true);
-  });
-
-  test("does not flag non-barrel calls", () => {
-    const ctx = createContext(`export const x = someFunction(import.meta.dir);`);
-    expect(evl006BarrelUsageRule.check(ctx)).toHaveLength(0);
-  });
-
-  test("flags no arguments", () => {
-    const ctx = createContext(`export const $ = barrel();`);
-    const diags = evl006BarrelUsageRule.check(ctx);
-    expect(diags.some((d) => d.message.includes("import.meta.dir"))).toBe(true);
-  });
-});

package/src/lint/rules/evl006-barrel-usage.ts

@@ -1,95 +0,0 @@
-import * as ts from "typescript";
-import type { LintRule, LintContext, LintDiagnostic } from "../rule";
-
-/**
- * EVL006: Incorrect barrel() Usage
- *
- * Two constraints:
- * 1. The argument to barrel() must be import.meta.dir
- * 2. The call must be part of: export const $ = barrel(import.meta.dir)
- */
-
-function isImportMetaDir(node: ts.Node): boolean {
-  // import.meta.dir is a PropertyAccessExpression: (import.meta).dir
-  if (
-    ts.isPropertyAccessExpression(node) &&
-    node.name.text === "dir" &&
-    ts.isMetaProperty(node.expression) &&
-    node.expression.keywordToken === ts.SyntaxKind.ImportKeyword &&
-    node.expression.name.text === "meta"
-  ) {
-    return true;
-  }
-  return false;
-}
-
-function checkNode(node: ts.Node, context: LintContext, diagnostics: LintDiagnostic[]): void {
-  if (
-    ts.isCallExpression(node) &&
-    ts.isIdentifier(node.expression) &&
-    node.expression.text === "barrel"
-  ) {
-    // Check constraint 1: argument must be import.meta.dir
-    const arg = node.arguments[0];
-    if (!arg || !isImportMetaDir(arg)) {
-      const { line, character } = context.sourceFile.getLineAndCharacterOfPosition(
-        node.getStart(context.sourceFile),
-      );
-      diagnostics.push({
-        file: context.filePath,
-        line: line + 1,
-        column: character + 1,
-        ruleId: "EVL006",
-        severity: "error",
-        message: "barrel() argument must be import.meta.dir",
-      });
-    }
-
-    // Check constraint 2: must be export const $ = barrel(...)
-    let isValidExport = false;
-    const parent = node.parent;
-    if (parent && ts.isVariableDeclaration(parent)) {
-      if (ts.isIdentifier(parent.name) && parent.name.text === "$") {
-        const declList = parent.parent;
-        if (declList && ts.isVariableDeclarationList(declList)) {
-          const stmt = declList.parent;
-          if (
-            stmt &&
-            ts.isVariableStatement(stmt) &&
-            stmt.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) &&
-            (declList.flags & ts.NodeFlags.Const) !== 0
-          ) {
-            isValidExport = true;
-          }
-        }
-      }
-    }
-
-    if (!isValidExport) {
-      const { line, character } = context.sourceFile.getLineAndCharacterOfPosition(
-        node.getStart(context.sourceFile),
-      );
-      diagnostics.push({
-        file: context.filePath,
-        line: line + 1,
-        column: character + 1,
-        ruleId: "EVL006",
-        severity: "error",
-        message: "barrel() must be used as: export const $ = barrel(import.meta.dir)",
-      });
-    }
-  }
-
-  ts.forEachChild(node, (child) => checkNode(child, context, diagnostics));
-}
-
-export const evl006BarrelUsageRule: LintRule = {
-  id: "EVL006",
-  severity: "error",
-  category: "correctness",
-  check(context: LintContext): LintDiagnostic[] {
-    const diagnostics: LintDiagnostic[] = [];
-    checkNode(context.sourceFile, context, diagnostics);
-    return diagnostics;
-  },
-};