@catcuts-skills/commit 1.0.0 → 1.0.2

package/README.md

@@ -17,7 +17,7 @@
 
 ### 快速安装
 
-从 npm 安装包时会自动将 skill 注册到 Claude Code：
+从 npm 安装包时会自动将 skill 注册到 Opencode、Claude Code、Codex、Cursor 及其他 [19 个工具](https://github.com/vercel-labs/add-skill?tab=readme-ov-file#available-agents)。感谢 [Vercel 开源的 add-skill](https://github.com/vercel-labs/add-skill) 🌹
 
 ```bash
 # 全局安装（推荐）
@@ -51,8 +51,6 @@ npx add-skill . -a claude-code -g -y
 npx add-skill . -a claude-code -y
 ```
 
-**支持平台**: 基于 [Vercel 开源的 add-skill](https://github.com/vercel-labs/add-skill)，本技能支持 Opencode、Claude Code、Codex、Cursor 及其他 [19 个工具](https://github.com/vercel-labs/add-skill?tab=readme-ov-file#available-agents)。
-
 ### 测试安装
 
 运行测试以验证安装配置（不会实际安装）：

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catcuts-skills/commit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "读取 staged 代码差异，自动生成符合 Conventional Commits 规范的提交文本",
   "main": "index.js",
   "scripts": {
@@ -34,7 +34,7 @@
   "bugs": {
     "url": "https://github.com/catcuts/agent-skills/issues"
   },
-  "homepage": "https://github.com/catcuts/agent-skills#readme",
+  "homepage": "https://github.com/catcuts/agent-skills/tree/main/skills/commit#readme",
   "engines": {
     "node": ">=18.0.0"
   }

package/scripts/install-skill.js

@@ -15,6 +15,7 @@
 
 const { execSync } = require('child_process');
 const path = require('path');
+const { printUsageGuide } = require('./usage-guide');
 
 // Get package root directory
 const packageRoot = path.resolve(__dirname, '..');
@@ -97,6 +98,9 @@ try {
     log('\nInstallation successful!', 'success');
     log(`Skill installed to: ${isGlobal ? `~/.claude/skills/${skillName}` : `.claude/skills/${skillName}`}`, 'info');
 
+    // 显示使用指南
+    printUsageGuide();
+
 } catch (error) {
     handleError(error);
 }

package/scripts/usage-guide.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+/**
+ * 技能使用指南生成器
+ * 在安装成功后显示友好的使用指南
+ */
+
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * 读取 package.json 中的信息
+ */
+function getPackageInfo() {
+    const packageRoot = path.resolve(__dirname, '..');
+    const packageJsonPath = path.join(packageRoot, 'package.json');
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+
+    return {
+        name: packageJson.name.split('/')[1] || packageJson.name,
+        description: packageJson.description,
+        homepage: packageJson.homepage || '',
+        repository: packageJson.repository?.url || '',
+    };
+}
+
+/**
+ * 读取 SKILL.md 中的触发指令
+ */
+function getSkillInstructions() {
+    const packageRoot = path.resolve(__dirname, '..');
+    const skillMdPath = path.join(packageRoot, 'SKILL.md');
+
+    if (!fs.existsSync(skillMdPath)) {
+        return null;
+    }
+
+    const content = fs.readFileSync(skillMdPath, 'utf-8');
+    // 匹配 description 行中的指令说明
+    const match = content.match(/^description:\s*(.+)$/m);
+    return match ? match[1].trim() : null;
+}
+
+/**
+ * 打印使用指南
+ */
+function printUsageGuide() {
+    const pkg = getPackageInfo();
+    const instructions = getSkillInstructions();
+
+    // 如果 SKILL.md 中有指令说明，使用它；否则使用 package.json 的 description
+    const usageInfo = instructions || pkg.description;
+
+    const guide = `
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  🎉 技能安装成功！
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+📦 技能名称:    ${pkg.name}
+📝 功能描述:    ${pkg.description}
+
+🚀 如何使用:
+   ${usageInfo}
+
+📖 更多信息:
+   ${pkg.homepage ? `   文档: ${pkg.homepage}` : ''}
+   ${pkg.repository ? `   仓库: ${pkg.repository}` : ''}
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+`;
+
+    console.log(guide);
+}
+
+module.exports = { printUsageGuide };