knitto 0.0.1

package/dist/src/types.d.ts

@@ -0,0 +1,242 @@
+export declare const CONFIG_FILE = ".knitto.json";
+export declare const LOCK_FILE = ".knitto.lock";
+export declare const TEMPLATE_MANIFEST = "template.json";
+export type SourceConfig = {
+    type: "local";
+    path: string;
+} | {
+    type: "http";
+    url: string;
+    path?: string;
+} | {
+    type: "git";
+    url: string;
+    path?: string;
+    ref?: string;
+};
+export interface ProjectConfig {
+    source: SourceConfig;
+    engine?: {
+        package: "knitto";
+        version: string;
+    };
+    metadata?: Record<string, unknown>;
+    variables?: Record<string, unknown>;
+    exclude?: {
+        rules?: string[];
+        checks?: string[];
+        pointers?: Record<string, string[]>;
+    };
+    overrides?: Record<string, Record<string, unknown>>;
+    trust?: {
+        hooks?: string[];
+    };
+}
+interface BaseCheck {
+    id: string;
+    scope?: "root" | "workspace" | "all";
+    when?: string;
+}
+export interface RequiredPackagesCheck extends BaseCheck {
+    type: "required-packages";
+    packages: Record<string, string[]>;
+}
+export interface UnwantedPackagesCheck extends BaseCheck {
+    type: "unwanted-packages";
+    packages: string[];
+    allowed?: string[];
+}
+export interface FileRegexCheck extends BaseCheck {
+    type: "file-regex";
+    path: string;
+    pattern: string;
+    flags?: string;
+    mustMatch?: boolean;
+    message?: string;
+    solution?: string;
+}
+export interface EnginesCheck extends BaseCheck {
+    type: "engines";
+    omit?: string[];
+}
+export type TemplateCheck = RequiredPackagesCheck | UnwantedPackagesCheck | FileRegexCheck | EnginesCheck;
+interface BaseRule {
+    id: string;
+    destination: string;
+    when?: string;
+    scope?: "root" | "workspace" | "all";
+    target?: "project" | "root";
+}
+export interface FileRule extends BaseRule {
+    type: "file";
+    template: string;
+    mode?: number;
+}
+export interface JsonRule extends BaseRule {
+    type: "json";
+    template: string;
+    schema?: string;
+    pointers?: string[];
+    exact?: string[];
+    indent?: number;
+}
+export interface DeleteRule extends BaseRule {
+    type: "delete";
+    glob?: boolean;
+}
+export type ParserName = "text" | "json" | "json-merge" | "package-json" | "yaml" | "yaml-merge" | "ini" | "ini-merge" | "hook";
+export interface ContentRule extends BaseRule {
+    type: "content";
+    template: string;
+    parser: ParserName;
+    hook?: string;
+    schema?: string;
+    pointers?: string[];
+    exact?: string[];
+    indent?: number;
+    mode?: number;
+}
+export type TemplateRule = FileRule | JsonRule | ContentRule | DeleteRule;
+export interface TemplateManifest {
+    schemaVersion: 1;
+    name: string;
+    engine?: {
+        package: "knitto";
+        version: string;
+    };
+    release?: {
+        provider: "release-please";
+        version: string;
+        tagFormat: string;
+    };
+    extends?: string[];
+    inputs?: string[];
+    partials?: Record<string, string>;
+    variables?: Record<string, unknown>;
+    prompts?: TemplatePrompt[];
+    rules: TemplateRule[];
+    checks?: TemplateCheck[];
+    hooks?: TemplateHook[];
+}
+interface BaseTemplatePrompt {
+    path: `metadata.${string}` | `variables.${string}`;
+    message: string;
+    description?: string;
+    required?: boolean;
+    default?: string | number | boolean;
+    when?: string;
+}
+export type TemplatePrompt = (BaseTemplatePrompt & {
+    type: "text" | "number" | "confirm";
+}) | (BaseTemplatePrompt & {
+    type: "select";
+    choices: Array<{
+        value: string;
+        label?: string;
+    }>;
+});
+export interface TemplateHook {
+    id: string;
+    kind: "context" | "parser" | "check";
+    command: string;
+    args?: string[];
+}
+export interface SnapshotProvenance {
+    sourceType: SourceConfig["type"];
+    locator: string;
+    templatePath?: string;
+    revision?: string;
+    etag?: string;
+    lastModified?: string;
+}
+export interface Snapshot {
+    digest: string;
+    directory: string;
+    manifest: TemplateManifest;
+    provenance: SnapshotProvenance;
+}
+export interface ProjectLock {
+    schemaVersion: 1;
+    digest: string;
+    source: SourceConfig;
+    engine?: {
+        package: "knitto";
+        version: string;
+    };
+    provenance: SnapshotProvenance;
+    templateSchemaVersion: 1;
+    resolvedAt: string;
+}
+export type PlanOperation = {
+    type: "write";
+    ruleId: string;
+    path: string;
+    before: string | null;
+    after: string;
+    beforeDigest: string | null;
+    mode?: number;
+    jsonPatch?: JsonPatchOperation[];
+} | {
+    type: "delete";
+    ruleId: string;
+    path: string;
+    before: string;
+    beforeDigest: string;
+};
+export interface ReconciliationPlan {
+    projectRoot: string;
+    templateDigest: string;
+    operations: PlanOperation[];
+    checks: CheckResult[];
+    excludedRules: string[];
+    excludedPointers: Record<string, string[]>;
+}
+export interface CheckResult {
+    id: string;
+    project: string;
+    title: string;
+    body: string[];
+    solution?: string;
+}
+export interface JsonPatchOperation {
+    op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+    path: string;
+    from?: string;
+    value?: unknown;
+}
+export interface RenderContext {
+    template?: {
+        name: string;
+        engine?: {
+            package: "knitto";
+            version: string;
+        };
+        release?: {
+            provider: "release-please";
+            version: string;
+            tag?: string;
+        };
+    };
+    project: {
+        path: string;
+        name: string;
+    };
+    files: Record<string, {
+        text: string;
+        json?: unknown;
+    }>;
+    metadata: Record<string, unknown>;
+    variables: Record<string, unknown>;
+    pkg: Record<string, unknown>;
+    derived: Record<string, unknown>;
+}
+export interface ProjectUnit {
+    repositoryRoot: string;
+    path: string;
+    relativePath: string;
+    packageJson: Record<string, unknown>;
+    config: ProjectConfig;
+    isRoot: boolean;
+    workspacePaths: string[];
+}
+export {};

package/dist/src/types.js

@@ -0,0 +1,4 @@
+export const CONFIG_FILE = ".knitto.json";
+export const LOCK_FILE = ".knitto.lock";
+export const TEMPLATE_MANIFEST = "template.json";
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAC;AAC1C,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC"}

package/dist/src/version.d.ts

@@ -0,0 +1,2 @@
+export declare const KNITTO_PACKAGE = "knitto";
+export declare const KNITTO_VERSION = "0.0.1";

package/dist/src/version.js

@@ -0,0 +1,3 @@
+export const KNITTO_PACKAGE = "knitto";
+export const KNITTO_VERSION = "0.0.1"; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/dist/src/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC;AACvC,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "knitto",
+  "version": "0.0.1",
+  "description": "Unix-first, template-aware filesystem reconciler",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/reggi/knitto.git"
+  },
+  "type": "module",
+  "packageManager": "npm@12.0.2",
+  "bin": {
+    "knitto": "dist/src/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "test": "node --test --import tsx \"test/**/*.test.ts\"",
+    "test:integration": "node --test --import tsx test/cli-usage.test.ts",
+    "test:integration:dist": "KNITTO_CLI_ENTRY=dist/src/cli.js node --test --import tsx test/cli-usage.test.ts"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "commander": "^14.0.0",
+    "diff": "^8.0.2",
+    "fast-json-patch": "^3.1.1",
+    "glob": "^13.0.0",
+    "handlebars": "^4.7.8",
+    "ini": "^6.0.0",
+    "minimatch": "^10.0.3",
+    "semver": "^7.7.2",
+    "yaml": "^2.8.1",
+    "tar": "^7.5.1"
+  },
+  "devDependencies": {
+    "@types/ini": "^4.1.1",
+    "@types/node": "^24.3.0",
+    "@types/semver": "^7.7.0",
+    "tsx": "^4.20.5",
+    "typescript": "^5.9.2"
+  },
+  "license": "MIT"
+}