@timeax/scaffold 0.0.4 → 0.0.6

package/src/core/watcher.ts

@@ -2,105 +2,113 @@
 
 import path from 'path';
 import chokidar from 'chokidar';
-import { runOnce, type RunOptions } from './runner';
-import { defaultLogger, type Logger } from '../util/logger';
+import {runOnce, type RunOptions} from './runner';
+import {defaultLogger, type Logger} from '../util/logger';
+import {SCAFFOLD_ROOT_DIR} from '..';
 
 export interface WatchOptions extends RunOptions {
-   /**
-    * Debounce delay in milliseconds between detected changes
-    * and a scaffold re-run.
-    *
-    * Default: 150 ms
-    */
-   debounceMs?: number;
+    /**
+     * Debounce delay in milliseconds between detected changes
+     * and a scaffold re-run.
+     *
+     * Default: 150 ms
+     */
+    debounceMs?: number;
 
-   /**
-    * Optional logger; falls back to defaultLogger.child('[watch]').
-    */
-   logger?: Logger;
+    /**
+     * Optional logger; falls back to defaultLogger.child('[watch]').
+     */
+    logger?: Logger;
 }
 
 /**
  * Watch the scaffold directory and re-run scaffold on changes.
  *
  * This watches:
- * - scaffold/config.* files
- * - scaffold/*.txt files (structures)
+ * - .scaffold/config.* files
+ * - .scaffold/*.txt / *.tss / *.stx files (structures)
  *
  * CLI can call this when `--watch` is enabled.
+ * Any `format` options in RunOptions are passed straight through to `runOnce`,
+ * so formatting from config / CLI is applied on each re-run.
  */
 export function watchScaffold(cwd: string, options: WatchOptions = {}): void {
-   const logger = options.logger ?? defaultLogger.child('[watch]');
+    const logger = options.logger ?? defaultLogger.child('[watch]');
 
-   const scaffoldDir = options.scaffoldDir
-      ? path.resolve(cwd, options.scaffoldDir)
-      : path.resolve(cwd, 'scaffold');
+    const scaffoldDir = options.scaffoldDir
+        ? path.resolve(cwd, options.scaffoldDir)
+        : path.resolve(cwd, SCAFFOLD_ROOT_DIR);
 
-   const debounceMs = options.debounceMs ?? 150;
+    const debounceMs = options.debounceMs ?? 150;
 
-   logger.info(`Watching scaffold directory: ${scaffoldDir}`);
+    logger.info(`Watching scaffold directory: ${scaffoldDir}`);
 
-   let timer: NodeJS.Timeout | undefined;
-   let running = false;
-   let pending = false;
+    let timer: NodeJS.Timeout | undefined;
+    let running = false;
+    let pending = false;
 
-   async function run() {
-      if (running) {
-         pending = true;
-         return;
-      }
-      running = true;
-      try {
-         logger.info('Change detected → running scaffold...');
-         await runOnce(cwd, {
-            ...options,
-            // we already resolved scaffoldDir for watcher; pass it down
-            scaffoldDir,
-         });
-         logger.info('Scaffold run completed.');
-      } catch (err) {
-         logger.error('Scaffold run failed:', err);
-      } finally {
-         running = false;
-         if (pending) {
-            pending = false;
-            timer = setTimeout(run, debounceMs);
-         }
-      }
-   }
+    async function run() {
+        if (running) {
+            pending = true;
+            return;
+        }
+        running = true;
+        try {
+            logger.info('Change detected → running scaffold...');
+            await runOnce(cwd, {
+                ...options,
+                // we already resolved scaffoldDir for watcher; pass it down
+                scaffoldDir,
+            });
+            logger.info('Scaffold run completed.');
+        } catch (err) {
+            logger.error('Scaffold run failed:', err);
+        } finally {
+            running = false;
+            if (pending) {
+                pending = false;
+                timer = setTimeout(run, debounceMs);
+            }
+        }
+    }
 
-   function scheduleRun() {
-      if (timer) clearTimeout(timer);
-      timer = setTimeout(run, debounceMs);
-   }
+    function scheduleRun() {
+        if (timer) clearTimeout(timer);
+        timer = setTimeout(run, debounceMs);
+    }
 
-   const watcher = chokidar.watch(
-      [
-         path.join(scaffoldDir, 'config.*'),
-         path.join(scaffoldDir, '*.txt'),
-      ],
-      {
-         ignoreInitial: false,
-      },
-   );
+    const watcher = chokidar.watch(
+        [
+            // config files (ts/js/etc.)
+            path.join(scaffoldDir, 'config.*'),
 
-   watcher
-      .on('add', (filePath) => {
-         logger.debug(`File added: ${filePath}`);
-         scheduleRun();
-      })
-      .on('change', (filePath) => {
-         logger.debug(`File changed: ${filePath}`);
-         scheduleRun();
-      })
-      .on('unlink', (filePath) => {
-         logger.debug(`File removed: ${filePath}`);
-         scheduleRun();
-      })
-      .on('error', (error) => {
-         logger.error('Watcher error:', error);
-      });
+            // structure files: plain txt + our custom extensions
+            path.join(scaffoldDir, '*.txt'),
+            path.join(scaffoldDir, '*.tss'),
+            path.join(scaffoldDir, '*.stx'),
+        ],
+        {
+            ignoreInitial: false,
+        },
+    );
 
-   // Initial run
-   scheduleRun();
+    watcher
+        .on('add', (filePath) => {
+            logger.debug(`File added: ${filePath}`);
+            scheduleRun();
+        })
+        .on('change', (filePath) => {
+            logger.debug(`File changed: ${filePath}`);
+            scheduleRun();
+        })
+        .on('unlink', (filePath) => {
+            logger.debug(`File removed: ${filePath}`);
+            scheduleRun();
+        })
+        .on('error', (error) => {
+            logger.error('Watcher error:', error);
+        });
+
+    // Initial run
+    scheduleRun();
 }

package/src/schema/config.ts

@@ -1,12 +1,50 @@
 // src/schema/config.ts
 
 import type {
-   RegularHookConfig,
-   RegularHookKind,
-   StubConfig,
+    RegularHookConfig,
+    RegularHookKind,
+    StubConfig,
 } from './hooks';
-import type { StructureEntry } from './structure';
-
+import type {StructureEntry} from './structure';
+
+// src/schema/index.ts (or wherever ScaffoldConfig lives)
+
+export type FormatMode = 'strict' | 'loose';
+
+export interface FormatConfig {
+    /**
+     * Enable CLI-driven formatting.
+     *
+     * If false or omitted, formatting is only run when the user explicitly
+     * passes `--format` on the CLI.
+     */
+    enabled?: boolean;
+
+    /**
+     * Default indent step for formatting.
+     * Falls back to top-level `indentStep` or 2 if undefined.
+     */
+    indentStep?: number;
+
+    /**
+     * AST mode used by the formatter.
+     * - 'loose' (default): try to repair mild indentation issues.
+     * - 'strict': keep lines as-is and only normalize cosmetic whitespace.
+     */
+    mode?: FormatMode;
+
+    /**
+     * Sort non-comment entries lexicographically within their parent block.
+     * Matches the simple "sortEntries" behaviour you already had.
+     */
+    sortEntries?: boolean;
+
+    /**
+     * When running `scaffold --watch`, if true then any changed structure file
+     * is formatted after save and before the scaffold run.
+     */
+    formatOnWatch?: boolean;
+}
 
 
 /**
@@ -17,36 +55,36 @@ import type { StructureEntry } from './structure';
  * structure definition.
  */
 export interface StructureGroupConfig {
-   /**
-    * Human-readable identifier for the group (e.g. "app", "routes", "frontend").
-    * Used mainly for logging and, optionally, cache metadata.
-    */
-   name: string;
-
-   /**
-    * Root directory for this group, relative to the overall project root.
-    *
-    * Example: "app", "routes", "resources/js".
-    *
-    * All paths produced from this group's structure are resolved
-    * relative to this directory.
-    */
-   root: string;
-
-   /**
-    * Optional inline structure entries for this group.
-    * If present and non-empty, these take precedence over `structureFile`.
-    */
-   structure?: StructureEntry[];
-
-   /**
-    * Name of the structure file inside the scaffold directory for this group.
-    *
-    * Example: "app.txt", "routes.txt".
-    *
-    * If omitted, the default is `<name>.txt` within the scaffold directory.
-    */
-   structureFile?: string;
+    /**
+     * Human-readable identifier for the group (e.g. "app", "routes", "frontend").
+     * Used mainly for logging and, optionally, cache metadata.
+     */
+    name: string;
+
+    /**
+     * Root directory for this group, relative to the overall project root.
+     *
+     * Example: "app", "routes", "resources/js".
+     *
+     * All paths produced from this group's structure are resolved
+     * relative to this directory.
+     */
+    root: string;
+
+    /**
+     * Optional inline structure entries for this group.
+     * If present and non-empty, these take precedence over `structureFile`.
+     */
+    structure?: StructureEntry[];
+
+    /**
+     * Name of the structure file inside the scaffold directory for this group.
+     *
+     * Example: "app.txt", "routes.txt".
+     *
+     * If omitted, the default is `<name>.txt` within the scaffold directory.
+     */
+    structureFile?: string;
 }
 
 /**
@@ -56,134 +94,140 @@ export interface StructureGroupConfig {
  * project, or from any programmatic usage of the library.
  */
 export interface ScaffoldConfig {
-   /**
-    * Absolute or relative project root (where files are created).
-    *
-    * If omitted, the engine will treat `process.cwd()` as the root.
-    */
-   root?: string;
-
-   /**
-   * Base directory where structures are applied and files/folders
-   * are actually created.
-   *
-   * This is resolved relative to `root` (not CWD).
-   *
-   * Default: same as `root`.
-   *
-   * Examples:
-   * - base: '.'       with root: '.'       → apply to <cwd>
-   * - base: 'src'     with root: '.'       → apply to <cwd>/src
-   * - base: '..'      with root: 'tools'   → apply to <cwd>/tools/..
-   */
-   base?: string;
-
-   /**
-    * Path to the scaffold cache file, relative to `root`.
-    *
-    * Default: ".scaffold-cache.json"
-    */
-   cacheFile?: string;
-
-   /**
-    * File size threshold (in bytes) above which deletions become
-    * interactive (e.g. ask "are you sure?").
-    *
-    * Default is determined by the core engine (e.g. 128 KB).
-    */
-   sizePromptThreshold?: number;
-
-   /**
-    * Optional single-root structure (legacy or simple mode).
-    *
-    * If `groups` is defined and non-empty, this is ignored.
-    * Paths are relative to `root` in this mode.
-    */
-   structure?: StructureEntry[];
-
-   /**
-    * Name of the single structure file in the scaffold directory
-    * for legacy mode.
-    *
-    * If `groups` is empty and `structure` is not provided, this
-    * file name is used (default: "structure.txt").
-    */
-   structureFile?: string;
-
-   /**
-    * Multiple structure groups (recommended).
-    *
-    * When provided and non-empty, the engine will iterate over each
-    * group and apply its structure relative to each group's `root`.
-    */
-   groups?: StructureGroupConfig[];
-
-   /**
-    * Hook configuration for file lifecycle events.
-    *
-    * Each category (e.g. "preCreateFile") is an array of hook configs,
-    * each with its own `include` / `exclude` / `files` filters.
-    */
-   hooks?: {
-      [K in RegularHookKind]?: RegularHookConfig[];
-   };
-
-   /**
-    * Stub definitions keyed by stub name.
-    *
-    * These are referenced from structure entries by `stub: name`.
-    */
-   stubs?: Record<string, StubConfig>;
-
-   /**
-    * When true, the CLI or consuming code may choose to start scaffold
-    * in watch mode by default (implementation-specific).
-    *
-    * This flag itself does not start watch mode; it is a hint to the
-    * runner / CLI.
-    */
-   watch?: boolean;
-
-
-   /**
-    * Number of spaces per indent level in structure files.
-    * Default: 2.
-    *
-    * Examples:
-    * - 2  → "··entry"
-    * - 4  → "····entry"
-    */
-   indentStep?: number;
+    /**
+     * Absolute or relative project root (where files are created).
+     *
+     * If omitted, the engine will treat `process.cwd()` as the root.
+     */
+    root?: string;
+
+    /**
+     * Base directory where structures are applied and files/folders
+     * are actually created.
+     *
+     * This is resolved relative to `root` (not CWD).
+     *
+     * Default: same as `root`.
+     *
+     * Examples:
+     * - base: '.'       with root: '.'       → apply to <cwd>
+     * - base: 'src'     with root: '.'       → apply to <cwd>/src
+     * - base: '..'      with root: 'tools'   → apply to <cwd>/tools/..
+     */
+    base?: string;
+
+    /**
+     * Path to the scaffold cache file, relative to `root`.
+     *
+     * Default: ".scaffold-cache.json"
+     */
+    cacheFile?: string;
+
+    /**
+     * File size threshold (in bytes) above which deletions become
+     * interactive (e.g. ask "are you sure?").
+     *
+     * Default is determined by the core engine (e.g. 128 KB).
+     */
+    sizePromptThreshold?: number;
+
+    /**
+     * Optional single-root structure (legacy or simple mode).
+     *
+     * If `groups` is defined and non-empty, this is ignored.
+     * Paths are relative to `root` in this mode.
+     */
+    structure?: StructureEntry[];
+
+    /**
+     * Name of the single structure file in the scaffold directory
+     * for legacy mode.
+     *
+     * If `groups` is empty and `structure` is not provided, this
+     * file name is used (default: "structure.txt").
+     */
+    structureFile?: string;
+
+    /**
+     * Multiple structure groups (recommended).
+     *
+     * When provided and non-empty, the engine will iterate over each
+     * group and apply its structure relative to each group's `root`.
+     */
+    groups?: StructureGroupConfig[];
+
+    /**
+     * Hook configuration for file lifecycle events.
+     *
+     * Each category (e.g. "preCreateFile") is an array of hook configs,
+     * each with its own `include` / `exclude` / `files` filters.
+     */
+    hooks?: {
+        [K in RegularHookKind]?: RegularHookConfig[];
+    };
+
+    /**
+     * Stub definitions keyed by stub name.
+     *
+     * These are referenced from structure entries by `stub: name`.
+     */
+    stubs?: Record<string, StubConfig>;
+
+    /**
+     * When true, the CLI or consuming code may choose to start scaffold
+     * in watch mode by default (implementation-specific).
+     *
+     * This flag itself does not start watch mode; it is a hint to the
+     * runner / CLI.
+     */
+    watch?: boolean;
+
+
+    /**
+     * Number of spaces per indent level in structure files.
+     * Default: 2.
+     *
+     * Examples:
+     * - 2  → "··entry"
+     * - 4  → "····entry"
+     */
+    indentStep?: number;
+
+    /**
+     * Formatting configuration for structure files.
+     */
+    format?: FormatConfig;
 }
+
 /**
  * Options when scanning an existing directory into a structure.txt tree.
  */
 export interface ScanStructureOptions {
-   /**
-    * Glob patterns (relative to the scanned root) to ignore.
-    */
-   ignore?: string[];
-
-   /**
-    * Maximum depth to traverse (0 = only that dir).
-    * Default: Infinity (no limit).
-    */
-   maxDepth?: number;
+    /**
+     * Glob patterns (relative to the scanned root) to ignore.
+     */
+    ignore?: string[];
+
+    /**
+     * Maximum depth to traverse (0 = only that dir).
+     * Default: Infinity (no limit).
+     */
+    maxDepth?: number;
 }
 
 /**
  * Options when scanning based on the scaffold config/groups.
  */
 export interface ScanFromConfigOptions extends ScanStructureOptions {
-   /**
-    * If provided, only scan these group names (by `StructureGroupConfig.name`).
-    * If omitted, all groups are scanned (or single-root mode).
-    */
-   groups?: string[];
-
-   /**
-    * Optional override for scaffold directory; normally you can let
-    * loadScaffoldConfig resolve this from "<cwd>/scaffold".
-    */
-   scaffoldDir?: string;
+    /**
+     * If provided, only scan these group names (by `StructureGroupConfig.name`).
+     * If omitted, all groups are scanned (or single-root mode).
+     */
+    groups?: string[];
+
+    /**
+     * Optional override for scaffold directory; normally you can let
+     * loadScaffoldConfig resolve this from "<cwd>/scaffold".
+     */
+    scaffoldDir?: string;
 }

package/tsup.config.ts

@@ -1,66 +1,30 @@
 // tsup.config.ts
-import {defineConfig} from 'tsup';
+import { defineConfig } from 'tsup';
 
-export default defineConfig([
-    {
-        entry: ['src/index.ts'],
-        outDir: 'dist',
-        format: ['esm', 'cjs'],
-        dts: true,
-        sourcemap: true,
-        clean: true,
-        target: 'node18',
-        platform: 'node',
-        treeshake: true,
-        splitting: false, // small lib, keep it simple
-        outExtension({format}) {
-            return {
-                // ESM → .mjs, CJS → .cjs
-                js: format === 'esm' ? '.mjs' : '.cjs',
-            };
-        },
+export default defineConfig({
+    entry: {
+        index: 'src/index.ts',
+        cli: 'src/cli/main.ts',
+        ast: 'src/ast/index.ts',
     },
-
-    // CLI build (scaffold command)
-    {
+    outDir: 'dist',
+    format: ['esm', 'cjs'],
+    // Only generate dts for index + ast (not CLI)
+    dts: {
         entry: {
-            cli: 'src/cli/main.ts',
-        },
-        outDir: 'dist',
-        format: ['esm', 'cjs'],
-        dts: false,
-        sourcemap: true,
-        clean: false, // don't blow away the lib build
-        target: 'node18',
-        platform: 'node',
-        treeshake: true,
-        splitting: false,
-        outExtension({format}) {
-            return {
-                js: format === 'esm' ? '.mjs' : '.cjs',
-            };
-        },
-        banner: {
-            js: '#!/usr/bin/env node',
+            index: 'src/index.ts',
+            ast: 'src/ast/index.ts',
         },
     },
-    {
-        entry: {
-            ast: "src/ast/index.ts",
-        },
-        outDir: "dist",
-        format: ['esm', 'cjs'],
-        dts: true,
-        sourcemap: true,
-        clean: false,
-        target: 'node18',
-        platform: 'node',
-        treeshake: true,
-        splitting: false,
-        outExtension({format}) {
-            return {
-                js: format === 'esm' ? '.mjs' : '.cjs',
-            };
-        },
-    }
-]);
+    sourcemap: true,
+    clean: true,
+    target: 'node18',
+    platform: 'node',
+    treeshake: true,
+    splitting: false,
+    outExtension({ format }) {
+        return {
+            js: format === 'esm' ? '.mjs' : '.cjs',
+        };
+    },
+});