skir 0.0.6 → 0.0.8

package/src/project_initializer.ts

@@ -1,11 +1,12 @@
-import * as fs from "fs";
-import * as paths from "path";
+import * as FileSystem from "fs";
+import * as Paths from "path";
+import { rewritePathForRendering } from "./io.js";
 
 export function initializeProject(rootDir: string): void {
-  const skirYmlPath = paths.join(rootDir, "skir.yml");
+  const skirYmlPath = Paths.join(rootDir, "skir.yml");
 
   // Check if skir.yml already exists
-  if (fs.existsSync(skirYmlPath)) {
+  if (FileSystem.existsSync(skirYmlPath)) {
     console.log(
       "A skir.yml file already exists in this directory. Skipping project initialization.",
     );
@@ -13,28 +14,109 @@ export function initializeProject(rootDir: string): void {
   }
 
   // Create skir.yml file
-  fs.writeFileSync(skirYmlPath, SKIR_YML_CONTENT, "utf-8");
+  FileSystem.writeFileSync(skirYmlPath, SKIR_YML_CONTENT, "utf-8");
 
   // Check if skir-src directory exists
-  const skirSrcDir = paths.join(rootDir, "skir-src");
-  if (!fs.existsSync(skirSrcDir)) {
+  const skirSrcDir = Paths.join(rootDir, "skir-src");
+  if (!FileSystem.existsSync(skirSrcDir)) {
     // Create skir-src directory
-    fs.mkdirSync(skirSrcDir, { recursive: true });
+    FileSystem.mkdirSync(skirSrcDir, { recursive: true });
 
     // Create hello_world.skir file
-    const helloWorldPath = paths.join(skirSrcDir, "hello_world.skir");
-    fs.writeFileSync(helloWorldPath, HELLO_WORLD_SKIR_CONTENT, "utf-8");
+    const helloWorldPath = Paths.join(skirSrcDir, "hello_world.skir");
+    FileSystem.writeFileSync(helloWorldPath, HELLO_WORLD_SKIR_CONTENT, "utf-8");
   }
 
-  console.log(`Done. Please edit: ${paths.resolve(skirYmlPath)}`);
+  console.log(`Done. Please edit: ${rewritePathForRendering(skirYmlPath)}`);
 }
 
-const SKIR_YML_CONTENT = `srcDir: skir-src
+const SKIR_YML_CONTENT = `# Configuration file for Skir code generator
+#
+# Documentation: https://skir.build/
+#
+# Cheat sheet:
+#   npx skir gen          Generate code from .skir files
+#   npx skir gen --watch  Watch for changes and regenerate automatically
+#   npx skir format       Format all .skir files
+#   npx skir snapshot     Take a snapshot of the source directory, verify no
+#                         breaking changes since last snapshot
 
+# Directory containing .skir files
+srcDir: skir-src
+
+# Uncomment and configure the generators for your target language(s).
 generators:
-  - mod: skir-python-gen
-    skiroutDir: ./skirout
-    config: {}
+  # # --------------------------------------------------------------------------
+  # # C++ code generator
+  # # Home: https://github.com/gepheum/skir-cc-gen
+  # # To install runtime dependencies, follow instructions in repository README
+  # # --------------------------------------------------------------------------
+  # - mod: skir-cc-gen
+  #   outDir: ./skirout
+  #   config:
+  #     # Set to true if you use GoogleTest
+  #     writeGoogleTestHeaders: false
+
+  # # --------------------------------------------------------------------------
+  # # Dart code generator
+  # # Home: https://github.com/gepheum/skir-dart-gen
+  # # To install runtime dependencies: dart pub add skir_client
+  # # --------------------------------------------------------------------------
+  # - mod: skir-dart-gen
+  #   outDir: ./skirout
+  #   config: {}
+
+  # # --------------------------------------------------------------------------
+  # # Java code generator
+  # # Home: https://github.com/gepheum/skir-java-gen
+  # # Add the following line to your build.gradle dependencies:
+  # #    implementation("build.skir:skir-client:latest.release")
+  # # --------------------------------------------------------------------------
+  # - mod: skir-java-gen
+  #   outDir: ./src/main/java/skirout
+  #   config: {}
+  #   # Alternatively:
+  #   # outDir: ./src/main/java/skirout/my/project
+  #   # config:
+  #   #   packagePrefix: "my.project."
+
+  # # --------------------------------------------------------------------------
+  # # Kotlin code generator
+  # # Home: https://github.com/gepheum/skir-kotlin-gen
+  # # Add the following line to your build.gradle dependencies:
+  # #   implementation("build.skir:skir-client:latest.release")
+  # # --------------------------------------------------------------------------
+  # - mod: skir-kotlin-gen
+  #   outDir: ./src/main/kotlin/skirout
+  #   config: {}
+  #   # Alternatively:
+  #   # outDir: ./src/main/kotlin/skirout/my/project
+  #   # config:
+  #   #   packagePrefix: "my.project."
+
+  # # --------------------------------------------------------------------------
+  # # Python code generator
+  # # Home: https://github.com/gepheum/skir-python-gen
+  # # To install runtime dependencies: pip install skir-client
+  # # --------------------------------------------------------------------------
+  # - mod: skir-python-gen
+  #   outDir: ./skirout
+  #   config: {}
+  #   # Alternatively:
+  #   # outDir: ./my/project/skirout
+  #   # config:
+  #   #   packagePrefix: "my.project."
+
+  # # --------------------------------------------------------------------------
+  # # TypeScript/JavaScript code generator
+  # # Home: https://github.com/gepheum/skir-typescript-gen
+  # # To install runtime dependencies: npm i skir-client
+  # # --------------------------------------------------------------------------
+  # - mod: skir-typescript-gen
+  #   outDir: ./src/skirout
+  #   config:
+  #     # Use ".js" for ES modules, "" for CommonJS
+  #     importPathExtension: ".js"
 `;
 
 const HELLO_WORLD_SKIR_CONTENT = `/// A point in 2D space.

package/src/snapshotter.ts

@@ -8,29 +8,34 @@ import {
   renderBreakingChanges,
   renderErrors,
 } from "./error_renderer.js";
+import { rewritePathForRendering } from "./io.js";
 import { collectModules } from "./module_collector.js";
 import { ModuleSet } from "./module_set.js";
 
 export async function takeSnapshot(args: {
   rootDir: string;
   srcDir: string;
-  check: boolean;
-}): Promise<void> {
+  subcommand: "ci" | "dry-run" | undefined;
+}): Promise<boolean> {
   const newModuleSet = await collectModules(args.srcDir);
   if (newModuleSet.errors.length) {
     renderErrors(newModuleSet.errors);
-    process.exit(1);
+    return false;
   }
   const snapshotPath = join(args.rootDir, "skir-snapshot.json");
-  const oldModuleSet = await readLastSnapshot(join(args.rootDir, snapshotPath));
+  const oldModuleSet = await readLastSnapshot(snapshotPath);
   if (!(oldModuleSet instanceof ModuleSet)) {
-    console.error(makeRed(`Corrupted snapshot file: ${snapshotPath}`));
+    console.error(
+      makeRed(
+        `Corrupted snapshot file: ${rewritePathForRendering(snapshotPath)}`,
+      ),
+    );
     console.error(`Error: ${oldModuleSet.error.toString()}`);
     console.log(
       "If the snapshot file cannot be restored to a valid state, delete it and run again. " +
         "Breaking changes from recent commits will not be detected, but a valid snapshot will be created for future comparisons.",
     );
-    process.exit(1);
+    return false;
   }
   const breakingChanges = checkBackwardCompatibility({
     before: oldModuleSet,
@@ -41,51 +46,65 @@ export async function takeSnapshot(args: {
       before: oldModuleSet,
       after: newModuleSet,
     });
-    process.exit(1);
+    return false;
   }
   const now = new Date();
   const newSnapshot = makeSnapshot(newModuleSet, now);
   if (sameModules(newSnapshot, makeSnapshot(oldModuleSet, now))) {
     console.log("No changes detected since last snapshot.");
-    return;
+    return true;
   }
-  if (args.check) {
-    console.error(
-      makeRed(
-        `Modules have changed since the last snapshot. ` +
-          `Run the command without 'check' to take a new snapshot.`,
-      ),
-    );
-    process.exit(1);
+  if (args.subcommand === "ci") {
+    console.error(makeRed("Modules have changed since the last snapshot."));
+    console.log("Run 'npx skir snapshot' to take a new snapshot.");
+    return false;
+  } else if (args.subcommand === "dry-run") {
+    console.log(makeGreen("Changes detected since last snapshot."));
+    console.log("No breaking changes found.");
+    return true;
   }
   await writeFile(snapshotPath, JSON.stringify(newSnapshot, null, 2), "utf-8");
   console.log("Snapshot taken. No breaking changes detected.");
+  return true;
 }
 
-async function readLastSnapshot(snapshotPath: string): Promise<
-  | ModuleSet
-  | {
-      kind: "corrupted";
-      error: any;
+interface CorruptedError {
+  kind: "corrupted";
+  error: any;
+}
+
+async function readLastSnapshot(
+  snapshotPath: string,
+): Promise<ModuleSet | CorruptedError> {
+  let textContent: string;
+  try {
+    textContent = await readFile(snapshotPath, "utf-8");
+  } catch (error) {
+    const isNotFoundError =
+      error instanceof Error && "code" in error && error.code === "ENOENT";
+    if (isNotFoundError) {
+      return ModuleSet.fromMap(new Map<string, string>());
+    } else {
+      // Rethrow I/O error
+      throw error;
     }
-> {
+  }
+  return snapshotFileContentToModuleSet(textContent);
+}
+
+export function snapshotFileContentToModuleSet(
+  fileContent: string,
+): ModuleSet | CorruptedError {
   let snapshot: Snapshot;
   try {
-    const textContent = await readFile(snapshotPath, "utf-8");
-    snapshot = JSON.parse(textContent);
+    snapshot = JSON.parse(fileContent);
   } catch (error) {
     if (error instanceof SyntaxError) {
       return {
         kind: "corrupted",
         error: error,
       };
-    }
-    const isNotFoundError =
-      error instanceof Error && "code" in error && error.code === "ENOENT";
-    if (isNotFoundError) {
-      return ModuleSet.fromMap(new Map<string, string>());
     } else {
-      // Rethrow I/O error
       throw error;
     }
   }