@adonis0123/skill-development 1.0.1

package/install-skill.js

@@ -0,0 +1,315 @@
+#!/usr/bin/env node
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// shared/src/install-skill.ts
+var import_fs2 = __toESM(require("fs"));
+var import_path2 = __toESM(require("path"));
+var import_os2 = __toESM(require("os"));
+var import_child_process = require("child_process");
+
+// shared/src/utils.ts
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_os = __toESM(require("os"));
+var CWD = process.env.INIT_CWD || process.cwd();
+var DEFAULT_TARGET = {
+  name: "claude-code",
+  paths: {
+    global: ".claude/skills",
+    project: ".claude/skills"
+  }
+};
+function getEnabledTargets(config) {
+  if (!config.targets) {
+    return [DEFAULT_TARGET];
+  }
+  return Object.entries(config.targets).filter(([_, target]) => target.enabled).map(([name, target]) => ({
+    name,
+    paths: target.paths
+  }));
+}
+function extractSkillName(packageName) {
+  if (packageName.startsWith("@")) {
+    return packageName.split("/")[1] || packageName;
+  }
+  return packageName;
+}
+function detectInstallLocation(targetPaths, isGlobal) {
+  if (isGlobal) {
+    return {
+      type: "personal",
+      base: import_path.default.join(import_os.default.homedir(), targetPaths.global)
+    };
+  }
+  let projectRoot = CWD;
+  while (projectRoot !== import_path.default.dirname(projectRoot)) {
+    const hasPackageJson = import_fs.default.existsSync(import_path.default.join(projectRoot, "package.json"));
+    const hasGit = import_fs.default.existsSync(import_path.default.join(projectRoot, ".git"));
+    const isInNodeModules = projectRoot.includes("/node_modules/") || import_path.default.basename(projectRoot) === "node_modules";
+    if ((hasPackageJson || hasGit) && !isInNodeModules) {
+      break;
+    }
+    projectRoot = import_path.default.dirname(projectRoot);
+  }
+  const finalIsInNodeModules = projectRoot.includes("/node_modules/") || import_path.default.basename(projectRoot) === "node_modules";
+  if (finalIsInNodeModules) {
+    console.warn("\u26A0 Warning: Could not find project root directory, using current directory");
+    projectRoot = CWD;
+  }
+  return {
+    type: "project",
+    base: import_path.default.join(projectRoot, targetPaths.project)
+  };
+}
+function isGlobalInstall() {
+  return process.env.npm_config_global === "true";
+}
+function copyDir(src, dest) {
+  import_fs.default.mkdirSync(dest, { recursive: true });
+  const entries = import_fs.default.readdirSync(src, { withFileTypes: true });
+  for (const entry of entries) {
+    const srcPath = import_path.default.join(src, entry.name);
+    const destPath = import_path.default.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      import_fs.default.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+function ensureDir(dir) {
+  if (!import_fs.default.existsSync(dir)) {
+    import_fs.default.mkdirSync(dir, { recursive: true });
+  }
+}
+function removeDir(dir) {
+  if (import_fs.default.existsSync(dir)) {
+    import_fs.default.rmSync(dir, { recursive: true, force: true });
+  }
+}
+function readSkillConfig(dir) {
+  const configPath = import_path.default.join(dir, ".claude-skill.json");
+  if (!import_fs.default.existsSync(configPath)) {
+    throw new Error(".claude-skill.json not found");
+  }
+  return JSON.parse(import_fs.default.readFileSync(configPath, "utf-8"));
+}
+
+// shared/src/install-skill.ts
+function fetchFromRemote(tempDir, remoteSource) {
+  try {
+    console.log(`  \u{1F310} Fetching latest from ${remoteSource}...`);
+    (0, import_child_process.execSync)(`npx degit ${remoteSource} "${tempDir}" --force`, {
+      stdio: "pipe",
+      timeout: 6e4
+    });
+    if (import_fs2.default.existsSync(import_path2.default.join(tempDir, "SKILL.md"))) {
+      console.log("  \u2713 Fetched latest version from remote");
+      return true;
+    }
+    console.warn("  \u26A0 Remote fetch succeeded but SKILL.md not found");
+    return false;
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.warn(`  \u26A0 Could not fetch from remote: ${message}`);
+    console.log("  \u2139 Using bundled version as fallback");
+    return false;
+  }
+}
+function getSourceDir(config, packageDir) {
+  if (!config.remoteSource) {
+    return {
+      sourceDir: packageDir,
+      cleanup: () => {
+      },
+      isRemote: false
+    };
+  }
+  const tempDir = import_path2.default.join(import_os2.default.tmpdir(), `skill-fetch-${Date.now()}`);
+  const remoteSuccess = fetchFromRemote(tempDir, config.remoteSource);
+  if (remoteSuccess) {
+    return {
+      sourceDir: tempDir,
+      cleanup: () => {
+        try {
+          import_fs2.default.rmSync(tempDir, { recursive: true, force: true });
+        } catch {
+        }
+      },
+      isRemote: true
+    };
+  }
+  try {
+    import_fs2.default.rmSync(tempDir, { recursive: true, force: true });
+  } catch {
+  }
+  return {
+    sourceDir: packageDir,
+    cleanup: () => {
+    },
+    isRemote: false
+  };
+}
+function updateManifest(skillsDir, config, targetName, isRemote) {
+  const manifestPath = import_path2.default.join(skillsDir, ".skills-manifest.json");
+  let manifest = { skills: {} };
+  if (import_fs2.default.existsSync(manifestPath)) {
+    try {
+      manifest = JSON.parse(import_fs2.default.readFileSync(manifestPath, "utf-8"));
+    } catch {
+      console.warn("  Warning: Could not parse existing manifest, creating new one");
+      manifest = { skills: {} };
+    }
+  }
+  const skillName = extractSkillName(config.name);
+  manifest.skills[config.name] = {
+    version: config.version,
+    installedAt: (/* @__PURE__ */ new Date()).toISOString(),
+    package: config.package || config.name,
+    path: import_path2.default.join(skillsDir, skillName),
+    target: targetName,
+    ...config.remoteSource && { source: config.remoteSource }
+  };
+  import_fs2.default.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
+}
+function installToTarget(target, config, sourceDir, isRemote) {
+  var _a;
+  console.log(`
+\u{1F4E6} Installing to ${target.name}...`);
+  const isGlobal = isGlobalInstall();
+  const location = detectInstallLocation(target.paths, isGlobal);
+  const skillName = extractSkillName(config.name);
+  const targetDir = import_path2.default.join(location.base, skillName);
+  const altTargetDir = import_path2.default.join(location.base, config.name);
+  console.log(`  Type: ${location.type}${isGlobal ? " (global)" : " (project)"}`);
+  console.log(`  Directory: ${targetDir}`);
+  if (import_fs2.default.existsSync(altTargetDir) && altTargetDir !== targetDir) {
+    console.log("  \u{1F9F9} Cleaning up alternative path format...");
+    removeDir(altTargetDir);
+    console.log(`  \u2713 Removed directory: ${config.name}`);
+  }
+  ensureDir(targetDir);
+  const skillMdSource = import_path2.default.join(sourceDir, "SKILL.md");
+  if (!import_fs2.default.existsSync(skillMdSource)) {
+    throw new Error("SKILL.md is required but not found");
+  }
+  import_fs2.default.copyFileSync(skillMdSource, import_path2.default.join(targetDir, "SKILL.md"));
+  console.log("  \u2713 Copied SKILL.md");
+  const filesToCopy = config.files || {};
+  for (const [source, dest] of Object.entries(filesToCopy)) {
+    const sourcePath = import_path2.default.join(sourceDir, source);
+    if (!import_fs2.default.existsSync(sourcePath)) {
+      console.warn(`  \u26A0 Warning: ${source} not found, skipping`);
+      continue;
+    }
+    const destPath = import_path2.default.join(targetDir, dest);
+    if (import_fs2.default.statSync(sourcePath).isDirectory()) {
+      copyDir(sourcePath, destPath);
+      console.log(`  \u2713 Copied directory: ${source}`);
+    } else {
+      const destDir = import_path2.default.dirname(destPath);
+      ensureDir(destDir);
+      import_fs2.default.copyFileSync(sourcePath, destPath);
+      console.log(`  \u2713 Copied file: ${source}`);
+    }
+  }
+  updateManifest(location.base, config, target.name, isRemote);
+  if ((_a = config.hooks) == null ? void 0 : _a.postinstall) {
+    console.log("  \u{1F527} Running postinstall hook...");
+    try {
+      (0, import_child_process.execSync)(config.hooks.postinstall, {
+        cwd: targetDir,
+        stdio: "pipe"
+      });
+      console.log("  \u2713 Postinstall hook completed");
+    } catch {
+      console.warn("  \u26A0 Warning: postinstall hook failed");
+    }
+  }
+  console.log(`  \u2705 Installed to ${target.name}`);
+  return targetDir;
+}
+function installSkill() {
+  console.log("\u{1F680} Installing AI Coding Skill...\n");
+  const packageDir = __dirname;
+  const config = readSkillConfig(packageDir);
+  const enabledTargets = getEnabledTargets(config);
+  if (enabledTargets.length === 0) {
+    console.warn("\u26A0 No targets enabled in configuration");
+    console.warn("Please enable at least one target in .claude-skill.json");
+    return;
+  }
+  console.log(`Installing skill "${config.name}" to ${enabledTargets.length} target(s):`);
+  enabledTargets.forEach((target) => {
+    console.log(`  \u2022 ${target.name}`);
+  });
+  const { sourceDir, cleanup, isRemote } = getSourceDir(config, packageDir);
+  if (isRemote) {
+    console.log(`
+\u{1F4E1} Source: Remote (${config.remoteSource})`);
+  } else {
+    console.log("\n\u{1F4E6} Source: Bundled (local)");
+  }
+  try {
+    const installedPaths = [];
+    for (const target of enabledTargets) {
+      try {
+        const installPath = installToTarget(target, config, sourceDir, isRemote);
+        installedPaths.push({ target: target.name, path: installPath });
+      } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error(`
+\u274C Failed to install to ${target.name}:`, message);
+      }
+    }
+    console.log("\n" + "=".repeat(60));
+    console.log("\u2705 Installation Complete!");
+    console.log("=".repeat(60));
+    if (installedPaths.length > 0) {
+      console.log("\nInstalled to:");
+      installedPaths.forEach(({ target, path: installPath }) => {
+        console.log(`  \u2022 ${target}: ${installPath}`);
+      });
+      console.log("\n\u{1F4D6} Next Steps:");
+      console.log("  1. Restart your AI coding tool(s)");
+      console.log('  2. Ask: "What skills are available?"');
+      console.log("  3. Start using your skill!");
+    }
+  } finally {
+    cleanup();
+  }
+}
+try {
+  installSkill();
+} catch (error) {
+  const message = error instanceof Error ? error.message : String(error);
+  console.error("\n\u274C Failed to install skill:", message);
+  console.error("\nTroubleshooting:");
+  console.error("- Ensure .claude-skill.json exists and is valid JSON");
+  console.error("- Ensure SKILL.md exists");
+  console.error("- Check file permissions for target directories");
+  console.error("- Verify at least one target is enabled in .claude-skill.json");
+  console.error("- Try running with sudo for global installation (if needed)");
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@adonis0123/skill-development",
+  "version": "1.0.1",
+  "description": "Claude Code Skill - 技能开发指南，提供创建有效技能的完整流程和最佳实践。安装时自动从 Anthropic 官方仓库拉取最新版本。",
+  "scripts": {
+    "postinstall": "node install-skill.js",
+    "preuninstall": "node uninstall-skill.js",
+    "test": "node install-skill.js && echo 'Installation test completed.'"
+  },
+  "files": [
+    "SKILL.md",
+    "references/",
+    "install-skill.js",
+    "uninstall-skill.js",
+    ".claude-skill.json",
+    "utils.js"
+  ],
+  "keywords": [
+    "claude-code",
+    "skill",
+    "development",
+    "guide",
+    "anthropic",
+    "progressive-disclosure"
+  ],
+  "author": "adonis",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Adonis0123/agent-skill-npm-boilerplate.git",
+    "directory": "packages/skill-development"
+  },
+  "homepage": "https://github.com/Adonis0123/agent-skill-npm-boilerplate/tree/main/packages/skill-development"
+}

package/references/skill-creator-original.md

@@ -0,0 +1,209 @@
+---
+name: skill-creator
+description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
+license: Complete terms in LICENSE.txt
+---
+
+# Skill Creator
+
+This skill provides guidance for creating effective skills.
+
+## About Skills
+
+Skills are modular, self-contained packages that extend Claude's capabilities by providing
+specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
+domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
+equipped with procedural knowledge that no model can fully possess.
+
+### What Skills Provide
+
+1. Specialized workflows - Multi-step procedures for specific domains
+2. Tool integrations - Instructions for working with specific file formats or APIs
+3. Domain expertise - Company-specific knowledge, schemas, business logic
+4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
+
+### Anatomy of a Skill
+
+Every skill consists of a required SKILL.md file and optional bundled resources:
+
+```
+skill-name/
+├── SKILL.md (required)
+│   ├── YAML frontmatter metadata (required)
+│   │   ├── name: (required)
+│   │   └── description: (required)
+│   └── Markdown instructions (required)
+└── Bundled Resources (optional)
+    ├── scripts/          - Executable code (Python/Bash/etc.)
+    ├── references/       - Documentation intended to be loaded into context as needed
+    └── assets/           - Files used in output (templates, icons, fonts, etc.)
+```
+
+#### SKILL.md (required)
+
+**Metadata Quality:** The `name` and `description` in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
+
+#### Bundled Resources (optional)
+
+##### Scripts (`scripts/`)
+
+Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
+
+- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
+- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
+- **Benefits**: Token efficient, deterministic, may be executed without loading into context
+- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
+
+##### References (`references/`)
+
+Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
+
+- **When to include**: For documentation that Claude should reference while working
+- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
+- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
+- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
+- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
+- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
+
+##### Assets (`assets/`)
+
+Files not intended to be loaded into context, but rather used within the output Claude produces.
+
+- **When to include**: When the skill needs files that will be used in the final output
+- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
+- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
+- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
+
+### Progressive Disclosure Design Principle
+
+Skills use a three-level loading system to manage context efficiently:
+
+1. **Metadata (name + description)** - Always in context (~100 words)
+2. **SKILL.md body** - When skill triggers (<5k words)
+3. **Bundled resources** - As needed by Claude (Unlimited*)
+
+*Unlimited because scripts can be executed without reading into context window.
+
+## Skill Creation Process
+
+To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
+
+### Step 1: Understanding the Skill with Concrete Examples
+
+Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
+
+To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
+
+For example, when building an image-editor skill, relevant questions include:
+
+- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
+- "Can you give some examples of how this skill would be used?"
+- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
+- "What would a user say that should trigger this skill?"
+
+To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
+
+Conclude this step when there is a clear sense of the functionality the skill should support.
+
+### Step 2: Planning the Reusable Skill Contents
+
+To turn concrete examples into an effective skill, analyze each example by:
+
+1. Considering how to execute on the example from scratch
+2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
+
+Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
+
+1. Rotating a PDF requires re-writing the same code each time
+2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
+
+Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
+
+1. Writing a frontend webapp requires the same boilerplate HTML/React each time
+2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
+
+Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
+
+1. Querying BigQuery requires re-discovering the table schemas and relationships each time
+2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
+
+To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
+
+### Step 3: Initializing the Skill
+
+At this point, it is time to actually create the skill.
+
+Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
+
+When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
+
+Usage:
+
+```bash
+scripts/init_skill.py <skill-name> --path <output-directory>
+```
+
+The script:
+
+- Creates the skill directory at the specified path
+- Generates a SKILL.md template with proper frontmatter and TODO placeholders
+- Creates example resource directories: `scripts/`, `references/`, and `assets/`
+- Adds example files in each directory that can be customized or deleted
+
+After initialization, customize or remove the generated SKILL.md and example files as needed.
+
+### Step 4: Edit the Skill
+
+When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
+
+#### Start with Reusable Skill Contents
+
+To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
+
+Also, delete any example files and directories not needed for the skill. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
+
+#### Update SKILL.md
+
+**Writing Style:** Write the entire skill using **imperative/infinitive form** (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
+
+To complete SKILL.md, answer the following questions:
+
+1. What is the purpose of the skill, in a few sentences?
+2. When should the skill be used?
+3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
+
+### Step 5: Packaging a Skill
+
+Once the skill is ready, it should be packaged into a distributable zip file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
+
+```bash
+scripts/package_skill.py <path/to/skill-folder>
+```
+
+Optional output directory specification:
+
+```bash
+scripts/package_skill.py <path/to/skill-folder> ./dist
+```
+
+The packaging script will:
+
+1. **Validate** the skill automatically, checking:
+   - YAML frontmatter format and required fields
+   - Skill naming conventions and directory structure
+   - Description completeness and quality
+   - File organization and resource references
+
+2. **Package** the skill if validation passes, creating a zip file named after the skill (e.g., `my-skill.zip`) that includes all files and maintains the proper directory structure for distribution.
+
+If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
+
+### Step 6: Iterate
+
+After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
+
+**Iteration workflow:**
+1. Use the skill on real tasks
+2. Notice struggles or inefficiencies
+3. Identify how SKILL.md or bundled resources should be updated
+4. Implement changes and test again