vde-layout 0.0.1 → 0.0.2

package/README.md

@@ -14,6 +14,23 @@ vde-layout is a tool that allows you to define tmux pane layouts in YAML configu
 - Flexible pane settings (commands, working directories, environment variables, etc.)
 - Freely combine horizontal and vertical splits
 
+## Architecture
+
+vde-layout follows a functional-core/imperative-shell approach:
+
+- Functional Core compiles presets into immutable layout plans and deterministic tmux command sequences.
+- CLI adapters reuse the same plan for dry-run and real execution, ensuring matching plan hashes.
+- Plan Runner validates tmux prerequisites, applies each plan step, and reports structured diagnostics when a step fails.
+
+This separation allows the Functional Core to remain pure and fully testable while the boundary layer coordinates I/O with tmux.
+
+## Development Notes
+
+- Runtime modules are authored in ESM with explicit `.ts` extensions, and `src/core/` exposes the canonical functional services directly.
+- Boundary adapters (`src/cli`, `src/executor`, `src/tmux`) remain factory-based; avoid新たなクラス導入は避けてください。
+- `npm run build` uses tsdown to emit ESM bundles into `dist/`. `npm test` automatically rebuilds before executing the Vitest suite.
+- Run `npm run typecheck` to validate the TypeScript sources without emitting artifacts.
+
 ## Installation
 
 ```bash

package/bin/vde-layout

@@ -1,2 +1,10 @@
 #!/usr/bin/env node
-require('../dist/index.js');
+try {
+  await import('../dist/index.js');
+} catch (error) {
+  if (error && typeof error === 'object' && 'code' in error && error.code === 'ERR_MODULE_NOT_FOUND') {
+    await import('../src/index.ts');
+  } else {
+    throw error;
+  }
+}