@xenonbyte/da-vinci-workflow 0.1.2

package/lib/install.js

@@ -0,0 +1,286 @@
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+
+const REPO_ROOT = path.resolve(__dirname, "..");
+const PACKAGE_JSON = require(path.join(REPO_ROOT, "package.json"));
+const VERSION = PACKAGE_JSON.version;
+
+const REQUIRED_FILES = [
+  "SKILL.md",
+  "README.md",
+  "agents/openai.yaml",
+  "commands/claude/da-vinci.md",
+  "commands/claude/dv/breakdown.md",
+  "commands/claude/dv/build.md",
+  "commands/claude/dv/design.md",
+  "commands/claude/dv/tasks.md",
+  "commands/claude/dv/verify.md",
+  "commands/codex/prompts/da-vinci.md",
+  "commands/codex/prompts/dv-breakdown.md",
+  "commands/codex/prompts/dv-build.md",
+  "commands/codex/prompts/dv-design.md",
+  "commands/codex/prompts/dv-tasks.md",
+  "commands/codex/prompts/dv-verify.md",
+  "commands/gemini/da-vinci.toml",
+  "commands/gemini/dv/breakdown.toml",
+  "commands/gemini/dv/build.toml",
+  "commands/gemini/dv/design.toml",
+  "commands/gemini/dv/tasks.toml",
+  "commands/gemini/dv/verify.toml",
+  "references/artifact-templates.md",
+  "references/checkpoints.md",
+  "references/design-inputs.md",
+  "references/modes.md",
+  "references/page-mapping.md",
+  "references/pencil-design-to-code.md",
+  "references/platform-adapters.md"
+];
+
+function resolveHome(homeDir) {
+  return homeDir || process.env.HOME || os.homedir();
+}
+
+function parsePlatforms(raw) {
+  if (!raw || raw === "all") {
+    return ["codex", "claude", "gemini"];
+  }
+
+  const platforms = raw
+    .split(",")
+    .map((value) => value.trim())
+    .filter(Boolean);
+
+  const unique = [...new Set(platforms)];
+  const invalid = unique.filter((value) => !["codex", "claude", "gemini"].includes(value));
+
+  if (invalid.length > 0) {
+    throw new Error(`Unsupported platform value: ${invalid.join(", ")}`);
+  }
+
+  return unique;
+}
+
+function ensureDir(targetPath) {
+  fs.mkdirSync(targetPath, { recursive: true });
+}
+
+function copyFile(sourcePath, targetPath) {
+  ensureDir(path.dirname(targetPath));
+  fs.copyFileSync(sourcePath, targetPath);
+}
+
+function copyDir(sourceDir, targetDir) {
+  ensureDir(path.dirname(targetDir));
+  fs.rmSync(targetDir, { recursive: true, force: true });
+  fs.cpSync(sourceDir, targetDir, { recursive: true });
+}
+
+function copyNamedFiles(sourceDir, targetDir, fileNames) {
+  ensureDir(targetDir);
+  for (const fileName of fileNames) {
+    copyFile(path.join(sourceDir, fileName), path.join(targetDir, fileName));
+  }
+}
+
+function removePath(targetPath) {
+  fs.rmSync(targetPath, { recursive: true, force: true });
+}
+
+function tryRemoveEmptyDir(targetPath) {
+  try {
+    fs.rmdirSync(targetPath);
+  } catch (error) {
+    if (error && error.code !== "ENOTEMPTY" && error.code !== "ENOENT") {
+      throw error;
+    }
+  }
+}
+
+function listFiles(dirPath) {
+  return fs.readdirSync(dirPath, { withFileTypes: true }).flatMap((entry) => {
+    const fullPath = path.join(dirPath, entry.name);
+    if (entry.isDirectory()) {
+      return listFiles(fullPath);
+    }
+    return [fullPath];
+  });
+}
+
+function installCodex(homeDir) {
+  const promptsTarget = path.join(homeDir, ".codex", "prompts");
+  const skillTarget = path.join(homeDir, ".codex", "skills", "da-vinci");
+  const promptsSource = path.join(REPO_ROOT, "commands", "codex", "prompts");
+
+  ensureDir(promptsTarget);
+  for (const filePath of listFiles(promptsSource)) {
+    copyFile(filePath, path.join(promptsTarget, path.basename(filePath)));
+  }
+
+  ensureDir(skillTarget);
+  copyFile(path.join(REPO_ROOT, "SKILL.md"), path.join(skillTarget, "SKILL.md"));
+  copyDir(path.join(REPO_ROOT, "agents"), path.join(skillTarget, "agents"));
+  copyDir(path.join(REPO_ROOT, "references"), path.join(skillTarget, "references"));
+  copyDir(path.join(REPO_ROOT, "docs"), path.join(skillTarget, "docs"));
+  copyDir(path.join(REPO_ROOT, "examples"), path.join(skillTarget, "examples"));
+}
+
+function uninstallCodex(homeDir) {
+  const promptsTarget = path.join(homeDir, ".codex", "prompts");
+  const skillTarget = path.join(homeDir, ".codex", "skills", "da-vinci");
+  const promptFiles = [
+    "da-vinci.md",
+    "dv-breakdown.md",
+    "dv-build.md",
+    "dv-design.md",
+    "dv-tasks.md",
+    "dv-verify.md"
+  ];
+
+  for (const fileName of promptFiles) {
+    removePath(path.join(promptsTarget, fileName));
+  }
+
+  removePath(skillTarget);
+}
+
+function installClaude(homeDir) {
+  const commandsTarget = path.join(homeDir, ".claude", "commands");
+  const dvTarget = path.join(commandsTarget, "dv");
+  ensureDir(commandsTarget);
+  copyFile(
+    path.join(REPO_ROOT, "commands", "claude", "da-vinci.md"),
+    path.join(commandsTarget, "da-vinci.md")
+  );
+  copyNamedFiles(path.join(REPO_ROOT, "commands", "claude", "dv"), dvTarget, [
+    "breakdown.md",
+    "build.md",
+    "design.md",
+    "tasks.md",
+    "verify.md"
+  ]);
+}
+
+function uninstallClaude(homeDir) {
+  const commandsTarget = path.join(homeDir, ".claude", "commands");
+  removePath(path.join(commandsTarget, "da-vinci.md"));
+  removePath(path.join(commandsTarget, "dv", "breakdown.md"));
+  removePath(path.join(commandsTarget, "dv", "build.md"));
+  removePath(path.join(commandsTarget, "dv", "design.md"));
+  removePath(path.join(commandsTarget, "dv", "tasks.md"));
+  removePath(path.join(commandsTarget, "dv", "verify.md"));
+  tryRemoveEmptyDir(path.join(commandsTarget, "dv"));
+}
+
+function installGemini(homeDir) {
+  const commandsTarget = path.join(homeDir, ".gemini", "commands");
+  const dvTarget = path.join(commandsTarget, "dv");
+  ensureDir(commandsTarget);
+  copyFile(
+    path.join(REPO_ROOT, "commands", "gemini", "da-vinci.toml"),
+    path.join(commandsTarget, "da-vinci.toml")
+  );
+  copyNamedFiles(path.join(REPO_ROOT, "commands", "gemini", "dv"), dvTarget, [
+    "breakdown.toml",
+    "build.toml",
+    "design.toml",
+    "tasks.toml",
+    "verify.toml"
+  ]);
+}
+
+function uninstallGemini(homeDir) {
+  const commandsTarget = path.join(homeDir, ".gemini", "commands");
+  removePath(path.join(commandsTarget, "da-vinci.toml"));
+  removePath(path.join(commandsTarget, "dv", "breakdown.toml"));
+  removePath(path.join(commandsTarget, "dv", "build.toml"));
+  removePath(path.join(commandsTarget, "dv", "design.toml"));
+  removePath(path.join(commandsTarget, "dv", "tasks.toml"));
+  removePath(path.join(commandsTarget, "dv", "verify.toml"));
+  tryRemoveEmptyDir(path.join(commandsTarget, "dv"));
+}
+
+const INSTALLERS = {
+  codex: installCodex,
+  claude: installClaude,
+  gemini: installGemini
+};
+
+const UNINSTALLERS = {
+  codex: uninstallCodex,
+  claude: uninstallClaude,
+  gemini: uninstallGemini
+};
+
+function installPlatforms(platforms, options = {}) {
+  const homeDir = resolveHome(options.homeDir);
+  const selectedPlatforms = parsePlatforms(platforms);
+
+  for (const platform of selectedPlatforms) {
+    INSTALLERS[platform](homeDir);
+  }
+
+  return {
+    version: VERSION,
+    homeDir,
+    platforms: selectedPlatforms
+  };
+}
+
+function uninstallPlatforms(platforms, options = {}) {
+  const homeDir = resolveHome(options.homeDir);
+  const selectedPlatforms = parsePlatforms(platforms);
+
+  for (const platform of selectedPlatforms) {
+    UNINSTALLERS[platform](homeDir);
+  }
+
+  return {
+    version: VERSION,
+    homeDir,
+    platforms: selectedPlatforms
+  };
+}
+
+function getStatus(options = {}) {
+  const homeDir = resolveHome(options.homeDir);
+  return {
+    version: VERSION,
+    homeDir,
+    codex: {
+      prompt: fs.existsSync(path.join(homeDir, ".codex", "prompts", "da-vinci.md")),
+      skill: fs.existsSync(path.join(homeDir, ".codex", "skills", "da-vinci", "SKILL.md"))
+    },
+    claude: {
+      command: fs.existsSync(path.join(homeDir, ".claude", "commands", "da-vinci.md")),
+      actionSet: fs.existsSync(path.join(homeDir, ".claude", "commands", "dv", "design.md"))
+    },
+    gemini: {
+      command: fs.existsSync(path.join(homeDir, ".gemini", "commands", "da-vinci.toml")),
+      actionSet: fs.existsSync(path.join(homeDir, ".gemini", "commands", "dv", "design.toml"))
+    }
+  };
+}
+
+function validateAssets() {
+  const missing = REQUIRED_FILES.filter((relativePath) => {
+    return !fs.existsSync(path.join(REPO_ROOT, relativePath));
+  });
+
+  if (missing.length > 0) {
+    throw new Error(`Missing required assets:\n${missing.join("\n")}`);
+  }
+
+  return {
+    version: VERSION,
+    requiredAssets: REQUIRED_FILES.length
+  };
+}
+
+module.exports = {
+  VERSION,
+  installPlatforms,
+  uninstallPlatforms,
+  getStatus,
+  validateAssets
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@xenonbyte/da-vinci-workflow",
+  "version": "0.1.2",
+  "description": "Requirement-to-design-to-code workflow skill for Codex, Claude, and Gemini",
+  "bin": {
+    "da-vinci": "bin/da-vinci.js"
+  },
+  "files": [
+    "SKILL.md",
+    "README.md",
+    "agents",
+    "commands",
+    "references",
+    "docs",
+    "examples",
+    "bin",
+    "lib",
+    "scripts",
+    ".npmrc"
+  ],
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js",
+    "validate-assets": "node scripts/validate-assets.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/references/artifact-templates.md

@@ -0,0 +1,364 @@
+# Artifact Templates
+
+Use these templates as the default artifact shapes for Da Vinci.
+
+Keep headings stable unless the project requires a different schema.
+
+## `brainstorm.md`
+
+Use this structure:
+
+```md
+# Brainstorm
+
+## Inputs
+- Raw user ideas
+- Repeated themes
+
+## Product Direction
+- Stable goals
+- Open questions
+
+## Candidate Pages
+- Candidate page list
+
+## Candidate Flows
+- Candidate user flows
+
+## Risks And Unknowns
+- Ambiguities
+- Conflicts
+- Deferred ideas
+```
+
+Use this artifact only when ideas are still being synthesized.
+
+## `project-inventory.md`
+
+Use this structure:
+
+```md
+# Project Inventory
+
+## Current Product
+- Product summary
+
+## Routes And Pages
+- Route
+- Page purpose
+
+## UI Regions
+- Shared layout regions
+- Repeated page patterns
+
+## Technical Constraints
+- Existing stack
+- Existing design system
+
+## Redesign Impact
+- Preserve
+- Replace
+- Review later
+```
+
+Use this artifact when redesign starts from an existing codebase.
+
+## `design-brief.md`
+
+Use this structure:
+
+```md
+# Design Brief
+
+## Product Form Factor
+- desktop software
+- web app
+- tablet
+- mobile app
+
+## Visual Direction
+- tone
+- density
+- visual references
+
+## Brand Constraints
+- existing brand
+- color direction
+- typography constraints
+
+## Layout Priorities
+- desktop-first or mobile-first
+- workspace density
+- responsiveness expectations
+
+## Notes
+- explicit user preferences
+- inferred preferences
+```
+
+Use this artifact whenever the project is new or the design direction is not obvious from the existing product.
+
+## `design-registry.md`
+
+Use this structure:
+
+```md
+# Design Registry
+
+## Active Design Sources
+- `.pen` file path
+- status
+- purpose
+
+## Preferred Design Source
+- Which `.pen` file is authoritative
+
+## Historical Or Secondary Sources
+- Legacy files
+- Alternate explorations
+
+## Notes
+- Why a source is active
+- Whether a source is safe to iterate
+```
+
+Use this artifact whenever a project can have one or more Pencil sources.
+
+## `page-map.md`
+
+Use this structure:
+
+```md
+# Page Map
+
+## Canonical Pages
+- Page name
+- Route or identifier
+- Purpose
+
+## States Per Page
+- Empty
+- Loading
+- Success
+- Error
+- Restricted
+
+## Shared Sections
+- Header
+- Sidebar
+- Footer
+- Shared workspace regions
+
+## Page Priority
+- Core pages
+- Supporting pages
+```
+
+Use this artifact for every mode. It is the canonical page list.
+
+## `proposal.md`
+
+Use this structure:
+
+```md
+# Proposal
+
+## Change
+- Name:
+- Owner:
+- Date:
+
+## Goal
+- What this change must achieve
+
+## Non-Goals
+- What this change will not cover
+
+## User Value
+- Why this matters
+
+## Scope
+- Pages
+- Flows
+- Integrations
+
+## Risks
+- Security
+- Migration
+- Delivery
+
+## Success Criteria
+- Observable outcomes
+```
+
+## `specs/<capability>/spec.md`
+
+Use this structure:
+
+```md
+# Spec
+
+## Capability
+- Name
+
+## Behavior
+- Core behavior rules
+
+## States
+- Empty
+- Loading
+- Success
+- Error
+- Restricted
+
+## Inputs
+- User inputs
+- External inputs
+
+## Outputs
+- User-visible results
+- System-visible results
+
+## Acceptance
+- Clear testable conditions
+
+## Edge Cases
+- Failure paths
+- Boundary conditions
+```
+
+Write behavior in direct, testable language.
+
+## `design.md`
+
+Use this structure:
+
+```md
+# Design
+
+## Page Map
+- Pages and sections
+
+## Interaction Model
+- Primary actions
+- Secondary actions
+- State transitions
+
+## Layout Strategy
+- Major regions
+- Responsive notes
+
+## Component Strategy
+- Reusable blocks
+- Page-specific blocks
+
+## Content Notes
+- Key text
+- Priority order
+
+## Open Questions
+- Unresolved design decisions
+```
+
+## `pencil-design.md`
+
+Use this structure:
+
+```md
+# Pencil Design
+
+## Source
+- `.pen` file path
+- Active pages
+
+## Page Mapping
+- Requirement -> Pencil page
+
+## Screens
+- Screen name
+- Purpose
+- Notes
+
+## States Represented
+- Which states are drawn
+- Which states still need design coverage
+
+## Screenshots
+- Reference image paths or exported nodes
+
+## Implementation Notes
+- Important layout or styling constraints to preserve in code
+```
+
+## `tasks.md`
+
+Use this structure:
+
+```md
+# Tasks
+
+## 1. Setup
+- [ ] Project or page setup
+
+## 2. UI Structure
+- [ ] Implement major sections from Pencil
+
+## 3. Behavior
+- [ ] Implement states and interactions from spec
+
+## 4. Integration
+- [ ] Wire required data or services
+
+## 5. Verification
+- [ ] Check requirement coverage
+- [ ] Check Pencil coverage
+```
+
+Prefer top-level task groups. They are required for execution checkpoints.
+
+## `pencil-bindings.md`
+
+Use this structure:
+
+```md
+# Pencil Bindings
+
+## Source
+- `.pen` file path
+
+## Bindings
+- implementation page or route -> Pencil page or screen
+
+## Shared Bindings
+- shared layout or component -> Pencil region
+
+## Notes
+- intentional deviations
+- pages without Pencil coverage yet
+```
+
+Use this artifact whenever implementation must trace back to Pencil pages.
+
+## `verification.md`
+
+Use this structure:
+
+```md
+# Verification
+
+## Requirement Coverage
+- Covered items
+- Missing items
+
+## Pencil Coverage
+- Matched sections
+- Design drift
+
+## Behavior Drift
+- Scope expansions
+- Missing states
+
+## Outcome
+- PASS / WARN / BLOCK
+- Next action
+```