@lumiflora/fsdk 0.1.4 → 0.1.6

package/README.md

@@ -1,122 +1,107 @@
-# @lumiflora/fsdk
-
 Vue 3 前端项目脚手架 CLI 工具，快速创建包含最佳技术栈的项目骨架。
 
 ## 安装
 
 ```bash
+# 方式一：本地开发模式
+cd /path/to/fsdk
+pnpm install
+pnpm dev
+
+# 方式二：全局安装（发布后）
+pnpm build
 npm install -g @lumiflora/fsdk
 ```
 
-## 快速开始
+## 使用命令
 
 ```bash
-# 交互式创建项目
-fsdk create
-
-# 指定参数创建
+# 创建新项目
+fsdk create my-project              # 交互式创建
 fsdk create my-project --template full --package-manager pnpm
-```
-
-## 命令
 
-### create - 创建新项目
+# 添加页面
+fsdk add-page --page-name user --router-path /user
 
-```bash
-fsdk create [project-name] [options]
-
-Options:
-  --template <name>        模板名称 (base|full) [default: base]
-  --package-manager <pm>    包管理器 (npm|pnpm|yarn|bun) [default: pnpm]
-  --eslint                 启用 ESLint [default: true]
-  --no-git                 跳过 git 初始化
-  --no-install             跳过依赖安装
-```
+# 添加组件
+fsdk add-component --name Header --type common
 
-### add-page - 添加页面
+# 添加 Store
+fsdk add-store --name user
 
-```bash
-fsdk add-page [options]
+# 校验配置和模板
+fsdk validate
 
-Options:
-  --page-name <name>    页面名称
-  --router-path <path>  路由路径
-```
+# 预览模板
+fsdk preview --port 3000
 
-### add-component - 添加组件
+# 生成并安装补全脚本
+fsdk completion bash    # 生成 bash 补全脚本
+fsdk completion zsh     # 生成 zsh 补全脚本
+fsdk completion fish    # 生成 fish 补全脚本
 
-```bash
-fsdk add-component [options]
+# 自动安装到 shell 配置文件（推荐）
+fsdk completion bash --install
+fsdk completion zsh --install
 
-Options:
-  --name <name>    组件名称
-  --type <type>    组件类型 (page|common|business) [default: common]
-  --dir <dir>      子目录
+# 查看帮助
+fsdk --help
+fsdk create --help
 ```
 
-### add-store - 添加状态管理
+## Shell 补全
 
-```bash
-fsdk add-store [options]
-
-Options:
-  --name <name>    Store 名称
-  --type <type>    Store 类型 (pinia|redux) [default: pinia]
-```
+fsdk 支持 bash、zsh 和 fish 的命令行补全。安装后，输入 `fsdk ` 后按 Tab 键可自动补全命令和选项。
 
-### validate - 校验配置和模板
+### Bash（Linux / macOS）
 
 ```bash
-fsdk validate [options]
+# 方式一：自动安装（推荐）
+fsdk completion bash --install
+source ~/.bashrc
 
-Options:
-  --config      仅校验配置
-  --templates   仅校验模板
-  --strict      严格校验
+# 方式二：手动安装
+fsdk completion bash
+echo 'source ~/.fsdk-completion.bash' >> ~/.bashrc
+source ~/.bashrc
 ```
 
-### preview - 预览模板
+### Zsh（macOS 默认）
 
 ```bash
-fsdk preview [options]
-
-Options:
-  --port <port>      端口号 [default: 3000]
-  --host <host>      主机地址 [default: localhost]
-  --open             打开浏览器
-  --template <name>  模板名称
+# 方式一：自动安装（推荐）
+fsdk completion zsh --install
+source ~/.zshrc
+
+# 方式二：手动安装
+fsdk completion zsh
+# 添加以下内容到 ~/.zshrc：
+# fpath=("$HOME/.zsh/completion" $fpath)
+# autoload -U compinit && compinit
+source ~/.zshrc
 ```
 
-### sync-template - 同步模板文件
-
-```bash
-fsdk sync-template [options]
-
-Options:
-  --template <name>    模板名称
-  --force              强制同步
-```
+> **注意**：如果使用 Oh My Zsh，可以将补全文件复制到 `~/.oh-my-zsh/completions/` 目录：
+> ```bash
+> mkdir -p ~/.oh-my-zsh/completions
+> fsdk completion zsh --output ~/.oh-my-zsh/completions/_fsdk
+> exec zsh
+> ```
 
-### completion - 生成 Shell 补全
+### Fish
 
 ```bash
-fsdk completion [shell] [options]
-
-Options:
-  --install    自动安装到 shell 配置
-
-# 示例
-fsdk completion --install    # 自动配置当前 shell
-fsdk completion zsh --install
-fsdk completion bash --install
+fsdk completion fish
+# 补全文件自动生成到 ~/.config/fish/completions/fsdk.fish
+# 重启 fish 或打开新终端即可生效
 ```
 
 ## 模板
 
 | 模板 | 说明 |
 |------|------|
+| `full` | Vue 3.5 + Vite 6 + Element Plus + Pinia + Vue Router + SCSS |
 | `base` | Vue 3.5 + Vite 6 基础版 |
-| `full` | Vue 3.5 + Vite 6 + Element Plus + Pinia + Vue Router + SCSS + ESLint |
 
 ## 技术栈
 
@@ -129,22 +114,3 @@ fsdk completion bash --install
 | Vite | ^6.0.0 | 构建工具 |
 | TypeScript | ~5.6.0 | 类型系统 |
 | ESLint | ^9.0.0 | 代码检查 |
-
-## 开发
-
-```bash
-# 本地开发
-cd packages/cli
-pnpm install
-pnpm dev
-
-# 构建
-pnpm build
-
-# 类型检查
-pnpm typecheck
-```
-
-## License
-
-MIT

package/dist/commands/completion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../../src/commands/completion.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhD,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAoLD,wBAAsB,kBAAkB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BvF"}
+{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../../src/commands/completion.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhD,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AA8KD,wBAAsB,kBAAkB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoCvF"}

package/dist/commands/completion.js

@@ -45,14 +45,11 @@ _fsdk_completion() {
 
 complete -F _fsdk_completion fsdk
 `;
-const ZSH_COMPLETION = `#fsdk completion
-autoload -Uz compinit
-compinit 2>/dev/null
+const ZSH_COMPLETION = `#compdef fsdk
 
-# Define the completion function
 _fsdk() {
-  local -a _fsdk_cmds
-  _fsdk_cmds=(
+  local -a commands
+  commands=(
     'create:Create a new application'
     'add-page:Add a new page'
     'add-component:Add a new component'
@@ -70,7 +67,7 @@ _fsdk() {
 
   case "$state" in
     command)
-      _describe 'command' _fsdk_cmds
+      _describe 'command' commands
       ;;
     args)
       case $words[1] in
@@ -126,9 +123,6 @@ _fsdk() {
       ;;
   esac
 }
-
-# Register the completion function for fsdk command
-compdef _fsdk fsdk
 `;
 const FISH_COMPLETION = `# fish completion for fsdk
 
@@ -192,7 +186,13 @@ export async function generateCompletion(options = {}) {
             await installToShellRc(shell, outputPath);
         }
         else if (!install) {
-            if (shell !== 'fish') {
+            if (shell === 'zsh') {
+                const completionDir = path.dirname(outputPath);
+                logger.info(`Add the following lines to your ~/.zshrc:`);
+                logger.info(`  fpath=("${completionDir}" $fpath)`);
+                logger.info(`  autoload -U compinit && compinit`);
+            }
+            else if (shell !== 'fish') {
                 logger.info(`Add the following line to your shell configuration:`);
                 logger.info(`  source ${outputPath}`);
             }
@@ -210,12 +210,16 @@ export async function generateCompletion(options = {}) {
 async function installToShellRc(shell, completionPath) {
     const home = process.env.HOME || '';
     let rcFile = '';
-    let sourceLine = `source ${completionPath}`;
+    let sourceLine = '';
     if (shell === 'bash') {
         rcFile = path.resolve(home, '.bashrc');
+        sourceLine = `source ${completionPath}`;
     }
     else if (shell === 'zsh') {
         rcFile = path.resolve(home, '.zshrc');
+        // For zsh, add to fpath and compinit
+        const completionDir = path.dirname(completionPath);
+        sourceLine = `# Add fsdk completion to fpath\nfpath=("${completionDir}" $fpath)\nautoload -U compinit && compinit`;
     }
     else {
         logger.warning(`--install is not supported for fish shell yet`);
@@ -226,12 +230,12 @@ async function installToShellRc(shell, completionPath) {
         if (await fs.pathExists(rcFile)) {
             rcContent = await fs.readFile(rcFile, 'utf-8');
         }
-        const pattern = shell === 'bash' ? /\.fsdk-completion/ : 'fsdk-completion';
+        const pattern = shell === 'bash' ? /\.fsdk-completion/ : 'fsdk completion';
         if (rcContent.includes(pattern)) {
             logger.info(`Completion already installed in ${rcFile}`);
             return;
         }
-        await fs.appendFile(rcFile, `\n# fsdk completion\n${sourceLine}\n`);
+        await fs.appendFile(rcFile, `\n# ${shell} fsdk completion\n${sourceLine}\n`);
         logger.success(`Completion installed to ${rcFile}`);
         logger.info(`Run "source ${rcFile}" or restart your shell to apply`);
     }
@@ -254,7 +258,8 @@ function getDefaultOutputPath(shell) {
         case 'bash':
             return path.resolve(home, '.fsdk-completion.bash');
         case 'zsh':
-            return path.resolve(home, '.fsdk-completion.zsh');
+            // zsh completion must be in fpath directory with _command name
+            return path.resolve(home, '.zsh', 'completion', '_fsdk');
         case 'fish':
             return path.resolve(home, '.config', 'fish', 'completions', 'fsdk.fish');
     }

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { createRequire } from 'module';
+import fs from 'fs';
 import cac from 'cac';
 import { logger, enableDebugMode, resolveCwd } from './utils/index.js';
 import { configLoader, pluginSystem } from './core/index.js';
@@ -12,9 +12,9 @@ import { createApp, addPage, addComponent, addStore, syncTemplate, validate, pre
 const cliEntryPath = fileURLToPath(import.meta.url);
 const cliRoot = path.dirname(path.dirname(cliEntryPath));
 global.__cliRoot = cliRoot;
-// Create require for reading package.json in ES module
-const require = createRequire(import.meta.url);
-const pkg = require('../../package.json');
+// Read package.json to get version
+const pkgPath = path.join(cliRoot, 'package.json');
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
 const cli = cac('fsdk');
 cli
     .version(pkg.version)

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@lumiflora/fsdk",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "type": "module",
   "main": "./dist/index.js",
   "bin": {
     "fsdk": "dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "scripts/postinstall.js",
+    "README.md"
   ],
   "scripts": {
     "dev": "tsx src/index.ts",
     "build": "tsc && node scripts/fix-bin.js",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "postinstall": "node scripts/postinstall.js"
   },
   "dependencies": {
     "cac": "^6.7.14",

package/scripts/postinstall.js

@@ -0,0 +1,271 @@
+#!/usr/bin/env node
+
+import { existsSync } from 'fs';
+import { readFileSync, writeFileSync } from 'fs';
+import path from 'path';
+
+const detectShell = () => {
+  const shell = process.env.SHELL || '';
+  if (shell.includes('zsh')) return 'zsh';
+  if (shell.includes('fish')) return 'fish';
+  return 'bash';
+};
+
+const generateCompletion = (shell) => {
+  if (shell === 'bash') {
+    return `#!/bin/bash
+# fsdk bash completion
+
+_fsdk_completion() {
+  local cur prev opts
+  COMPREPLY=()
+  cur="\${COMP_WORDS[COMP_CWORD]}"
+  prev="\${COMP_WORDS[COMP_CWORD-1]}"
+  opts="create add-page add-component add-store sync-template validate preview completion"
+  case "\${prev}" in
+    create)
+      opts="--template --package-manager --eslint --no-git --no-install"
+      ;;
+    add-page)
+      opts="--router-path --page-name"
+      ;;
+    add-component)
+      opts="--type --name --dir"
+      ;;
+    add-store)
+      opts="--type --name"
+      ;;
+    sync-template)
+      opts="--template --force"
+      ;;
+    validate)
+      opts="--config --templates --strict"
+      ;;
+    preview)
+      opts="--port --host --open --template"
+      ;;
+    completion)
+      opts="bash zsh fish"
+      ;;
+  esac
+  COMPREPLY=($(compgen -W "\${opts}" -- "\${cur}"))
+  return 0
+}
+complete -F _fsdk_completion fsdk`;
+  }
+
+  if (shell === 'zsh') {
+    return `#compdef fsdk
+
+_fsdk() {
+  local -a commands
+  commands=(
+    'create:Create a new application'
+    'add-page:Add a new page'
+    'add-component:Add a new component'
+    'add-store:Add a new store'
+    'sync-template:Sync template files'
+    'validate:Validate configuration and templates'
+    'preview:Preview template'
+    'completion:Generate shell completion script'
+  )
+  _arguments -C \
+    '1: :->command' \
+    '2: :->args' \
+    '*: :->rest'
+  case "$state" in
+    command)
+      _describe 'command' commands
+      ;;
+    args)
+      case $words[1] in
+        create)
+          _arguments -s \
+            '--template[Template name]' \
+            '--package-manager[Package manager: npm|pnpm|yarn|bun]' \
+            '--eslint[Enable ESLint]' \
+            '--no-git[Skip git initialization]' \
+            '--no-install[Skip dependency installation]'
+          ;;
+        add-page)
+          _arguments -s \
+            '--router-path[Router path]' \
+            '--page-name[Page name]'
+          ;;
+        add-component)
+          _arguments -s \
+            '--type[Component type: page|common|business]' \
+            '--name[Component name]' \
+            '--dir[Subdirectory]'
+          ;;
+        add-store)
+          _arguments -s \
+            '--type[Store type: pinia|redux]' \
+            '--name[Store name]'
+          ;;
+        sync-template)
+          _arguments -s \
+            '--template[Template name]' \
+            '--force[Force sync]'
+          ;;
+        validate)
+          _arguments -s \
+            '--config[Validate config only]' \
+            '--templates[Validate templates only]' \
+            '--strict[Strict validation]'
+          ;;
+        preview)
+          _arguments -s \
+            '--port[Port number]' \
+            '--host[Host address]' \
+            '--open[Open browser]' \
+            '--template[Template name]'
+          ;;
+        completion)
+          _arguments -s \
+            'bash:Generate bash completion' \
+            'zsh:Generate zsh completion' \
+            'fish:Generate fish completion'
+          ;;
+      esac
+      ;;
+  esac
+}`;
+  }
+
+  if (shell === 'fish') {
+    return `# fish completion for fsdk
+
+complete -c fsdk -n '__fish_use_subcommand' -a 'create' -d 'Create a new application'
+complete -c fsdk -n '__fish_use_subcommand' -a 'add-page' -d 'Add a new page'
+complete -c fsdk -n '__fish_use_subcommand' -a 'add-component' -d 'Add a new component'
+complete -c fsdk -n '__fish_use_subcommand' -a 'add-store' -d 'Add a new store'
+complete -c fsdk -n '__fish_use_subcommand' -a 'sync-template' -d 'Sync template files'
+complete -c fsdk -n '__fish_use_subcommand' -a 'validate' -d 'Validate configuration and templates'
+complete -c fsdk -n '__fish_use_subcommand' -a 'preview' -d 'Preview template'
+complete -c fsdk -n '__fish_use_subcommand' -a 'completion' -d 'Generate shell completion script'
+
+complete -c fsdk -n '__fish_seen_subcommand_from create' -l template -d 'Template name'
+complete -c fsdk -n '__fish_seen_subcommand_from create' -l package-manager -d 'Package manager' -a 'npm pnpm yarn bun'
+complete -c fsdk -n '__fish_seen_subcommand_from create' -l eslint -d 'Enable ESLint'
+complete -c fsdk -n '__fish_seen_subcommand_from create' -l no-git -d 'Skip git initialization'
+complete -c fsdk -n '__fish_seen_subcommand_from create' -l no-install -d 'Skip dependency installation'
+
+complete -c fsdk -n '__fish_seen_subcommand_from add-page' -l router-path -d 'Router path'
+complete -c fsdk -n '__fish_seen_subcommand_from add-page' -l page-name -d 'Page name'
+
+complete -c fsdk -n '__fish_seen_subcommand_from add-component' -l type -d 'Component type' -a 'page common business'
+complete -c fsdk -n '__fish_seen_subcommand_from add-component' -l name -d 'Component name'
+complete -c fsdk -n '__fish_seen_subcommand_from add-component' -l dir -d 'Subdirectory'
+
+complete -c fsdk -n '__fish_seen_subcommand_from add-store' -l type -d 'Store type' -a 'pinia redux'
+complete -c fsdk -n '__fish_seen_subcommand_from add-store' -l name -d 'Store name'
+
+complete -c fsdk -n '__fish_seen_subcommand_from sync-template' -l template -d 'Template name'
+complete -c fsdk -n '__fish_seen_subcommand_from sync-template' -l force -d 'Force sync'
+
+complete -c fsdk -n '__fish_seen_subcommand_from validate' -l config -d 'Validate config only'
+complete -c fsdk -n '__fish_seen_subcommand_from validate' -l templates -d 'Validate templates only'
+complete -c fsdk -n '__fish_seen_subcommand_from validate' -l strict -d 'Strict validation'
+
+complete -c fsdk -n '__fish_seen_subcommand_from preview' -l port -d 'Port number'
+complete -c fsdk -n '__fish_seen_subcommand_from preview' -l host -d 'Host address'
+complete -c fsdk -n '__fish_seen_subcommand_from preview' -l open -d 'Open browser'
+complete -c fsdk -n '__fish_seen_subcommand_from preview' -l template -d 'Template name'`;
+  }
+};
+
+const installCompletion = () => {
+  const shell = detectShell();
+  const home = process.env.HOME || process.env.USERPROFILE || '';
+  let rcFile = '';
+  let completionFile = '';
+  let configLine = '';
+
+  if (shell === 'bash') {
+    rcFile = path.resolve(home, '.bashrc');
+    completionFile = path.resolve(home, '.fsdk-completion.bash');
+    configLine = 'source ~/.fsdk-completion.bash';
+  } else if (shell === 'zsh') {
+    rcFile = path.resolve(home, '.zshrc');
+    completionFile = path.resolve(home, '.zsh', 'completion', '_fsdk');
+    configLine = 'fpath=("~/.zsh/completion" $fpath)';
+  } else if (shell === 'fish') {
+    rcFile = path.resolve(home, '.config', 'fish', 'config.fish');
+    completionFile = path.resolve(home, '.config', 'fish', 'completions', 'fsdk.fish');
+    configLine = '';
+  }
+
+  // 生成补全文件
+  try {
+    const content = generateCompletion(shell);
+    writeFileSync(completionFile, content, 'utf-8');
+    if (shell === 'bash') {
+      import('fs').then(fs => { fs.chmodSync(completionFile, 0o755); });
+    }
+  } catch (err) {
+    console.error('Failed to write completion file:', err.message);
+    process.exit(1);
+  }
+
+  // Fish 不需要额外配置
+  if (shell === 'fish') {
+    console.log('✓ fsdk completion installed to', completionFile);
+    console.log('  Restart your fish shell or open a new terminal to apply');
+    return;
+  }
+
+  // 读取现有配置
+  let rcContent = '';
+  if (existsSync(rcFile)) {
+    rcContent = readFileSync(rcFile, 'utf-8');
+  }
+
+  // 先检测原始内容是否已有有效配置
+  const alreadyHasValidConfig = (shell === 'bash' && rcContent.includes('source ~/.fsdk-completion.bash')) ||
+                          (shell === 'zsh' && /fpath=.*\.zsh\/completion/.test(rcContent));
+
+  if (alreadyHasValidConfig) {
+    console.log('✓ fsdk completion already configured in', rcFile);
+    return;
+  }
+
+  // 清理旧的 fsdk completion 配置
+  const lines = rcContent.split('\n');
+  const newLines = [];
+  let skipLines = false;
+  for (const line of lines) {
+    if (line.includes('# fsdk completion') || line.includes('# zsh fsdk completion') || line.includes('# bash fsdk completion')) {
+      skipLines = true;
+      continue;
+    }
+    if (skipLines) {
+      if (line.trim() === '') {
+        skipLines = false;
+      }
+      continue;
+    }
+    newLines.push(line);
+  }
+
+  const newContent = newLines.join('\n');
+
+  // 检查是否已有 compinit（使用原始 rcContent）
+  const alreadyHasCompinit = rcContent.includes('autoload -U compinit');
+
+  // 决定添加什么配置
+  let configToAdd = '';
+  if (shell === 'zsh' && alreadyHasCompinit) {
+    // 已有 compinit，只添加 fpath
+    configToAdd = '# zsh fsdk completion\n' + configLine + '\n';
+  } else if (configLine) {
+    configToAdd = `# ${shell} fsdk completion\n${configLine}\n`;
+  }
+
+  // 写入新配置
+  writeFileSync(rcFile, (newContent ? newContent + '\n' : '') + configToAdd, 'utf-8');
+  console.log('✓ fsdk completion installed to', rcFile);
+  console.log('  Run "source', rcFile, '" or restart your shell to apply');
+};
+
+installCompletion();