lee-spec-kit 0.1.2 → 0.1.5

package/README.md

@@ -41,21 +41,21 @@ npx lee-spec-kit init --name my-project --type fullstack --lang ko
 
 ```bash
 # Single 프로젝트
-lee-spec-kit feature user-auth
+npx lee-spec-kit feature user-auth
 
 # Fullstack 프로젝트
-lee-spec-kit feature --repo be user-auth
-lee-spec-kit feature --repo fe user-profile
+npx lee-spec-kit feature --repo be user-auth
+npx lee-spec-kit feature --repo fe user-profile
 ```
 
 ### 상태 확인
 
 ```bash
 # 터미널에 출력
-lee-spec-kit status
+npx lee-spec-kit status
 
 # 파일로 저장
-lee-spec-kit status --write
+npx lee-spec-kit status --write
 ```
 
 ## 생성되는 구조

package/dist/index.js

@@ -2,13 +2,13 @@
 import { program } from 'commander';
 import prompts from 'prompts';
 import chalk from 'chalk';
-import path4 from 'path';
-import fs5 from 'fs-extra';
+import path3 from 'path';
+import fs3 from 'fs-extra';
 import { glob } from 'glob';
 import { fileURLToPath } from 'url';
 
 async function copyTemplates(src, dest) {
-  await fs5.copy(src, dest, {
+  await fs3.copy(src, dest, {
     overwrite: true,
     errorOnExist: false
   });
@@ -16,26 +16,26 @@ async function copyTemplates(src, dest) {
 async function replaceInFiles(dir, replacements) {
   const files = await glob("**/*.md", { cwd: dir, absolute: true });
   for (const file of files) {
-    let content = await fs5.readFile(file, "utf-8");
+    let content = await fs3.readFile(file, "utf-8");
     for (const [search, replace] of Object.entries(replacements)) {
       content = content.replaceAll(search, replace);
     }
-    await fs5.writeFile(file, content, "utf-8");
+    await fs3.writeFile(file, content, "utf-8");
   }
   const shFiles = await glob("**/*.sh", { cwd: dir, absolute: true });
   for (const file of shFiles) {
-    let content = await fs5.readFile(file, "utf-8");
+    let content = await fs3.readFile(file, "utf-8");
     for (const [search, replace] of Object.entries(replacements)) {
       content = content.replaceAll(search, replace);
     }
-    await fs5.writeFile(file, content, "utf-8");
+    await fs3.writeFile(file, content, "utf-8");
   }
 }
 var __filename2 = fileURLToPath(import.meta.url);
-var __dirname2 = path4.dirname(__filename2);
+var __dirname2 = path3.dirname(__filename2);
 function getTemplatesDir() {
-  const rootDir = path4.resolve(__dirname2, "..");
-  return path4.join(rootDir, "templates");
+  const rootDir = path3.resolve(__dirname2, "..");
+  return path3.join(rootDir, "templates");
 }
 
 // src/utils/validation.ts
@@ -150,11 +150,11 @@ function initCommand(program2) {
 }
 async function runInit(options) {
   const cwd = process.cwd();
-  const defaultName = path4.basename(cwd);
+  const defaultName = path3.basename(cwd);
   let projectName = options.name || defaultName;
   let projectType = options.type;
   let lang = options.lang || "ko";
-  const targetDir = path4.resolve(cwd, options.dir || "./docs");
+  const targetDir = path3.resolve(cwd, options.dir || "./docs");
   if (!options.yes) {
     const response = await prompts(
       [
@@ -209,8 +209,8 @@ async function runInit(options) {
   assertValid(validateSafeName(projectName), "\uD504\uB85C\uC81D\uD2B8 \uC774\uB984");
   assertValid(validateProjectType(projectType), "\uD504\uB85C\uC81D\uD2B8 \uD0C0\uC785");
   assertValid(validateLanguage(lang), "\uC5B8\uC5B4");
-  if (await fs5.pathExists(targetDir)) {
-    const files = await fs5.readdir(targetDir);
+  if (await fs3.pathExists(targetDir)) {
+    const files = await fs3.readdir(targetDir);
     if (files.length > 0) {
       const { overwrite } = await prompts({
         type: "confirm",
@@ -232,8 +232,8 @@ async function runInit(options) {
   console.log(chalk.gray(`  \uACBD\uB85C: ${targetDir}`));
   console.log();
   const templatesDir = getTemplatesDir();
-  const templatePath = path4.join(templatesDir, lang, projectType);
-  if (!await fs5.pathExists(templatePath)) {
+  const templatePath = path3.join(templatesDir, lang, projectType);
+  if (!await fs3.pathExists(templatePath)) {
     throw new Error(`\uD15C\uD50C\uB9BF\uC744 \uCC3E\uC744 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4: ${templatePath}`);
   }
   await copyTemplates(templatePath, targetDir);
@@ -242,30 +242,82 @@ async function runInit(options) {
     "{{date}}": (/* @__PURE__ */ new Date()).toISOString().split("T")[0]
   };
   await replaceInFiles(targetDir, replacements);
+  const config = {
+    projectName,
+    projectType,
+    lang,
+    createdAt: (/* @__PURE__ */ new Date()).toISOString().split("T")[0]
+  };
+  const configPath = path3.join(targetDir, ".lee-spec-kit.json");
+  await fs3.writeJson(configPath, config, { spaces: 2 });
   console.log(chalk.green("\u2705 docs \uAD6C\uC870 \uC0DD\uC131 \uC644\uB8CC!"));
   console.log();
+  await initGit(cwd, targetDir);
   console.log(chalk.blue("\uB2E4\uC74C \uB2E8\uACC4:"));
   console.log(chalk.gray(`  1. ${targetDir}/prd/README.md \uC791\uC131`));
-  console.log(chalk.gray("  2. lee-spec-kit feature <name> \uC73C\uB85C \uAE30\uB2A5 \uCD94\uAC00"));
+  console.log(
+    chalk.gray("  2. npx lee-spec-kit feature <name> \uC73C\uB85C \uAE30\uB2A5 \uCD94\uAC00")
+  );
   console.log();
 }
+async function initGit(cwd, targetDir) {
+  const { execSync } = await import('child_process');
+  try {
+    try {
+      execSync("git rev-parse --is-inside-work-tree", {
+        cwd,
+        stdio: "ignore"
+      });
+      console.log(chalk.blue("\u{1F4E6} Git \uB808\uD3EC\uC9C0\uD1A0\uB9AC \uAC10\uC9C0, docs \uCEE4\uBC0B \uC911..."));
+    } catch {
+      console.log(chalk.blue("\u{1F4E6} Git \uCD08\uAE30\uD654 \uC911..."));
+      execSync("git init", { cwd, stdio: "ignore" });
+    }
+    const relativePath = path3.relative(cwd, targetDir);
+    execSync(`git add "${relativePath}"`, { cwd, stdio: "ignore" });
+    execSync('git commit -m "init: docs \uAD6C\uC870 \uCD08\uAE30\uD654 (lee-spec-kit)"', {
+      cwd,
+      stdio: "ignore"
+    });
+    console.log(chalk.green("\u2705 Git \uCD08\uAE30 \uCEE4\uBC0B \uC644\uB8CC!"));
+    console.log();
+  } catch (error) {
+    console.log(
+      chalk.yellow("\u26A0\uFE0F  Git \uCD08\uAE30\uD654\uB97C \uAC74\uB108\uB701\uB2C8\uB2E4 (\uC218\uB3D9\uC73C\uB85C \uCEE4\uBC0B\uD574\uC8FC\uC138\uC694)")
+    );
+    console.log();
+  }
+}
 async function getConfig(cwd) {
   const possibleDirs = [
-    path4.join(cwd, "docs"),
+    path3.join(cwd, "docs"),
     cwd
     // 이미 docs 폴더 안에 있을 수 있음
   ];
   for (const docsDir of possibleDirs) {
-    const agentsPath = path4.join(docsDir, "agents");
-    const featuresPath = path4.join(docsDir, "features");
-    if (await fs5.pathExists(agentsPath) && await fs5.pathExists(featuresPath)) {
-      const bePath = path4.join(featuresPath, "be");
-      const fePath = path4.join(featuresPath, "fe");
-      const projectType = await fs5.pathExists(bePath) || await fs5.pathExists(fePath) ? "fullstack" : "single";
-      const agentsMdPath = path4.join(agentsPath, "agents.md");
+    const configPath = path3.join(docsDir, ".lee-spec-kit.json");
+    if (await fs3.pathExists(configPath)) {
+      try {
+        const configFile = await fs3.readJson(configPath);
+        return {
+          docsDir,
+          projectName: configFile.projectName,
+          projectType: configFile.projectType,
+          lang: configFile.lang
+        };
+      } catch {
+      }
+    }
+    const agentsPath = path3.join(docsDir, "agents");
+    const featuresPath = path3.join(docsDir, "features");
+    if (await fs3.pathExists(agentsPath) && await fs3.pathExists(featuresPath)) {
+      const bePath = path3.join(featuresPath, "be");
+      const fePath = path3.join(featuresPath, "fe");
+      const projectType = await fs3.pathExists(bePath) || await fs3.pathExists(fePath) ? "fullstack" : "single";
+      const agentsMdPath = path3.join(agentsPath, "agents.md");
       let lang = "ko";
-      if (await fs5.pathExists(agentsMdPath)) {
-        const content = await fs5.readFile(agentsMdPath, "utf-8");
+      if (await fs3.pathExists(agentsMdPath)) {
+        const content = await fs3.readFile(agentsMdPath, "utf-8");
         if (!/[가-힣]/.test(content)) {
           lang = "en";
         }
@@ -334,22 +386,22 @@ async function runFeature(name, options) {
   }
   let featuresDir;
   if (projectType === "fullstack" && repo) {
-    featuresDir = path4.join(docsDir, "features", repo);
+    featuresDir = path3.join(docsDir, "features", repo);
   } else {
-    featuresDir = path4.join(docsDir, "features");
+    featuresDir = path3.join(docsDir, "features");
   }
   const featureFolderName = `${featureId}-${name}`;
-  const featureDir = path4.join(featuresDir, featureFolderName);
-  if (await fs5.pathExists(featureDir)) {
+  const featureDir = path3.join(featuresDir, featureFolderName);
+  if (await fs3.pathExists(featureDir)) {
     console.error(chalk.red(`\uC774\uBBF8 \uC874\uC7AC\uD558\uB294 \uD3F4\uB354\uC785\uB2C8\uB2E4: ${featureDir}`));
     process.exit(1);
   }
-  const featureBasePath = path4.join(docsDir, "features", "feature-base");
-  if (!await fs5.pathExists(featureBasePath)) {
+  const featureBasePath = path3.join(docsDir, "features", "feature-base");
+  if (!await fs3.pathExists(featureBasePath)) {
     console.error(chalk.red("feature-base \uD15C\uD50C\uB9BF\uC744 \uCC3E\uC744 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4."));
     process.exit(1);
   }
-  await fs5.copy(featureBasePath, featureDir);
+  await fs3.copy(featureBasePath, featureDir);
   const idNumber = featureId.replace("F", "");
   const repoName = projectType === "fullstack" && repo ? `{{projectName}}-${repo}` : "{{projectName}}";
   const replacements = {
@@ -379,18 +431,18 @@ async function runFeature(name, options) {
   console.log();
 }
 async function getNextFeatureId(docsDir, projectType) {
-  const featuresDir = path4.join(docsDir, "features");
+  const featuresDir = path3.join(docsDir, "features");
   let max = 0;
   const scanDirs = [];
   if (projectType === "fullstack") {
-    scanDirs.push(path4.join(featuresDir, "be"));
-    scanDirs.push(path4.join(featuresDir, "fe"));
+    scanDirs.push(path3.join(featuresDir, "be"));
+    scanDirs.push(path3.join(featuresDir, "fe"));
   } else {
     scanDirs.push(featuresDir);
   }
   for (const dir of scanDirs) {
-    if (!await fs5.pathExists(dir)) continue;
-    const entries = await fs5.readdir(dir, { withFileTypes: true });
+    if (!await fs3.pathExists(dir)) continue;
+    const entries = await fs3.readdir(dir, { withFileTypes: true });
     for (const entry of entries) {
       if (!entry.isDirectory()) continue;
       const match = entry.name.match(/^F(\d+)-/);
@@ -424,29 +476,29 @@ async function runStatus(options) {
     process.exit(1);
   }
   const { docsDir, projectType } = config;
-  const featuresDir = path4.join(docsDir, "features");
+  const featuresDir = path3.join(docsDir, "features");
   const features = [];
   const idMap = /* @__PURE__ */ new Map();
   const scopes = projectType === "fullstack" ? ["be", "fe"] : [""];
   for (const scope of scopes) {
-    const scanDir = scope ? path4.join(featuresDir, scope) : featuresDir;
-    if (!await fs5.pathExists(scanDir)) continue;
-    const entries = await fs5.readdir(scanDir, { withFileTypes: true });
+    const scanDir = scope ? path3.join(featuresDir, scope) : featuresDir;
+    if (!await fs3.pathExists(scanDir)) continue;
+    const entries = await fs3.readdir(scanDir, { withFileTypes: true });
     for (const entry of entries) {
       if (!entry.isDirectory()) continue;
       if (entry.name === "feature-base") continue;
-      const featureDir = path4.join(scanDir, entry.name);
-      const specPath = path4.join(featureDir, "spec.md");
-      const tasksPath = path4.join(featureDir, "tasks.md");
-      if (!await fs5.pathExists(specPath)) continue;
-      if (!await fs5.pathExists(tasksPath)) continue;
-      const specContent = await fs5.readFile(specPath, "utf-8");
-      const tasksContent = await fs5.readFile(tasksPath, "utf-8");
+      const featureDir = path3.join(scanDir, entry.name);
+      const specPath = path3.join(featureDir, "spec.md");
+      const tasksPath = path3.join(featureDir, "tasks.md");
+      if (!await fs3.pathExists(specPath)) continue;
+      if (!await fs3.pathExists(tasksPath)) continue;
+      const specContent = await fs3.readFile(specPath, "utf-8");
+      const tasksContent = await fs3.readFile(tasksPath, "utf-8");
       const id = extractSpecValue(specContent, "\uAE30\uB2A5 ID") || extractSpecValue(specContent, "Feature ID") || "UNKNOWN";
       const name = extractSpecValue(specContent, "\uAE30\uB2A5\uBA85") || extractSpecValue(specContent, "Feature Name") || entry.name;
       const repo = extractSpecValue(specContent, "\uB300\uC0C1 \uB808\uD3EC") || extractSpecValue(specContent, "Target Repo") || (scope ? `{{projectName}}-${scope}` : "{{projectName}}");
       const issue = extractSpecValue(specContent, "\uC774\uC288 \uBC88\uD638") || extractSpecValue(specContent, "Issue Number") || "-";
-      const relPath = path4.relative(docsDir, featureDir);
+      const relPath = path3.relative(docsDir, featureDir);
       if (!idMap.has(id)) {
         idMap.set(id, []);
       }
@@ -516,7 +568,7 @@ async function runStatus(options) {
   }
   console.log();
   if (options.write) {
-    const outputPath = path4.join(featuresDir, "status.md");
+    const outputPath = path3.join(featuresDir, "status.md");
     const date = (/* @__PURE__ */ new Date()).toISOString().split("T")[0];
     const content = [
       "# Feature Status",
@@ -531,7 +583,7 @@ async function runStatus(options) {
       ),
       ""
     ].join("\n");
-    await fs5.writeFile(outputPath, content, "utf-8");
+    await fs3.writeFile(outputPath, content, "utf-8");
     console.log(chalk.green(`\u2705 ${outputPath} \uC0DD\uC131 \uC644\uB8CC`));
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lee-spec-kit",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "Project documentation structure generator for AI-assisted development",
   "type": "module",
   "bin": {

package/templates/en/fullstack/agents/agents.md

@@ -50,7 +50,7 @@ docs/
 ### 1. New Feature Request
 
 1. Identify target repo (BE or FE)
-2. Create feature folder: `lee-spec-kit feature <name>`
+2. Create feature folder: `npx lee-spec-kit feature <name>`
 3. Write `spec.md` - what and why (no tech stack)
 4. Request spec review from user
 5. Create GitHub Issue

package/templates/en/fullstack/agents/constitution.md

@@ -3,6 +3,11 @@
 Core principles and technical decision guidelines for the project.
 All development decisions should be based on this document.
 
+> **📌 Document Scope**
+>
+> - **This document**: Tech stack, architecture principles, code quality, security principles
+> - **PRD**: Product requirements, business logic, user stories → `prd/*.md`
+
 ---
 
 ## Project Mission

package/templates/en/fullstack/agents/git-workflow.md

@@ -41,6 +41,8 @@ main
 
 ## Commit Convention
 
+> 📖 Type and Description follow [Udacity Git Commit Message Style Guide](https://udacity.github.io/git-styleguide/).
+
 ### Format
 
 ```

package/templates/en/fullstack/agents/issue-template.md

@@ -14,7 +14,32 @@ F{number}: {feature-name} ({short description})
 
 Example: `F001: user-auth (User authentication feature)`
 
----
+### Link Format (Important!)
+
+In GitHub Issues, use different link formats **based on file location**:
+
+1. **Files within project repo**: Use full URL (clickable)
+   - **Merged documents/code**: Use `main` branch
+     ```markdown
+     [filename](https://github.com/{owner}/{repo}/blob/main/path/to/file)
+     ```
+   - **In-progress documents** (not merged yet): Use **Feature branch**
+     ```markdown
+     [filename](https://github.com/{owner}/{repo}/blob/{feat-branch}/path/to/file)
+     ```
+
+2. **External documents (with public URL)**: Use **absolute URL**
+
+   ```markdown
+   [react-i18next](https://react.i18next.com/)
+   ```
+
+3. **External/local documents** (no URL available): Use **relative path as text only**
+   ```text
+   ../docs/features/F001-feature-name/spec.md
+   ```
+
+> ⚠️ Local documents are not clickable on GitHub, so provide path text only.
 
 ## Issue Body Template
 
@@ -56,3 +81,12 @@ Example: `F001: user-auth (User authentication feature)`
 | `backend`       | BE related    |
 | `frontend`      | FE related    |
 | `priority:high` | High priority |
+
+---
+
+## Body Input Rules (Shell Execution Prevention)
+
+- Issue body should use **`--body-file` by default**.
+- If the body contains backticks (`) or `$()`and is placed directly in`"..."`, it may be **interpreted by the shell**.
+- For multi-line bodies, use **single-quoted heredoc** like `cat <<'EOF'`,
+  and handle variables via **placeholder → sed substitution**.

package/templates/en/fullstack/agents/pr-template.md

@@ -14,7 +14,16 @@ feat(#{issue-number}): {feature-name}
 
 Example: `feat(#1): Implement user authentication`
 
----
+### Link Format (Important!)
+
+For file links within the repo in PR body, **always use current branch name**:
+
+```markdown
+[filename](https://github.com/{owner}/{repo}/blob/{branch-name}/docs/path/to/file.md)
+```
+
+> ⚠️ `main` branch links will return 404 until merged!
+> Always use the **current feature branch name** (e.g., `feat/5-feature-name`).
 
 ## PR Body Template
 
@@ -55,3 +64,12 @@ Closes #{issue-number}
 | Normal Feature | Squash and Merge |
 | Urgent Hotfix  | Merge or Rebase  |
 | Documentation  | Squash and Merge |
+
+---
+
+## Body Input Rules (Shell Execution Prevention)
+
+- PR body should use **`--body-file` by default**.
+- If the body contains backticks (`) or `$()`and is placed directly in`"..."`, it may be **interpreted by the shell**.
+- For multi-line bodies, use **single-quoted heredoc** like `cat <<'EOF'`,
+  and handle variables via **placeholder → sed substitution**.

package/templates/en/fullstack/features/README.md

@@ -29,10 +29,10 @@ features/
 
 ```bash
 # Backend Feature
-lee-spec-kit feature --repo be user-auth
+npx lee-spec-kit feature --repo be user-auth
 
 # Frontend Feature
-lee-spec-kit feature --repo fe user-profile
+npx lee-spec-kit feature --repo fe user-profile
 ```
 
 > 💡 CLI copies templates from `feature-base/` and auto-assigns IDs.
@@ -55,13 +55,13 @@ lee-spec-kit feature --repo fe user-profile
 Check feature progress with CLI:
 
 ```bash
-lee-spec-kit status
+npx lee-spec-kit status
 ```
 
 Save to file:
 
 ```bash
-lee-spec-kit status --write
+npx lee-spec-kit status --write
 ```
 
 ---

package/templates/en/fullstack/features/be/README.md

@@ -2,4 +2,4 @@
 
 Backend Features will be created in this folder.
 
-Use `lee-spec-kit feature --repo be <name>` to create a new Feature.
+Use `npx lee-spec-kit feature --repo be <name>` to create a new Feature.

package/templates/en/fullstack/features/fe/README.md

@@ -2,4 +2,4 @@
 
 Frontend Features will be created in this folder.
 
-Use `lee-spec-kit feature --repo fe <name>` to create a new Feature.
+Use `npx lee-spec-kit feature --repo fe <name>` to create a new Feature.

package/templates/en/fullstack/features/feature-base/plan.md

@@ -1,4 +1,4 @@
-# Implementation Plan: {기능명}
+# Implementation Plan: {feature-name}
 
 > Write after spec is approved.
 
@@ -6,7 +6,7 @@
 
 ## Overview
 
-- **Feature ID**: F{번호}
+- **Feature ID**: F{number}
 - **Target Repo**: {{projectName}}-{be|fe}
 - **Created**: YYYY-MM-DD
 - **Status**: Draft | Review | Approved

package/templates/en/fullstack/features/feature-base/spec.md

@@ -1,4 +1,4 @@
-# Feature Spec: {기능명}
+# Feature Spec: {feature-name}
 
 > Tech stack is covered in plan.md.
 
@@ -6,10 +6,10 @@
 
 ## Overview
 
-- **Feature ID**: F{번호}
-- **Feature Name**: {기능명}
+- **Feature ID**: F{number}
+- **Feature Name**: {feature-name}
 - **Target Repo**: {{projectName}}-{be|fe}
-- **Issue Number**: #{이슈번호}
+- **Issue Number**: #{issue-number}
 - **Created**: YYYY-MM-DD
 - **Status**: Draft | Review | Approved
 

package/templates/en/fullstack/features/feature-base/tasks.md

@@ -1,4 +1,4 @@
-# Tasks: {기능명}
+# Tasks: {feature-name}
 
 ## Task Rules
 
@@ -10,8 +10,8 @@
 ## GitHub Issue
 
 - **Repo**: {{projectName}}-{be|fe}
-- **Issue**: #{이슈번호}
-- **Branch**: `feat/{이슈번호}-{기능명}`
+- **Issue**: #{issue-number}
+- **Branch**: `feat/{issue-number}-{feature-name}`
 
 ---
 
@@ -19,7 +19,7 @@
 
 ### Phase 1: {Phase Name}
 
-- [TODO][P1] T-F{번호}-01 {Task Title}
+- [TODO][P1] T-F{number}-01 {Task Title}
   - Acceptance:
     - (verification condition)
   - Checklist:

package/templates/en/fullstack/prd/README.md

@@ -2,6 +2,11 @@
 
 This folder contains product requirements documentation.
 
+> **📌 Document Scope**
+>
+> - **This folder**: Product requirements, business logic, user stories
+> - **Constitution**: Tech stack, architecture principles, code quality, security principles → `agents/constitution.md`
+
 ## Writing Guide
 
 1. Define project overview and goals

package/templates/en/single/agents/agents.md

@@ -44,7 +44,7 @@ docs/
 
 ### 1. New Feature Request
 
-1. Create feature folder: `lee-spec-kit feature <name>`
+1. Create feature folder: `npx lee-spec-kit feature <name>`
 2. Write `spec.md` - what and why
 3. Request spec review
 4. Create GitHub Issue