specifian 0.1.0-beta.0

package/examples/specs/screens/login.excalidraw

@@ -0,0 +1,282 @@
+{
+  "type": "excalidraw",
+  "version": 2,
+  "source": "http://localhost:4400",
+  "elements": [
+    {
+      "id": "frame",
+      "type": "rectangle",
+      "x": 80,
+      "y": 60,
+      "width": 360,
+      "height": 420,
+      "strokeColor": "#1e1e1e",
+      "backgroundColor": "transparent",
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "roundness": {
+        "type": 3
+      },
+      "version": 2,
+      "versionNonce": 85234903,
+      "index": "a0",
+      "isDeleted": false,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false
+    },
+    {
+      "id": "title",
+      "type": "text",
+      "x": 110,
+      "y": 100,
+      "width": 120,
+      "height": 36,
+      "text": "ログイン",
+      "fontSize": 28,
+      "fontFamily": 2,
+      "textAlign": "left",
+      "verticalAlign": "top",
+      "strokeColor": "#1e1e1e",
+      "version": 2,
+      "versionNonce": 1942816793,
+      "index": "a1",
+      "isDeleted": false,
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "backgroundColor": "transparent",
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "roundness": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false,
+      "containerId": null,
+      "originalText": "ログイン",
+      "autoResize": true,
+      "lineHeight": 1.2857142857142858
+    },
+    {
+      "id": "label-email",
+      "type": "text",
+      "x": 110,
+      "y": 170,
+      "width": 160,
+      "height": 20,
+      "text": "メールアドレス",
+      "fontSize": 16,
+      "fontFamily": 2,
+      "strokeColor": "#1e1e1e",
+      "version": 2,
+      "versionNonce": 1098506743,
+      "index": "a2",
+      "isDeleted": false,
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "backgroundColor": "transparent",
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "roundness": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false,
+      "textAlign": "left",
+      "verticalAlign": "top",
+      "containerId": null,
+      "originalText": "メールアドレス",
+      "autoResize": true,
+      "lineHeight": 1.25
+    },
+    {
+      "id": "input-email",
+      "type": "rectangle",
+      "x": 110,
+      "y": 196,
+      "width": 300,
+      "height": 44,
+      "strokeColor": "#1e1e1e",
+      "backgroundColor": "#f8f9fa",
+      "fillStyle": "solid",
+      "strokeWidth": 1,
+      "roundness": {
+        "type": 3
+      },
+      "version": 2,
+      "versionNonce": 352754937,
+      "index": "a3",
+      "isDeleted": false,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false
+    },
+    {
+      "id": "label-password",
+      "type": "text",
+      "x": 110,
+      "y": 264,
+      "width": 120,
+      "height": 20,
+      "text": "パスワード",
+      "fontSize": 16,
+      "fontFamily": 2,
+      "strokeColor": "#1e1e1e",
+      "version": 2,
+      "versionNonce": 435718935,
+      "index": "a4",
+      "isDeleted": false,
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "backgroundColor": "transparent",
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "roundness": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false,
+      "textAlign": "left",
+      "verticalAlign": "top",
+      "containerId": null,
+      "originalText": "パスワード",
+      "autoResize": true,
+      "lineHeight": 1.25
+    },
+    {
+      "id": "input-password",
+      "type": "rectangle",
+      "x": 110,
+      "y": 290,
+      "width": 300,
+      "height": 44,
+      "strokeColor": "#1e1e1e",
+      "backgroundColor": "#f8f9fa",
+      "fillStyle": "solid",
+      "strokeWidth": 1,
+      "roundness": {
+        "type": 3
+      },
+      "version": 2,
+      "versionNonce": 133862873,
+      "index": "a5",
+      "isDeleted": false,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false
+    },
+    {
+      "id": "button",
+      "type": "rectangle",
+      "x": 110,
+      "y": 380,
+      "width": 300,
+      "height": 48,
+      "strokeColor": "#1971c2",
+      "backgroundColor": "#a5d8ff",
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "roundness": {
+        "type": 3
+      },
+      "version": 2,
+      "versionNonce": 2063929399,
+      "index": "a6",
+      "isDeleted": false,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false
+    },
+    {
+      "id": "button-label",
+      "type": "text",
+      "x": 230,
+      "y": 392,
+      "width": 60,
+      "height": 24,
+      "text": "ログイン",
+      "fontSize": 18,
+      "fontFamily": 2,
+      "textAlign": "center",
+      "strokeColor": "#1971c2",
+      "version": 2,
+      "versionNonce": 1874621113,
+      "index": "a7",
+      "isDeleted": false,
+      "fillStyle": "solid",
+      "strokeWidth": 2,
+      "strokeStyle": "solid",
+      "roughness": 1,
+      "opacity": 100,
+      "angle": 0,
+      "backgroundColor": "transparent",
+      "seed": 1,
+      "groupIds": [],
+      "frameId": null,
+      "roundness": null,
+      "boundElements": [],
+      "updated": 1781158281255,
+      "link": null,
+      "locked": false,
+      "verticalAlign": "top",
+      "containerId": null,
+      "originalText": "ログイン",
+      "autoResize": true,
+      "lineHeight": 1.3333333333333333
+    }
+  ],
+  "appState": {
+    "gridSize": 20,
+    "gridStep": 5,
+    "gridModeEnabled": false,
+    "viewBackgroundColor": "#ffffff"
+  },
+  "files": {}
+}

package/examples/specs/screens/login.mdx

@@ -0,0 +1,37 @@
+---
+title: ログイン画面
+description: ユーザーが認証情報を入力するメイン画面
+screen:
+  route: /login
+  fields:
+    - { name: メールアドレス, type: email, required: true, description: "ユーザーのメールアドレス" }
+    - { name: パスワード, type: password, required: true, description: "アカウントのパスワード" }
+  actions:
+    - { name: ログイン, description: "認証情報を送信してログイン" }
+    - { name: パスワードリセットへ遷移, description: "パスワード忘却フロー" }
+---
+
+# {title}
+
+アカウント認証を行う最初の画面。メールアドレスとパスワードを入力し、サーバーで検証します。
+
+## ワイヤーフレーム
+
+<Drawing src="screens/login" />
+
+## 画面項目
+
+<DataView data={data.screen.fields} />
+
+## 振る舞い
+
+- **メールアドレス検証** — RFC 5322 に準拠したフォーマットチェック
+- **パスワード検証** — 最小 8 文字、空白不可
+- **失敗時エラーメッセージ** — メールアドレスまたはパスワードが不正な旨を通知
+- **レート制限** — 10 回失敗後 5 分間ブロック
+- **パスワード忘却** — クリックで `/reset-password` へ遷移
+
+## 関連スペック
+
+- [[tables:users]] — ユーザーテーブル定義
+- [[api:users-api]] — ユーザー認証 API

package/examples/specs/tables/_.mdx

@@ -0,0 +1,10 @@
+---
+title: テーブル定義
+description: データベーステーブルの一覧と仕様
+---
+
+# テーブル定義
+
+プロジェクトで使用するデータベーステーブルの定義をまとめています。各テーブルの構成、主キー、外部キー関係などを記載します。
+
+<SpecList category="tables" />

package/examples/specs/tables/_schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "テーブル定義スキーマ",
+  "description": "データベーステーブルの仕様を定義するスキーマ",
+  "type": "object",
+  "required": ["title", "table"],
+  "properties": {
+    "title": {
+      "type": "string",
+      "title": "タイトル",
+      "description": "テーブルのタイトル"
+    },
+    "description": {
+      "type": "string",
+      "title": "説明",
+      "description": "テーブルの説明"
+    },
+    "table": {
+      "type": "object",
+      "title": "テーブル定義",
+      "description": "テーブル定義",
+      "required": ["name", "columns"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "title": "テーブル名",
+          "description": "テーブル名（データベース側の実際の名前）"
+        },
+        "description": {
+          "type": "string",
+          "title": "テーブルの説明",
+          "description": "テーブルの詳細説明"
+        },
+        "columns": {
+          "type": "array",
+          "title": "カラム",
+          "minItems": 1,
+          "description": "カラムリスト",
+          "items": {
+            "type": "object",
+            "required": ["name", "type"],
+            "properties": {
+              "name": {
+                "type": "string",
+                "title": "カラム名",
+                "description": "カラム名"
+              },
+              "type": {
+                "type": "string",
+                "title": "型",
+                "description": "データ型（bigint、varchar など）"
+              },
+              "nullable": {
+                "type": "boolean",
+                "title": "NULL 許可",
+                "description": "NULL を許可するか"
+              },
+              "primaryKey": {
+                "type": "boolean",
+                "title": "主キー",
+                "description": "主キーであるか"
+              },
+              "default": {
+                "type": "string",
+                "title": "デフォルト値",
+                "description": "デフォルト値"
+              },
+              "description": {
+                "type": "string",
+                "title": "説明",
+                "description": "カラムの説明"
+              }
+            },
+            "additionalProperties": true
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true
+}

package/examples/specs/tables/_template.mdx

@@ -0,0 +1,19 @@
+---
+title: 新しいテーブル
+description: テーブルの説明
+table:
+  name: table_name
+  description: テーブルの説明
+  columns:
+    - { name: id, type: bigint, primaryKey: true, description: 主キー }
+    - { name: created_at, type: timestamp, nullable: false, description: 作成日時 }
+    - { name: updated_at, type: timestamp, nullable: false, description: 更新日時 }
+---
+
+# {title}
+
+<TableDefinition data={data.table} />
+
+## 補足説明
+
+テーブルの設計意図や特殊な取り扱いについて、ここに記載します。

package/examples/specs/tables/posts.mdx

@@ -0,0 +1,60 @@
+---
+title: posts テーブル
+description: ユーザーが投稿したコンテンツを管理するテーブル
+table:
+  name: posts
+  description: ユーザー投稿情報
+  columns:
+    - name: id
+      type: bigint
+      primaryKey: true
+      description: 主キー
+    - name: user_id
+      type: bigint
+      nullable: false
+      description: ユーザー ID（users テーブルへの外部キー）
+    - name: title
+      type: varchar(200)
+      nullable: false
+      description: 投稿タイトル
+    - name: body
+      type: text
+      nullable: false
+      description: 投稿本文
+    - name: status
+      type: varchar(20)
+      nullable: false
+      default: "'draft'"
+      description: 投稿ステータス（draft / published / archived）
+    - name: published_at
+      type: timestamp
+      nullable: true
+      description: 公開日時（公開前は NULL）
+    - name: created_at
+      type: timestamp
+      nullable: false
+      description: 作成日時
+    - name: updated_at
+      type: timestamp
+      nullable: false
+      description: 更新日時
+      primaryKey: false
+---
+
+# {title}
+
+ユーザーが投稿したコンテンツを管理するテーブル。ブログ記事やニュース投稿などに対応します。
+
+<TableDefinition data={data.table} />
+
+## 設計メモ
+
+- user_id は [[tables:users]] テーブルへの外部キーです
+- status のデフォルト値は 'draft' で、自動公開は行われません
+- published_at は公開予定日時の指定にも使えます
+- 論理削除が必要な場合は、status を 'archived' にして対応してください
+
+## 関連スペック
+
+- [[tables:users]] — 投稿者情報（user_id で参照）
+- [[api:posts-api]] — 投稿管理 API

package/examples/specs/tables/users.mdx

@@ -0,0 +1,34 @@
+---
+title: users テーブル
+description: ユーザーアカウント情報を管理するテーブル
+table:
+  name: users
+  description: ユーザーアカウント情報
+  columns:
+    - { name: id, type: bigint, primaryKey: true, description: 主キー }
+    - { name: email, type: varchar(255), nullable: false, description: メールアドレス（ユニーク制約） }
+    - { name: name, type: varchar(100), nullable: true, description: ユーザー名 }
+    - { name: role, type: varchar(20), nullable: false, default: "'member'", description: ロール（admin / moderator / member） }
+    - { name: created_at, type: timestamp, nullable: false, description: 作成日時 }
+    - { name: updated_at, type: timestamp, nullable: false, description: 更新日時 }
+---
+
+# {title}
+
+ユーザーアカウント情報を管理するメインテーブル。認証とアクセス制御に使用されます。
+
+<TableDefinition data={data.table} />
+
+<ColumnCount table={data.table} />
+
+## 設計メモ
+
+- メールアドレスはユニーク制約を設定し、重複登録を防止しています
+- 論理削除（soft delete）は実装せず、物理削除を前提としています
+- role はアプリケーションレベルで検証を行い、不正な値が入らないようにしてください
+- created_at / updated_at は自動タイムスタンプ管理を推奨します
+
+## 関連スペック
+
+- [[tables:posts]] — 投稿テーブル（user_id で参照）
+- [[api:users-api]] — ユーザー管理 API

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "specifian",
+  "version": "0.1.0-beta.0",
+  "description": "Spec-as-code documentation tool: render and edit local MDX specs with front-matter as structured design data",
+  "keywords": [
+    "documentation",
+    "mdx",
+    "specification",
+    "design-docs",
+    "frontmatter",
+    "wiki",
+    "scaffolding",
+    "mcp"
+  ],
+  "author": "Kengo Asamizu",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rabitarochan/specifian.git"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "bin": {
+    "specifian": "./dist/cli/index.js"
+  },
+  "files": [
+    "dist",
+    "examples"
+  ],
+  "scripts": {
+    "dev": "concurrently -k \"npm:dev:server\" \"npm:dev:client\"",
+    "dev:server": "node --watch --import tsx src/cli/index.ts serve --dir examples/specs --port 4399",
+    "dev:client": "vite",
+    "build": "tsup && vite build",
+    "typecheck": "tsc --noEmit",
+    "start": "node dist/cli/index.js serve --dir examples/specs",
+    "prepublishOnly": "npm run typecheck && npm run build",
+    "publish:beta": "npm version prerelease --preid=beta && npm publish --tag beta"
+  },
+  "dependencies": {
+    "@mdx-js/mdx": "^3.1.0",
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "@scaffdog/engine": "^4.1.0",
+    "ajv": "^8.17.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.0",
+    "zod": "^3.25.0",
+    "chokidar": "^3.6.0",
+    "commander": "^12.1.0",
+    "express": "^4.21.2",
+    "gray-matter": "^4.0.3",
+    "open": "^10.1.0",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@codemirror/lang-markdown": "^6.3.1",
+    "@excalidraw/excalidraw": "^0.18.1",
+    "@mdx-js/react": "^3.1.0",
+    "@types/d3-force": "^3.0.10",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.17.9",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@types/ws": "^8.5.13",
+    "@uiw/react-codemirror": "^4.23.6",
+    "@vitejs/plugin-react": "^6.0.2",
+    "concurrently": "^9.1.0",
+    "d3-force": "^3.0.0",
+    "mermaid": "^11.4.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.28.0",
+    "remark-mdx-frontmatter": "^5.0.0",
+    "sucrase": "^3.35.0",
+    "tsup": "^8.3.5",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "unist-util-visit": "^5.0.0",
+    "vite": "^8.0.16",
+    "yaml": "^2.6.1"
+  }
+}