development

reskill Development Rules

Project Overview

reskill is a Git-based package manager for AI agent skills, similar to npm/Go modules. It provides declarative configuration, version locking, and seamless synchronization for managing skills across projects and teams.

Supported AI Agents: Cursor, Claude Code, Codex, OpenCode, Windsurf, GitHub Copilot, and more.

Tech Stack

• Language: TypeScript (ES Modules)
• Runtime: Node.js >= 18.0.0
• Build Tool: Rslib (Rspack-based library bundler)
• Testing: Vitest with @vitest/coverage-v8
• CLI Framework: Commander.js
• Linting/Formatting: Biome
• Package Manager: pnpm

Code Style Guidelines

Language Requirements

• Primary Language: English
• Comments: Must be in English only, no Chinese comments allowed
• Variable/Function Names: Use English, camelCase for variables and functions
• Class Names: PascalCase
• File Names: kebab-case for files, e.g., skill-manager.ts

TypeScript Standards

• Use strict TypeScript configuration
• Prefer type over interface for simple type aliases
• Use explicit return types for public functions
• Use readonly for immutable properties
• Avoid any type, use unknown with type guards instead

// Good
export function parseRef(ref: string): ParsedSkillRef { ... }

// Avoid
export function parseRef(ref: string) { ... }

Import Order

1. Node.js built-in modules (with node: prefix)
2. External dependencies
3. Internal modules (relative imports)

import * as path from 'node:path';
import * as fs from 'node:fs';

import { Command } from 'commander';
import semver from 'semver';

import { SkillManager } from '../core/skill-manager.js';
import type { InstalledSkill } from '../types/index.js';

Error Handling

• Use descriptive error messages in English
• Throw typed errors when possible
• Log errors with appropriate log levels
• Always clean up resources in error cases

// Good
if (!exists(skillPath)) {
  throw new Error(`Skill ${name} not found at ${skillPath}`);
}

// Log for user feedback
logger.error(`Failed to install ${name}: ${error.message}`);