@postxl/generator 1.6.1 → 1.6.3

package/dist/utils/index.d.ts

@@ -1,7 +1,9 @@
+export * from './checksum';
 export * from './classify-path';
 export * from './custom-blocks';
 export * from './jsdoc';
 export * from './lint';
+export * from './lockfile';
 export * from './path';
 export * from './promise';
 export * from './prettier';

package/dist/utils/index.js

@@ -14,10 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./checksum"), exports);
 __exportStar(require("./classify-path"), exports);
 __exportStar(require("./custom-blocks"), exports);
 __exportStar(require("./jsdoc"), exports);
 __exportStar(require("./lint"), exports);
+__exportStar(require("./lockfile"), exports);
 __exportStar(require("./path"), exports);
 __exportStar(require("./promise"), exports);
 __exportStar(require("./prettier"), exports);

package/dist/utils/sync.d.ts

@@ -75,6 +75,14 @@ type SyncParams = {
      * generation via `-m <names...>`.
      */
     selectiveGeneration?: boolean;
+    /**
+     * When true, computes the actions that *would* be performed but skips
+     * executing them — no files are written, deleted, or merge-conflict-marked,
+     * and the lock file is left untouched. The returned `SyncResults` still
+     * report the planned `action` per file, so callers can use
+     * `logSyncResult` to summarize the diff.
+     */
+    dryRun?: boolean;
 };
 /**
  * Error returned when files with unresolved merge conflicts are detected
@@ -117,7 +125,7 @@ export type SyncResults = {
  * merge conflict markers. If found, the sync will abort immediately and return an error with the
  * list of files that need to be resolved before generation can continue.
  */
-export declare function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneration, }: SyncParams): Promise<SyncResults>;
+export declare function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneration, dryRun, }: SyncParams): Promise<SyncResults>;
 type FileState = {
     state: 'empty';
 } | {

package/dist/utils/sync.js

@@ -121,7 +121,7 @@ const Path = __importStar(require("./path"));
  * merge conflict markers. If found, the sync will abort immediately and return an error with the
  * list of files that need to be resolved before generation can continue.
  */
-async function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneration, }) {
+async function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneration, dryRun, }) {
     const diskPathNormalized = Path.normalize(diskFilePath);
     const files = await getFilesStates({ vfs, lockFilePath, diskFilePath, selectiveGeneration: !!selectiveGeneration });
     // Check for unresolved merge conflicts before writing any files
@@ -156,6 +156,16 @@ async function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneratio
             continue;
         }
         const [action, isEjectedFile] = determineActionState({ virtual, lock, disk }, force);
+        if (dryRun) {
+            // Dry-run: record the planned action but do not touch disk.
+            result.files[filePath] = {
+                action,
+                inputState,
+                actionResult: utils_1.Result.ok(undefined),
+                isEjected: isEjectedFile,
+            };
+            continue;
+        }
         const task = limit(async () => {
             const actionResult = await executeAction(Path.join(diskPathNormalized, filePath), action);
             if (actionResult.isErr()) {
@@ -165,7 +175,9 @@ async function sync({ vfs, lockFilePath, diskFilePath, force, selectiveGeneratio
         });
         tasks.push(task);
     }
-    tasks.push(limit(() => (0, lockfile_1.writeLockFile)(lockFilePath, vfs, selectiveGeneration ? { selectiveGeneration: true } : {})));
+    if (!dryRun) {
+        tasks.push(limit(() => (0, lockfile_1.writeLockFile)(lockFilePath, vfs, selectiveGeneration ? { selectiveGeneration: true } : {})));
+    }
     await Promise.all(tasks);
     return { success: true, ...result };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "Core package that orchestrates the code generation of a PXL project",
   "main": "./dist/index.js",
   "module": "./dist/index.js",