@sprig-and-prose/create-scene-tutorial 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @sprig-and-prose/create-scene-tutorial
+
+## 0.1.1
+
+### Patch Changes
+
+- 9557987: Add dataset expectations, sprig-edge initial commit, and scene tutorial scaffolder

package/dist/index.js

@@ -0,0 +1,176 @@
+#!/usr/bin/env node
+import { mkdir, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+const UNIVERSE_PROSE = `universe DemoUniverse {
+  note {
+    Tutorial for sprig scene attestations.
+    
+    This universe demonstrates how to use sprig-edge
+    to validate data files against scene expectations.
+  }
+}
+`;
+const DEMO_SCENE_PROSE = `scene DemoScene {
+  locations {
+    GameDataFiles {
+      kind { 'files' }
+    }
+  }
+
+  actors {
+    Item {
+      kind {
+        id { integer }
+        name { string }
+      }
+      
+      identity { id }
+      
+      expects {
+        project {
+          to { GameDataFiles }
+          as { dataset { Items } }
+        }
+      }
+    }
+  }
+
+  portals {
+    Items {
+      kind { [ Item ] }
+    }
+  }
+}
+`;
+const EQUIPMENT_YAML = `- id: 1
+  name: "Iron Sword"
+- id: 2
+  name: "Wooden Shield"
+`;
+const RESOURCES_YAML = `- id: 10
+  name: "Gold Coin"
+- id: 11
+  name: "Health Potion"
+`;
+const EDGE_CONFIG = {
+    version: 1,
+    defaults: {
+        attestationsDir: "artifacts",
+        appDir: "app",
+    },
+    scenes: [
+        {
+            scene: "DemoScene",
+            manifestPath: "artifacts/DemoScene.scene.json",
+            attestationsPath: "artifacts/DemoScene.attestations.json",
+            locations: {
+                GameDataFiles: { baseDir: "app/data" },
+            },
+            datasets: {
+                Items: {
+                    files: ["items/equipment.yaml", "items/resources.yaml"],
+                    format: "yaml",
+                    mode: "array",
+                },
+            },
+        },
+    ],
+};
+const PACKAGE_JSON = {
+    name: "sprig-scene-tutorial",
+    version: "1.0.0",
+    type: "module",
+    scripts: {
+        compile: "sprig compile sprig --out artifacts",
+        attest: "sprig-edge attest",
+        check: "sprig-edge check",
+    },
+    devDependencies: {
+        "@sprig-and-prose/sprig": "*",
+        "@sprig-and-prose/sprig-edge": "*",
+    },
+};
+const GITIGNORE = `node_modules/
+dist/
+.DS_Store
+`;
+const README = `# Sprig Scene Tutorial
+
+This tutorial demonstrates how to use sprig-edge to validate data files against scene expectations.
+
+## Quick Start
+
+\`\`\`bash
+npm install
+npm run compile
+npm run attest
+npm run check
+\`\`\`
+
+## What's Included
+
+- **sprig/**: Truth definitions (universe and scene prose files)
+- **app/**: Edge application data files
+- **artifacts/**: Compiled manifests and attestations
+
+## Commands
+
+- \`npm run compile\`: Compile prose files to JSON manifests
+- \`npm run attest\`: Generate attestations from data files
+- \`npm run check\`: Check expectations against attestations
+
+## Learn More
+
+- [Sprig Documentation](https://sprig-and-prose.io)
+- [Scene Engine Guide](https://sprig-and-prose.io/scenes)
+`;
+async function createTutorial(targetDir) {
+    try {
+        // Create directory structure
+        await mkdir(join(targetDir, "sprig"), { recursive: true });
+        await mkdir(join(targetDir, "app", "data", "items"), { recursive: true });
+        await mkdir(join(targetDir, "artifacts"), { recursive: true });
+        // Write prose files
+        await writeFile(join(targetDir, "sprig", "universe.prose"), UNIVERSE_PROSE, "utf-8");
+        await writeFile(join(targetDir, "sprig", "DemoScene.scene.prose"), DEMO_SCENE_PROSE, "utf-8");
+        // Write data files
+        await writeFile(join(targetDir, "app", "data", "items", "equipment.yaml"), EQUIPMENT_YAML, "utf-8");
+        await writeFile(join(targetDir, "app", "data", "items", "resources.yaml"), RESOURCES_YAML, "utf-8");
+        // Write config files
+        await writeFile(join(targetDir, "sprig.edge.json"), JSON.stringify(EDGE_CONFIG, null, 2), "utf-8");
+        await writeFile(join(targetDir, "package.json"), JSON.stringify(PACKAGE_JSON, null, 2), "utf-8");
+        await writeFile(join(targetDir, ".gitignore"), GITIGNORE, "utf-8");
+        await writeFile(join(targetDir, "README.md"), README, "utf-8");
+        // Print success message
+        console.log(`✓ Tutorial created in ${targetDir}/`);
+        console.log("");
+        console.log("Next steps:");
+        console.log(`  cd ${targetDir}`);
+        console.log("  npm install");
+        console.log("  npm run compile");
+        console.log("  npm run attest");
+        console.log("  npm run check");
+        console.log("");
+        console.log("Learn more: https://sprig-and-prose.io/scenes");
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error(`Error creating tutorial: ${message}`);
+        process.exit(1);
+    }
+}
+async function main() {
+    const args = process.argv.slice(2);
+    // Default directory name
+    let targetDir = "sprig-scene-tutorial";
+    // Check for custom directory name
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (!arg.startsWith("-")) {
+            targetDir = arg;
+            break;
+        }
+    }
+    await createTutorial(targetDir);
+}
+main();

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@sprig-and-prose/create-scene-tutorial",
+  "version": "0.1.1",
+  "type": "module",
+  "description": "Scaffolder for Sprig scene tutorial projects",
+  "main": "dist/index.js",
+  "bin": {
+    "create-scene-tutorial": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "sprig",
+    "tutorial",
+    "scaffolder",
+    "create"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,210 @@
+#!/usr/bin/env node
+
+import { mkdir, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+
+const UNIVERSE_PROSE = `universe DemoUniverse {
+  note {
+    Tutorial for sprig scene attestations.
+    
+    This universe demonstrates how to use sprig-edge
+    to validate data files against scene expectations.
+  }
+}
+`;
+
+const DEMO_SCENE_PROSE = `scene DemoScene {
+  locations {
+    GameDataFiles {
+      kind { 'files' }
+    }
+  }
+
+  actors {
+    Item {
+      kind {
+        id { integer }
+        name { string }
+      }
+      
+      identity { id }
+      
+      expects {
+        project {
+          to { GameDataFiles }
+          as { dataset { Items } }
+        }
+      }
+    }
+  }
+
+  portals {
+    Items {
+      kind { [ Item ] }
+    }
+  }
+}
+`;
+
+const EQUIPMENT_YAML = `- id: 1
+  name: "Iron Sword"
+- id: 2
+  name: "Wooden Shield"
+`;
+
+const RESOURCES_YAML = `- id: 10
+  name: "Gold Coin"
+- id: 11
+  name: "Health Potion"
+`;
+
+const EDGE_CONFIG = {
+  version: 1,
+  defaults: {
+    attestationsDir: "artifacts",
+    appDir: "app",
+  },
+  scenes: [
+    {
+      scene: "DemoScene",
+      manifestPath: "artifacts/DemoScene.scene.json",
+      attestationsPath: "artifacts/DemoScene.attestations.json",
+      locations: {
+        GameDataFiles: { baseDir: "app/data" },
+      },
+      datasets: {
+        Items: {
+          files: ["items/equipment.yaml", "items/resources.yaml"],
+          format: "yaml",
+          mode: "array",
+        },
+      },
+    },
+  ],
+};
+
+const PACKAGE_JSON = {
+  name: "sprig-scene-tutorial",
+  version: "1.0.0",
+  type: "module",
+  scripts: {
+    compile: "sprig compile sprig --out artifacts",
+    attest: "sprig-edge attest",
+    check: "sprig-edge check",
+  },
+  devDependencies: {
+    "@sprig-and-prose/sprig": "*",
+    "@sprig-and-prose/sprig-edge": "*",
+  },
+};
+
+const GITIGNORE = `node_modules/
+dist/
+.DS_Store
+`;
+
+const README = `# Sprig Scene Tutorial
+
+This tutorial demonstrates how to use sprig-edge to validate data files against scene expectations.
+
+## Quick Start
+
+\`\`\`bash
+npm install
+npm run compile
+npm run attest
+npm run check
+\`\`\`
+
+## What's Included
+
+- **sprig/**: Truth definitions (universe and scene prose files)
+- **app/**: Edge application data files
+- **artifacts/**: Compiled manifests and attestations
+
+## Commands
+
+- \`npm run compile\`: Compile prose files to JSON manifests
+- \`npm run attest\`: Generate attestations from data files
+- \`npm run check\`: Check expectations against attestations
+
+## Learn More
+
+- [Sprig Documentation](https://sprig-and-prose.io)
+- [Scene Engine Guide](https://sprig-and-prose.io/scenes)
+`;
+
+async function createTutorial(targetDir: string): Promise<void> {
+  try {
+    // Create directory structure
+    await mkdir(join(targetDir, "sprig"), { recursive: true });
+    await mkdir(join(targetDir, "app", "data", "items"), { recursive: true });
+    await mkdir(join(targetDir, "artifacts"), { recursive: true });
+
+    // Write prose files
+    await writeFile(join(targetDir, "sprig", "universe.prose"), UNIVERSE_PROSE, "utf-8");
+    await writeFile(join(targetDir, "sprig", "DemoScene.scene.prose"), DEMO_SCENE_PROSE, "utf-8");
+
+    // Write data files
+    await writeFile(
+      join(targetDir, "app", "data", "items", "equipment.yaml"),
+      EQUIPMENT_YAML,
+      "utf-8",
+    );
+    await writeFile(
+      join(targetDir, "app", "data", "items", "resources.yaml"),
+      RESOURCES_YAML,
+      "utf-8",
+    );
+
+    // Write config files
+    await writeFile(
+      join(targetDir, "sprig.edge.json"),
+      JSON.stringify(EDGE_CONFIG, null, 2),
+      "utf-8",
+    );
+    await writeFile(
+      join(targetDir, "package.json"),
+      JSON.stringify(PACKAGE_JSON, null, 2),
+      "utf-8",
+    );
+    await writeFile(join(targetDir, ".gitignore"), GITIGNORE, "utf-8");
+    await writeFile(join(targetDir, "README.md"), README, "utf-8");
+
+    // Print success message
+    console.log(`✓ Tutorial created in ${targetDir}/`);
+    console.log("");
+    console.log("Next steps:");
+    console.log(`  cd ${targetDir}`);
+    console.log("  npm install");
+    console.log("  npm run compile");
+    console.log("  npm run attest");
+    console.log("  npm run check");
+    console.log("");
+    console.log("Learn more: https://sprig-and-prose.io/scenes");
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(`Error creating tutorial: ${message}`);
+    process.exit(1);
+  }
+}
+
+async function main() {
+  const args = process.argv.slice(2);
+
+  // Default directory name
+  let targetDir = "sprig-scene-tutorial";
+
+  // Check for custom directory name
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (!arg.startsWith("-")) {
+      targetDir = arg;
+      break;
+    }
+  }
+
+  await createTutorial(targetDir);
+}
+
+main();

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "lib": ["ES2022"],
+    "moduleResolution": "bundler",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}