@zgeoff/format-codemod 0.0.7 → 0.1.0

package/README.md

@@ -38,8 +38,11 @@ between two kinds takes a blank line:
 - `const`/`let`/`var` declarations
 - `using`/`await using` declarations
 - bare calls and method calls — two distinct kinds, split by the first call in reading order:
-  `expect(x).toBe(y)` opens with a bare function, `fs.writeFileSync(…)` opens with a member, and a
+  `use(x).report()` opens with a bare function, `fs.writeFileSync(…)` opens with a member, and a
   member call chained onto a bare call's result is still a bare call
+- `expect` assertions — a statement whose first call in reading order is `expect` or an `expect.*`
+  helper (`expect(x).toBe(y)`, `expect.assertions(1)`) is its own kind, so a run of assertions stays
+  glued while the boundary with any acting statement is padded
 - assignments and increments
 
 Two axes overlay the kinds and pad their own boundaries:

package/dist/cli/apply-diff-mode.d.ts

@@ -3,9 +3,4 @@ export interface DiffOutput {
     readonly message: string | null;
     readonly stdout: string | null;
 }
-/**
- * Reached only when the file needs edits. Write mode saves the file here — the
- * one file-system effect below the entry; what to print is returned, never
- * printed, because the entry owns the output streams.
- */
 export declare function applyDiffMode(edit: FileEdit, mode: CLIMode): DiffOutput;

package/dist/cli/build-unified-diff.d.ts

@@ -1,6 +1 @@
-/**
- * A real unified diff — @@ hunk headers with context — so --dry output can be
- * applied with patch(1). Inputs are expected to end with a newline, which
- * TypeScript sources do and the transform preserves.
- */
 export declare function buildUnifiedDiff(before: string, after: string, label: string): string;

package/dist/cli/expand-inputs.d.ts

@@ -1,7 +1 @@
-/**
- * Deduped: overlapping patterns (a `src/**` glob plus a file inside src/) must
- * not process — or report — the same file twice. Ignore globs filter the final
- * list uniformly, so a file is skipped whether it arrived via a directory,
- * a glob, or an explicit path argument.
- */
 export declare function expandInputs(patterns: readonly string[], ignore?: readonly string[]): Promise<string[]>;

package/dist/cli/load-format-ignore.d.ts

@@ -1,8 +1 @@
-/**
- * Reads `.formatignore` from the given directory: one glob per line, blank
- * lines and `#`-prefixed comment lines skipped. Lines share --ignore's glob
- * semantics — this is not a gitignore dialect, so `!` negation and directory
- * anchoring don't apply. A missing file yields an empty list, so callers
- * merge unconditionally.
- */
 export declare function loadFormatIgnore(dir: string): readonly string[];

package/dist/cli/parse-cli-args.d.ts

@@ -8,10 +8,4 @@ export interface CLIArgs {
     readonly ignore: readonly string[];
     readonly inputs: readonly string[];
 }
-/**
- * Strict parsing: an unknown flag is a usage error, not a silent no-op. That
- * matters because the default mode writes files — a typo'd --check must never
- * fall through to an in-place rewrite. CLIArgs is always an object, so the
- * string (error message) return is unambiguous.
- */
 export declare function parseCLIArgs(argv: readonly string[]): CLIArgs | string;

package/dist/cli/print-report.d.ts

@@ -1,7 +1,2 @@
 import type { FileReport } from './types.ts';
-/**
- * Prints one file's outcome: the stdout payload (--dry diffs) to stdout,
- * messages and per-file progress to stderr. Quiet drops the OK/SKIP noise but
- * never the messages.
- */
 export declare function printReport(file: string, report: FileReport, quiet: boolean): void;

package/dist/cli/read-package-version.d.ts

@@ -1,6 +1 @@
-/**
- * Reads the version field of the package manifest at the given path, throwing
- * when the file isn't a manifest. Callers own the path so it resolves against
- * their own location.
- */
 export declare function readPackageVersion(pkgPath: string): string;

package/dist/cli/try-check-file.d.ts

@@ -1,7 +1,2 @@
 import type { CLIMode, FileReport } from './types.ts';
-/**
- * A failed file must fail the batch: --check would otherwise exit 0 having
- * validated nothing, and a throw would kill the process mid-batch with the
- * remaining files silently skipped.
- */
 export declare function tryCheckFile(file: string, mode: CLIMode): FileReport;

package/dist/cli/types.d.ts

@@ -1,11 +1,6 @@
 import type { TransformResult } from '../types.ts';
 export type CLIMode = 'write' | 'check' | 'dry';
 export type FileOutcome = 'ok' | 'changed' | 'failed' | 'skipped';
-/**
- * Everything the entry needs to report one file: the outcome for exit-code
- * logic, sizes for --bench, and the text to print — modules below the entry
- * never write to stdout/stderr themselves.
- */
 export interface FileReport {
     readonly outcome: FileOutcome;
     readonly bytes: number;

package/dist/cli.js

@@ -302,10 +302,19 @@ function getStatementKind(node) {
     return "declaration";
   }
   if (isExpressionStatementOf(node, CALL_TYPES)) {
-    return pickCallKind(node);
+    return isExpectHeaded(node) ? "expect" : pickCallKind(node);
   }
   return isExpressionStatementOf(node, MUTATION_TYPES) ? "mutation" : null;
 }
+function isExpectHeaded(node) {
+  const expression = node["expression"];
+  const callee = isASTNode(expression) ? findDeepestCallee(expression) : null;
+  if (callee === null) {
+    return false;
+  }
+  const head = collectHeadChain(callee).at(-1);
+  return head?.type === "Identifier" && head["name"] === "expect";
+}
 function pickCallKind(node) {
   const expression = node["expression"];
   const callee = isASTNode(expression) ? findDeepestCallee(expression) : null;

package/dist/index.js

@@ -135,10 +135,19 @@ function getStatementKind(node) {
     return "declaration";
   }
   if (isExpressionStatementOf(node, CALL_TYPES)) {
-    return pickCallKind(node);
+    return isExpectHeaded(node) ? "expect" : pickCallKind(node);
   }
   return isExpressionStatementOf(node, MUTATION_TYPES) ? "mutation" : null;
 }
+function isExpectHeaded(node) {
+  const expression = node["expression"];
+  const callee = isASTNode(expression) ? findDeepestCallee(expression) : null;
+  if (callee === null) {
+    return false;
+  }
+  const head = collectHeadChain(callee).at(-1);
+  return head?.type === "Identifier" && head["name"] === "expect";
+}
 function pickCallKind(node) {
   const expression = node["expression"];
   const callee = isASTNode(expression) ? findDeepestCallee(expression) : null;

package/dist/transform/apply-edits.d.ts

@@ -1,7 +1,2 @@
 import type { Edit } from '../types.ts';
-/**
- * Callers must pass edits sorted last-to-first, so each splice's offsets stay
- * valid without adjustment. Segments are collected and joined once instead of
- * re-copying the whole string per edit.
- */
 export declare function applyEdits(src: string, edits: readonly Edit[]): string;

package/dist/transform/build-edits-from-ast.d.ts

@@ -1,5 +1,2 @@
 import type { Edit, ParsedSource } from '../types.ts';
-/**
- * Sorted last-to-first so applying splices in order never shifts later offsets.
- */
 export declare function buildEditsFromAST(src: string, parsed: ParsedSource): Edit[];

package/dist/transform/collect-ast-nodes.d.ts

@@ -1,6 +1,2 @@
 import type { ASTNode } from '../types.ts';
-/**
- * The AST nodes in a property value: the node itself, an array's node
- * elements, or nothing for non-node values.
- */
 export declare function collectASTNodes(value: unknown): ASTNode[];

package/dist/transform/collect-child-nodes.d.ts

@@ -1,6 +1,2 @@
 import type { ASTNode } from '../types.ts';
-/**
- * A node's direct child nodes across all properties, skipping the location
- * and parent back-references a traversal must not follow.
- */
 export declare function collectChildNodes(node: ASTNode): ASTNode[];

package/dist/transform/collect-head-chain.d.ts

@@ -1,9 +1,2 @@
 import type { ASTNode } from '../types.ts';
-/**
- * The nodes on the walk from an expression to its head, outermost first and
- * ending at the head itself — `(await f()).prop` yields the member access,
- * the parenthesis, the await, the call, and finally `f`. Nodes outside the
- * walk (call arguments, ternary branches) never appear, so a scan of the
- * chain sees only what a reader meets before the expression's first token.
- */
 export declare function collectHeadChain(expression: ASTNode): ASTNode[];

package/dist/transform/needs-blank-line.d.ts

@@ -1,13 +1,2 @@
 import type { ASTNode } from '../types.ts';
-/**
- * The "always" rules: a blank line between class members, after a var or
- * using block before a statement of any other kind, after a directive
- * prologue, after the last import of a block, before a return, after a
- * function/class declaration, on both sides of a type alias or interface
- * declaration, on both sides of a control-flow block — its closing brace
- * ends a visual unit just like its opening keyword starts one —
- * and at the boundary between statement kinds: bare call vs method call vs
- * mutation, instantiation vs anything else, and awaited vs non-awaited. Any
- * match means exactly one blank line; a pair matching no rule sits flush.
- */
 export declare function needsBlankLine(container: ASTNode, prev: ASTNode, next: ASTNode): boolean;

package/dist/transform/parse-source.d.ts

@@ -1,10 +1,2 @@
 import type { ParsedSource } from '../types.ts';
-/**
- * The filename picks the dialect — `.tsx` enables JSX, anything else parses as
- * plain TypeScript, so `.ts`-only syntax like `<string>value` assertions and
- * un-comma'd generic arrows parse correctly. oxc reports syntax errors as a
- * list instead of throwing; any error means node offsets can't be trusted for
- * splicing, so the first message is returned and the caller skips the file.
- * ParsedSource is always an object, so the string return is unambiguous.
- */
 export declare function parseSource(src: string, filename: string): ParsedSource | string;

package/dist/transform/plan-gap-edit.d.ts

@@ -1,20 +1,8 @@
 import type { ASTNode, Edit, SourceFile } from '../types.ts';
-/**
- * A pair of adjacent statements in a file and the gap shape they take: one
- * blank line between them when `pad` is set, none otherwise.
- */
 export interface GapEditInput {
     readonly file: SourceFile;
     readonly prev: ASTNode;
     readonly next: ASTNode;
     readonly pad: boolean;
 }
-/**
- * Plans the single whitespace splice that gives the gap between two statements
- * its target shape, or null when the gap is already compliant or unsafe to
- * touch. Collapsing never crosses a comment: prose between statements marks
- * grouping the padding rules can't see, so a comment-bearing gap only ever
- * grows. Comment positions come from the parser rather than lexical scanning,
- * so comment-lookalike text can't mislead the classification.
- */
 export declare function planGapEdit(input: GapEditInput): Edit | null;

package/dist/transform.d.ts

@@ -1,13 +1,5 @@
 import type { TransformResult } from './types.ts';
 export interface TransformOptions {
-    /**
-     * Picks the parse dialect: `.tsx` enables JSX, anything else is plain
-     * TypeScript. Defaults to 'source.ts' — JSX callers must say so.
-     */
     readonly filename?: string;
 }
-/**
- * Pure transform: source string in, edited source string out, no I/O. On a
- * parse error the input is returned untouched alongside the error message.
- */
 export declare function transform(src: string, options?: TransformOptions): TransformResult;

package/dist/types.d.ts

@@ -1,8 +1,3 @@
-/**
- * The fields of the oxc AST this transform reads; the index signature carries
- * every other node property so the generic child walk can recurse untyped. The
- * codemod never mutates the tree, so everything is readonly.
- */
 export interface ASTNode {
     readonly type: string;
     readonly kind?: string;
@@ -21,10 +16,6 @@ export interface ParsedSource {
     readonly program: ASTNode;
     readonly comments: readonly CommentSpan[];
 }
-/**
- * The raw text and its comment spans together — what gap planning needs to
- * classify inter-statement trivia without re-lexing.
- */
 export interface SourceFile {
     readonly src: string;
     readonly comments: readonly CommentSpan[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/format-codemod",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Enforce blank-line padding conventions in TypeScript via a fast text-splice codemod",
   "license": "MIT",
   "repository": {