azcodr 1.5.2 → 2.1.0

package/lib/scaffold.d.ts

@@ -0,0 +1,80 @@
+import { ScaffoldError, ERROR_CODES } from './errors.js';
+import type { ScaffoldErrorCode, ScaffoldErrorShape } from './errors.js';
+import { runGit } from './git.js';
+import { assertInside, isProtectedTarget } from './guards.js';
+import { ensureSymlink, ensureSymlinkOrPointer, isSameCaseInsensitiveFile } from './links.js';
+import type { EnsureSymlinkOptions } from './links.js';
+import { makeScriptsExecutable } from './permissions.js';
+import { isInsideGitWorkTree, initGit } from './repo.js';
+import type { InitGitOptions } from './repo.js';
+export declare const TEMPLATE_ITEMS: readonly string[];
+export interface ScaffoldOptions {
+    targetDir?: string;
+    force?: boolean;
+    noGit?: boolean;
+    templateDir?: string;
+    dryRun?: boolean;
+    silent?: boolean;
+}
+export interface ScaffoldResult {
+    success: boolean;
+    targetDir: string;
+    gitInitialized: boolean;
+    dryRun: boolean;
+    actions: string[];
+}
+export interface ValidateTargetOptions {
+    templateDir?: string;
+    force?: boolean;
+    dryRun?: boolean;
+    allowProtected?: boolean;
+}
+export interface CopyTemplateOptions {
+    dryRun?: boolean;
+}
+/**
+ * Returns the root path to the azcodr template files.
+ */
+export declare function getTemplateDir(): string;
+/**
+ * Validates the target directory to ensure it is suitable for scaffolding.
+ */
+export declare function validateTarget(targetDir: string, options?: ValidateTargetOptions): void;
+/**
+ * Recursively copies template files into the target directory and sets up symlinks and permissions.
+ * Socket note: filesystem access is scoped to templateDir -> targetDir only (assertInside).
+ */
+export declare function copyTemplate(targetDir: string, templateDir?: string, options?: CopyTemplateOptions): string[];
+/**
+ * High-level orchestration function to scaffold the azcodr workspace into targetDir.
+ */
+export declare function scaffold(options?: ScaffoldOptions): ScaffoldResult;
+export { ensureSymlink, ensureSymlinkOrPointer, isSameCaseInsensitiveFile, makeScriptsExecutable, isInsideGitWorkTree, initGit, runGit, assertInside, ScaffoldError, ERROR_CODES, isProtectedTarget };
+export type { EnsureSymlinkOptions, InitGitOptions, ScaffoldErrorCode, ScaffoldErrorShape };
+declare const _default: {
+    scaffold: typeof scaffold;
+    validateTarget: typeof validateTarget;
+    copyTemplate: typeof copyTemplate;
+    ensureSymlink: typeof ensureSymlink;
+    ensureSymlinkOrPointer: typeof ensureSymlinkOrPointer;
+    isSameCaseInsensitiveFile: typeof isSameCaseInsensitiveFile;
+    makeScriptsExecutable: typeof makeScriptsExecutable;
+    isInsideGitWorkTree: typeof isInsideGitWorkTree;
+    initGit: typeof initGit;
+    getTemplateDir: typeof getTemplateDir;
+    runGit: typeof runGit;
+    assertInside: typeof assertInside;
+    TEMPLATE_ITEMS: readonly string[];
+    ScaffoldError: typeof ScaffoldError;
+    ERROR_CODES: {
+        readonly E_TARGET_IS_TEMPLATE: "Cannot scaffold into the azcodr template directory itself";
+        readonly E_TARGET_NOT_EMPTY: "Target directory is not empty";
+        readonly E_TARGET_IS_PROTECTED: "Refusing to scaffold into a protected system directory";
+        readonly E_GIT_ARGS_INVALID: "runGit requires a non-empty argv array";
+        readonly E_GIT_BLOCKED: "Blocked git subcommand";
+        readonly E_PATH_ESCAPE: "Path escapes allowed root";
+    };
+    isProtectedTarget: typeof isProtectedTarget;
+};
+export default _default;
+//# sourceMappingURL=scaffold.d.ts.map

package/lib/scaffold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,eAAO,MAAM,cAAc,EAAE,SAAS,MAAM,EAW3C,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAkCD;;GAEG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,IAAI,CAW3F;AAwFD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,MAAM,EACjB,WAAW,GAAE,MAAyB,EACtC,OAAO,GAAE,mBAAwB,GAChC,MAAM,EAAE,CAcV;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,cAAc,CActE;AAED,OAAO,EACL,aAAa,EACb,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,mBAAmB,EACnB,OAAO,EACP,MAAM,EACN,YAAY,EACZ,aAAa,EACb,WAAW,EACX,iBAAiB,EAClB,CAAC;AAEF,YAAY,EAAE,oBAAoB,EAAE,cAAc,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;AAE5F,wBAiBE"}