appease 0.0.1 → 0.0.2

package/dist/index.js

@@ -0,0 +1,134 @@
+// Public API for appease. Consumable from Node and exercised by the CLI and tests.
+import { analyzeContent } from "./core/analyze.js";
+import { audit } from "./core/audit.js";
+import { defaultEditorconfig, defaultGitattributes, interpretConfigs } from "./core/configs.js";
+import { buildExceptions, mergeEditorconfig, mergeGitattributes } from "./core/merge.js";
+import { normalizeText } from "./core/normalize.js";
+import { readRawConfigs, writeEditorconfig, writeGitattributes } from "./io/configs.js";
+import { listTrackedFiles, readForAudit, writeText } from "./io/files.js";
+export * from "./core/types.js";
+export { analyzeContent } from "./core/analyze.js";
+export { normalizeText } from "./core/normalize.js";
+export { interpretConfigs, defaultEditorconfig, defaultGitattributes } from "./core/configs.js";
+export { readRawConfigs, writeEditorconfig, writeGitattributes } from "./io/configs.js";
+export { audit } from "./core/audit.js";
+/**
+ * Run a full appease operation according to `options.mode`:
+ * - `audit`               : report deviations only (no writes).
+ * - `add-config-defaults` : write pure-default configs (no inspection).
+ * - `adapt-configs`       : write/adapt configs to reflect the repo's reality.
+ * - `fix-format`          : normalize files (BOM/trailing/newline; EOL via Git).
+ *
+ * Orchestrates the effects (git ls-files, file I/O) around the pure core.
+ */
+export async function runAppease(options) {
+    if (options.mode === "audit")
+        return runAudit(options);
+    if (options.mode === "add-config-defaults")
+        return runAddConfigDefaults(options);
+    if (options.mode === "adapt-configs")
+        return runAdaptConfigs(options);
+    return runFixFormat(options);
+}
+/** This machine's native line ending — how `text=auto` resolves in the working tree. */
+function nativeEol() {
+    return process.platform === "win32" ? "crlf" : "lf";
+}
+/** Re-end a generated (canonical LF) config in the OS-native EOL, so the written file is native. */
+function toNativeEol(content) {
+    return normalizeText(content, { bom: "keep", eol: nativeEol(), trailing: "keep", finalNewline: "keep" });
+}
+/** Write the pure-default configs, creating only the ones that do not exist yet (never overwrites). */
+async function runAddConfigDefaults(options) {
+    const raw = await readRawConfigs(options.cwd);
+    const created = [];
+    const unchanged = [];
+    if (raw.editorconfig === null)
+        created.push((await writeEditorconfig(options.cwd, toNativeEol(defaultEditorconfig()), options.dryRun)).path);
+    else
+        unchanged.push(".editorconfig");
+    if (raw.gitattributes === null)
+        created.push((await writeGitattributes(options.cwd, toNativeEol(defaultGitattributes()), options.dryRun)).path);
+    else
+        unchanged.push(".gitattributes");
+    return { mode: "add-config-defaults", dryRun: options.dryRun, created, modified: [], unchanged };
+}
+/** Discover tracked files, skip binaries/non-UTF-8, and analyze the rest. */
+async function collectReports(cwd, config) {
+    const reports = [];
+    const notAnalyzed = [];
+    for (const path of await listTrackedFiles(cwd)) {
+        const read = await readForAudit(cwd, path, config.resolve(path).eol === "binary");
+        if ("skip" in read)
+            notAnalyzed.push({ path, reason: read.skip });
+        else
+            reports.push({ path, report: analyzeContent(read.content) });
+    }
+    return { reports, notAnalyzed };
+}
+async function runAudit(options) {
+    const config = interpretConfigs(await readRawConfigs(options.cwd));
+    const { reports, notAnalyzed } = await collectReports(options.cwd, config);
+    return { mode: "audit", dryRun: options.dryRun, created: [], modified: [], unchanged: [], audit: { findings: audit(reports, config, nativeEol()), notAnalyzed } };
+}
+/**
+ * Establish the default configs as a baseline (in memory if absent), audit the repo
+ * against it, and merge an exception for every deviation so a later `--fix-format`
+ * changes nothing. Existing config content is preserved; new exceptions are appended.
+ */
+async function runAdaptConfigs(options) {
+    const raw = await readRawConfigs(options.cwd);
+    const editorconfigBase = raw.editorconfig ?? toNativeEol(defaultEditorconfig());
+    const gitattributesBase = raw.gitattributes ?? toNativeEol(defaultGitattributes());
+    const config = interpretConfigs({ editorconfig: editorconfigBase, gitattributes: gitattributesBase, vscodeSettings: raw.vscodeSettings });
+    const { reports } = await collectReports(options.cwd, config);
+    const deviationsByPath = new Map(audit(reports, config, nativeEol()).map((finding) => [finding.path, finding.deviations]));
+    const audited = reports.flatMap((report) => {
+        const deviations = deviationsByPath.get(report.path);
+        return deviations !== undefined ? [{ path: report.path, report: report.report, deviations }] : [];
+    });
+    const exceptions = buildExceptions(audited);
+    const results = [
+        await writeEditorconfig(options.cwd, mergeEditorconfig(editorconfigBase, exceptions.editorconfig), options.dryRun),
+        await writeGitattributes(options.cwd, mergeGitattributes(gitattributesBase, exceptions.gitattributes), options.dryRun),
+    ];
+    const created = results.filter((r) => r.created).map((r) => r.path);
+    const modified = results.filter((r) => !r.created && r.modified).map((r) => r.path);
+    const unchanged = results.filter((r) => !r.created && !r.modified).map((r) => r.path);
+    return { mode: "adapt-configs", dryRun: options.dryRun, created, modified, unchanged };
+}
+/**
+ * Normalize each tracked file's content (BOM / EOL / trailing / final newline) per its resolved
+ * config, skipping axes the config could not resolve (case 2). EOL is written directly into the
+ * working tree (`eol=auto` resolves to this machine's native ending), matching what `--audit` checks.
+ */
+async function runFixFormat(options) {
+    const config = interpretConfigs(await readRawConfigs(options.cwd));
+    const native = nativeEol();
+    const modified = [];
+    for (const path of await listTrackedFiles(options.cwd)) {
+        const resolved = config.resolve(path);
+        const read = await readForAudit(options.cwd, path, resolved.eol === "binary");
+        if ("skip" in read)
+            continue;
+        const normalized = normalizeText(read.content, fixOptions(resolved, native));
+        if (normalized !== read.content) {
+            if (!options.dryRun)
+                await writeText(options.cwd, path, normalized);
+            modified.push(path);
+        }
+    }
+    return { mode: "fix-format", dryRun: options.dryRun, created: [], modified, unchanged: [] };
+}
+/** Map a resolved config to normalizer options: skip case-2 axes; resolve `eol=auto` to native. */
+function fixOptions(resolved, native) {
+    const enforce = (axis) => !resolved.unresolved.includes(axis);
+    const eol = !enforce("eol") || resolved.eol === "binary" ? "keep" : resolved.eol === "auto" ? native : resolved.eol;
+    return {
+        bom: enforce("bom") ? resolved.bom : "keep",
+        eol,
+        trailing: enforce("trailing") ? resolved.trailing : "keep",
+        finalNewline: enforce("finalNewline") ? resolved.finalNewline : "keep",
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mFAAmF;AAEnF,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChG,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEzF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1E,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACxF,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAmB;IAClD,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IACvD,IAAI,OAAO,CAAC,IAAI,KAAK,qBAAqB;QAAE,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACjF,IAAI,OAAO,CAAC,IAAI,KAAK,eAAe;QAAE,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IACtE,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,wFAAwF;AACxF,SAAS,SAAS;IAChB,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACtD,CAAC;AAED,oGAAoG;AACpG,SAAS,WAAW,CAAC,OAAe;IAClC,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3G,CAAC;AAED,uGAAuG;AACvG,KAAK,UAAU,oBAAoB,CAAC,OAAmB;IACrD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,GAAG,CAAC,YAAY,KAAK,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,mBAAmB,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;QACxI,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrC,IAAI,GAAG,CAAC,aAAa,KAAK,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;QAC3I,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtC,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;AACnG,CAAC;AAED,6EAA6E;AAC7E,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,MAAqB;IAC9D,MAAM,OAAO,GAA6C,EAAE,CAAC;IAC7D,MAAM,WAAW,GAA+B,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,MAAM,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;QAClF,IAAI,MAAM,IAAI,IAAI;YAAE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;;YAC7D,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;AAClC,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,OAAmB;IACzC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC3E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC;AACpK,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,eAAe,CAAC,OAAmB;IAChD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,IAAI,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAChF,MAAM,iBAAiB,GAAG,GAAG,CAAC,aAAa,IAAI,WAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,gBAAgB,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1I,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3H,MAAM,OAAO,GAAkB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACxD,MAAM,UAAU,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpG,CAAC,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAE5C,MAAM,OAAO,GAAG;QACd,MAAM,iBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC,gBAAgB,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;QAClH,MAAM,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,iBAAiB,EAAE,UAAU,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;KACvH,CAAC;IACF,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpF,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtF,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AACzF,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,YAAY,CAAC,OAAmB;IAC7C,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,MAAM,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;QAC9E,IAAI,MAAM,IAAI,IAAI;YAAE,SAAS;QAC7B,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QAC7E,IAAI,UAAU,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,MAAM;gBAAE,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;YACpE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AAC9F,CAAC;AAED,mGAAmG;AACnG,SAAS,UAAU,CAAC,QAA4B,EAAE,MAAqB;IACrE,MAAM,OAAO,GAAG,CAAC,IAAmB,EAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtF,MAAM,GAAG,GACP,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC1G,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;QAC3C,GAAG;QACH,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM;QAC1D,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM;KACvE,CAAC;AACJ,CAAC"}

package/dist/io/configs.d.ts

@@ -0,0 +1,16 @@
+import type { RawConfigs } from "../core/types.js";
+/** Outcome of a config write: whether the file was created, changed, or already up to date. */
+export interface WriteResult {
+    path: string;
+    created: boolean;
+    modified: boolean;
+}
+/**
+ * Read the three config sources from `cwd` into raw contents. Thin I/O; the
+ * interpretation lives in the pure core (`interpretConfigs`).
+ */
+export declare function readRawConfigs(cwd: string): Promise<RawConfigs>;
+/** Write `.editorconfig` (created or updated only if it differs). */
+export declare function writeEditorconfig(cwd: string, content: string, dryRun: boolean): Promise<WriteResult>;
+/** Write `.gitattributes` (created or updated only if it differs). */
+export declare function writeGitattributes(cwd: string, content: string, dryRun: boolean): Promise<WriteResult>;

package/dist/io/configs.js

@@ -0,0 +1,47 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+/** Read a UTF-8 file, returning its contents or `null` when it does not exist. */
+async function readOrNull(path) {
+    try {
+        return await readFile(path, "utf8");
+    }
+    catch (err) {
+        if (err.code === "ENOENT")
+            return null;
+        throw err; // any other I/O error is real: do not swallow it
+    }
+}
+/**
+ * Read the three config sources from `cwd` into raw contents. Thin I/O; the
+ * interpretation lives in the pure core (`interpretConfigs`).
+ */
+export async function readRawConfigs(cwd) {
+    const [editorconfig, gitattributes, vscodeSettings] = await Promise.all([
+        readOrNull(join(cwd, ".editorconfig")),
+        readOrNull(join(cwd, ".gitattributes")),
+        readOrNull(join(cwd, ".vscode", "settings.json")),
+    ]);
+    return { editorconfig, gitattributes, vscodeSettings };
+}
+/**
+ * Write `content` to a config file under `cwd`, only when it differs (idempotent).
+ * The text to write is produced by the pure core (defaults or merge); this is
+ * just the I/O. Under `dryRun` the result reflects what would change, untouched.
+ */
+async function writeConfig(cwd, name, content, dryRun) {
+    const existing = await readOrNull(join(cwd, name));
+    if (existing === content)
+        return { path: name, created: false, modified: false };
+    if (!dryRun)
+        await writeFile(join(cwd, name), content, "utf8");
+    return { path: name, created: existing === null, modified: existing !== null };
+}
+/** Write `.editorconfig` (created or updated only if it differs). */
+export function writeEditorconfig(cwd, content, dryRun) {
+    return writeConfig(cwd, ".editorconfig", content, dryRun);
+}
+/** Write `.gitattributes` (created or updated only if it differs). */
+export function writeGitattributes(cwd, content, dryRun) {
+    return writeConfig(cwd, ".gitattributes", content, dryRun);
+}
+//# sourceMappingURL=configs.js.map

package/dist/io/configs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configs.js","sourceRoot":"","sources":["../../src/io/configs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAUjC,kFAAkF;AAClF,KAAK,UAAU,UAAU,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAClE,MAAM,GAAG,CAAC,CAAC,iDAAiD;IAC9D,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAW;IAC9C,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACtE,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QACtC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QACvC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;KAClD,CAAC,CAAC;IACH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY,EAAE,OAAe,EAAE,MAAe;IACpF,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACnD,IAAI,QAAQ,KAAK,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IACjF,IAAI,CAAC,MAAM;QAAE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,KAAK,IAAI,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,EAAE,CAAC;AACjF,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,OAAe,EAAE,MAAe;IAC7E,OAAO,WAAW,CAAC,GAAG,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC5D,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,kBAAkB,CAAC,GAAW,EAAE,OAAe,EAAE,MAAe;IAC9E,OAAO,WAAW,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC"}

package/dist/io/files.d.ts

@@ -0,0 +1,16 @@
+import type { AuditResult } from "../core/types.js";
+type SkipReason = AuditResult["notAnalyzed"][number]["reason"];
+/** List repo-tracked files (repo-relative, forward-slash paths). */
+export declare function listTrackedFiles(cwd: string): Promise<string[]>;
+/**
+ * Read a file for auditing: skip binaries (declared `-text`, known extension, or
+ * NUL content) and non-UTF-8 files; otherwise decode keeping any leading BOM.
+ */
+export declare function readForAudit(cwd: string, path: string, isGitBinary: boolean): Promise<{
+    content: string;
+} | {
+    skip: SkipReason;
+}>;
+/** Write UTF-8 `content` to a tracked file (a BOM in the string is encoded as bytes). */
+export declare function writeText(cwd: string, path: string, content: string): Promise<void>;
+export {};

package/dist/io/files.js

@@ -0,0 +1,43 @@
+import { execFile } from "node:child_process";
+import { readFile, writeFile } from "node:fs/promises";
+import { extname, join } from "node:path";
+import { promisify } from "node:util";
+const execFileAsync = promisify(execFile);
+/** Known-binary file extensions; the embedded list (a `.appease` override may come later). */
+const BINARY_EXTENSIONS = new Set([
+    ".png", ".jpg", ".jpeg", ".gif", ".webp", ".ico", ".bmp", ".tif", ".tiff",
+    ".pdf", ".zip", ".gz", ".tgz", ".bz2", ".xz", ".7z", ".rar", ".tar",
+    ".exe", ".dll", ".so", ".dylib", ".bin", ".o", ".a", ".class", ".jar", ".wasm",
+    ".woff", ".woff2", ".ttf", ".otf", ".eot",
+    ".mp3", ".mp4", ".m4a", ".avi", ".mov", ".mkv", ".wav", ".flac", ".ogg", ".webm",
+]);
+/** List repo-tracked files (repo-relative, forward-slash paths). */
+export async function listTrackedFiles(cwd) {
+    const { stdout } = await execFileAsync("git", ["ls-files", "-z"], { cwd, maxBuffer: 64 * 1024 * 1024 });
+    return stdout.split("\0").filter((path) => path !== "");
+}
+/**
+ * Read a file for auditing: skip binaries (declared `-text`, known extension, or
+ * NUL content) and non-UTF-8 files; otherwise decode keeping any leading BOM.
+ */
+export async function readForAudit(cwd, path, isGitBinary) {
+    if (isGitBinary)
+        return { skip: "gitattributes-notext" };
+    if (BINARY_EXTENSIONS.has(extname(path).toLowerCase()))
+        return { skip: "binary-extension" };
+    const bytes = await readFile(join(cwd, path));
+    if (bytes.includes(0))
+        return { skip: "binary-content" };
+    try {
+        // ignoreBOM keeps the BOM in the decoded string, as analyzeContent expects.
+        return { content: new TextDecoder("utf-8", { fatal: true, ignoreBOM: true }).decode(bytes) };
+    }
+    catch {
+        return { skip: "non-utf8" };
+    }
+}
+/** Write UTF-8 `content` to a tracked file (a BOM in the string is encoded as bytes). */
+export async function writeText(cwd, path, content) {
+    await writeFile(join(cwd, path), content, "utf8");
+}
+//# sourceMappingURL=files.js.map

package/dist/io/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/io/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAI1C,8FAA8F;AAC9F,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;IACzE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM;IACnE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO;IAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IACzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO;CACjF,CAAC,CAAC;AAEH,oEAAoE;AACpE,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,GAAW;IAChD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;IACxG,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,IAAY,EAAE,WAAoB;IAChF,IAAI,WAAW;QAAE,OAAO,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC;IACzD,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC5F,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9C,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzD,IAAI,CAAC;QACH,4EAA4E;QAC5E,OAAO,EAAE,OAAO,EAAE,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC/F,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,yFAAyF;AACzF,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,OAAe;IACxE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC"}

package/package.json

@@ -1,9 +1,55 @@
 {
   "name": "appease",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Make pease in this app.",
   "license": "MIT",
   "author": "Emilio Platzer",
+  "repository": "emilioplatzer/appease",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "appease": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
+    "build": "tsc",
+    "build:test": "tsc -p test/tsconfig.json",
+    "pretest": "npm run build:test",
+    "test": "mocha",
+    "precoverage": "npm run build:test",
+    "coverage": "c8 mocha",
+    "prepublishOnly": "npm run build"
+  },
+  "overrides": {
+    "diff": ">=8.0.2",
+    "serialize-javascript": ">=7.0.0",
+    "uuid": ">=14.0.0"
+  },
+  "dependencies": {
+    "picomatch": "^4.0.4"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.9.1",
+    "@types/picomatch": "^4.0.3",
+    "c8": "^11.0.0",
+    "mocha": "^11.7.6",
+    "qa-control": "^0.6.12",
+    "typescript": "^6.0.3"
+  },
+  "qa-control": {
+    "profile": "minimum",
+    "run-in": "server",
+    "type": "cmd-tool",
+    "gha": true
   }
 }