spec-snake 0.0.1-beta.0

package/dist/types.js

@@ -0,0 +1,99 @@
+/**
+ * Core type definitions for spec-snake
+ *
+ * This module defines all TypeScript types used throughout the application,
+ * including form fields, sections, steps, scenarios, and configuration.
+ *
+ * @module types
+ */
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Helper function to define a scenario with type-safe formData
+ *
+ * This function uses TypeScript's const type parameters to infer
+ * literal types from the steps array, enabling type-safe access
+ * to formData in hooks, prompts, and overrides.
+ *
+ * **Usage**: Define your steps with `as const satisfies Step[]` for best results.
+ *
+ * @example
+ * ```ts
+ * import { defineScenario, type Step, type Config } from '@cut0/spec-snake';
+ *
+ * const steps = [
+ *   {
+ *     slug: 'basic-info',
+ *     title: 'Basic Info',
+ *     description: 'Enter basic information',
+ *     section: {
+ *       type: 'single',
+ *       name: 'basicInfo',
+ *       fields: [
+ *         { id: 'projectName', type: 'input', label: 'Project Name', description: '' },
+ *         { id: 'overview', type: 'textarea', label: 'Overview', description: '' },
+ *       ],
+ *     },
+ *   },
+ *   {
+ *     slug: 'features',
+ *     title: 'Features',
+ *     description: 'List features',
+ *     section: {
+ *       type: 'array',
+ *       name: 'features',
+ *       fields: [
+ *         { id: 'name', type: 'input', label: 'Feature Name', description: '' },
+ *       ],
+ *     },
+ *   },
+ * ] as const satisfies Step[];
+ *
+ * const scenario = defineScenario({
+ *   id: 'my-scenario',
+ *   name: 'My Scenario',
+ *   steps,
+ *   prompt: '...',
+ *   outputDir: 'docs',
+ *   overrides: {
+ *     filename: ({ formData }) => {
+ *       // formData is now type-safe!
+ *       // formData.basicInfo?.projectName is typed as string | undefined
+ *       return `${formData.basicInfo?.projectName ?? 'untitled'}.md`;
+ *     },
+ *   },
+ * });
+ *
+ * const config: Config = {
+ *   scenarios: [scenario],
+ *   permissions: { allowSave: true },
+ * };
+ * ```
+ */
+export function defineScenario(scenario) {
+    return scenario;
+}
+/**
+ * Helper function to define a config object
+ *
+ * This is a simple identity function that provides better type inference
+ * and editor support when defining config files.
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, defineScenario } from '@cut0/spec-snake';
+ *
+ * export default defineConfig({
+ *   scenarios: [
+ *     defineScenario({ ... }),
+ *   ],
+ *   permissions: {
+ *     allowSave: true,
+ *   },
+ * });
+ * ```
+ */
+export function defineConfig(config) {
+    return config;
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "spec-snake",
+  "version": "0.0.1-beta.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cut0/spec-snake.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./dist/types.d.ts",
+  "main": "./dist/types.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "default": "./dist/types.js"
+    }
+  },
+  "bin": {
+    "spec-snake": "./dist/cli.js"
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "pnpm build:types && pnpm build:cli && pnpm build:client",
+    "build:cli": "tsx scripts/build-cli.ts",
+    "build:client": "vite build",
+    "build:types": "tsc src/types.ts --declaration --outDir dist --skipLibCheck --module ESNext --moduleResolution bundler --target ES2022",
+    "dev": "NODE_ENV=development SPEC_SNAKE_CONFIG=examples/spec-snake.ts vite",
+    "prd": "pnpm build && pnpm build:client && node dist/cli.js",
+    "i18n": "lingui extract && lingui compile",
+    "i18n:compile": "lingui compile",
+    "i18n:extract": "lingui extract",
+    "lint:check": "biome check .",
+    "lint:fix": "biome check --write .",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "pnpm build",
+    "release": "pnpm build && changeset publish"
+  },
+  "dependencies": {
+    "@anthropic-ai/claude-agent-sdk": "0.1.75",
+    "@hono/node-server": "1.19.7",
+    "citty": "0.1.6",
+    "consola": "3.4.2",
+    "hono": "4.11.1",
+    "jiti": "2.6.1",
+    "valibot": "1.2.0"
+  },
+  "devDependencies": {
+    "@base-ui/react": "1.0.0",
+    "@biomejs/biome": "1.9.4",
+    "@changesets/cli": "2.28.1",
+    "@hono/vite-dev-server": "0.23.0",
+    "@hookform/resolvers": "5.2.2",
+    "@lingui/babel-plugin-lingui-macro": "5.7.0",
+    "@lingui/cli": "5.7.0",
+    "@lingui/conf": "5.7.0",
+    "@lingui/core": "5.7.0",
+    "@lingui/react": "5.7.0",
+    "@lingui/vite-plugin": "5.7.0",
+    "@tailwindcss/typography": "0.5.19",
+    "@tailwindcss/vite": "4.1.18",
+    "@tanstack/react-query": "5.35.1",
+    "@tanstack/react-router": "1.141.6",
+    "@tanstack/router-plugin": "1.141.7",
+    "@types/node": "^25.0.3",
+    "@types/react": "19.1.8",
+    "@types/react-dom": "19.1.6",
+    "@vitejs/plugin-react": "4.5.2",
+    "esbuild": "0.27.2",
+    "motion": "12.23.26",
+    "react": "19.2.3",
+    "react-dom": "19.2.3",
+    "react-hook-form": "7.69.0",
+    "react-markdown": "10.1.0",
+    "remark-gfm": "4.0.1",
+    "tailwindcss": "4.1.18",
+    "tsx": "4.20.6",
+    "typescript": "5.8.3",
+    "vite": "7.3.0",
+    "zustand": "5.0.9"
+  },
+  "packageManager": "pnpm@10.26.2"
+}