From 2f7f82ffe9c97217024ab8c4b2ada171a04c0b88 Mon Sep 17 00:00:00 2001 From: "ecc-tools[bot]" <257055122+ecc-tools[bot]@users.noreply.github.com> Date: Thu, 2 Apr 2026 03:21:40 +0000 Subject: [PATCH] feat: add everything-claude-code ECC bundle (.claude/skills/everything-claude-code/SKILL.md) --- .../skills/everything-claude-code/SKILL.md | 581 +++++------------- 1 file changed, 152 insertions(+), 429 deletions(-) diff --git a/.claude/skills/everything-claude-code/SKILL.md b/.claude/skills/everything-claude-code/SKILL.md index 799c37f5..5718e788 100644 --- a/.claude/skills/everything-claude-code/SKILL.md +++ b/.claude/skills/everything-claude-code/SKILL.md @@ -1,442 +1,165 @@ ---- -name: everything-claude-code-conventions -description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits. ---- +```markdown +# everything-claude-code Development Patterns -# Everything Claude Code Conventions - -> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20 +> Auto-generated skill from repository analysis ## Overview -This skill teaches Claude the development patterns and conventions used in everything-claude-code. - -## Tech Stack - -- **Primary Language**: JavaScript -- **Architecture**: hybrid module organization -- **Test Location**: separate - -## When to Use This Skill - -Activate this skill when: -- Making changes to this repository -- Adding new features following established patterns -- Writing tests that match project conventions -- Creating commits with proper message format - -## Commit Conventions - -Follow these commit message conventions based on 500 analyzed commits. - -### Commit Style: Conventional Commits - -### Prefixes Used - -- `fix` -- `test` -- `feat` -- `docs` - -### Message Guidelines - -- Average message length: ~65 characters -- Keep first line concise and descriptive -- Use imperative mood ("Add feature" not "Added feature") - - -*Commit message example* - -```text -feat(rules): add C# language support -``` - -*Commit message example* - -```text -chore(deps-dev): bump flatted (#675) -``` - -*Commit message example* - -```text -fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691) -``` - -*Commit message example* - -```text -docs: add Antigravity setup and usage guide (#552) -``` - -*Commit message example* - -```text -merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer -``` - -*Commit message example* - -```text -Revert "Add Kiro IDE support (.kiro/) (#548)" -``` - -*Commit message example* - -```text -Add Kiro IDE support (.kiro/) (#548) -``` - -*Commit message example* - -```text -feat: add block-no-verify hook for Claude Code and Cursor (#649) -``` - -## Architecture - -### Project Structure: Single Package - -This project uses **hybrid** module organization. - -### Configuration Files - -- `.github/workflows/ci.yml` -- `.github/workflows/maintenance.yml` -- `.github/workflows/monthly-metrics.yml` -- `.github/workflows/release.yml` -- `.github/workflows/reusable-release.yml` -- `.github/workflows/reusable-test.yml` -- `.github/workflows/reusable-validate.yml` -- `.opencode/package.json` -- `.opencode/tsconfig.json` -- `.prettierrc` -- `eslint.config.js` -- `package.json` - -### Guidelines - -- This project uses a hybrid organization -- Follow existing patterns when adding new code - -## Code Style - -### Language: JavaScript - -### Naming Conventions - -| Element | Convention | -|---------|------------| -| Files | camelCase | -| Functions | camelCase | -| Classes | PascalCase | -| Constants | SCREAMING_SNAKE_CASE | - -### Import Style: Relative Imports - -### Export Style: Mixed Style - - -*Preferred import style* - -```typescript -// Use relative imports -import { Button } from '../components/Button' -import { useAuth } from './hooks/useAuth' -``` - -## Testing - -### Test Framework - -No specific test framework detected — use the repository's existing test patterns. - -### File Pattern: `*.test.js` - -### Test Types - -- **Unit tests**: Test individual functions and components in isolation -- **Integration tests**: Test interactions between multiple components/services - -### Coverage - -This project has coverage reporting configured. Aim for 80%+ coverage. - - -## Error Handling - -### Error Handling Style: Try-Catch Blocks - - -*Standard error handling pattern* - -```typescript -try { - const result = await riskyOperation() - return result -} catch (error) { - console.error('Operation failed:', error) - throw new Error('User-friendly message') -} -``` - -## Common Workflows - -These workflows were detected from analyzing commit patterns. - -### Database Migration - -Database schema changes with migration files - -**Frequency**: ~2 times per month - -**Steps**: -1. Create migration file -2. Update schema definitions -3. Generate/update types - -**Files typically involved**: -- `**/schema.*` -- `migrations/*` - -**Example commit sequence**: -``` -feat: implement --with/--without selective install flags (#679) -fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693) -feat(rules): add Rust language rules (rebased #660) (#686) -``` - -### Feature Development - -Standard feature implementation workflow - -**Frequency**: ~22 times per month - -**Steps**: -1. Add feature implementation -2. Add tests for feature -3. Update documentation - -**Files typically involved**: -- `manifests/*` -- `schemas/*` -- `**/*.test.*` -- `**/api/**` - -**Example commit sequence**: -``` -feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer -docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies -fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty -``` - -### Add Language Rules - -Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines. - -**Frequency**: ~2 times per month - -**Steps**: -1. Create a new directory under rules/{language}/ -2. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content -3. Optionally reference or link to related skills - -**Files typically involved**: -- `rules/*/coding-style.md` -- `rules/*/hooks.md` -- `rules/*/patterns.md` -- `rules/*/security.md` -- `rules/*/testing.md` - -**Example commit sequence**: -``` -Create a new directory under rules/{language}/ -Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content -Optionally reference or link to related skills -``` +This skill teaches the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. The project is modular, skill-oriented, and emphasizes clear documentation, conventional commits, and extensibility via skills, agents, commands, and install targets. This guide will help you contribute effectively by following established patterns and using the right commands for common tasks. + +## Coding Conventions + +**File Naming** +- Use `camelCase` for JavaScript files and directories. + - Example: `mySkill.js`, `installTarget.js` + +**Import Style** +- Use relative imports. + - Example: + ```js + const helper = require('./helper'); + import { doSomething } from '../utils/doSomething'; + ``` + +**Export Style** +- Mixed: both CommonJS (`module.exports`) and ES6 (`export`) exports are used. + - Example (CommonJS): + ```js + module.exports = function myFunction() { ... }; + ``` + - Example (ES6): + ```js + export function myFunction() { ... } + ``` + +**Commit Messages** +- Use [Conventional Commits](https://www.conventionalcommits.org/): + - Prefixes: `fix`, `feat`, `docs`, `chore` + - Example: `feat: add new agent pipeline for document processing` + +## Workflows ### Add New Skill +**Trigger:** When introducing a new skill (capability/module) to the platform +**Command:** `/add-skill` -Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts. +1. Create a new `SKILL.md` under `skills//` or `.agents/skills//`. +2. Optionally add related assets or references in the skill directory. +3. Update documentation: + - `AGENTS.md` + - `README.md` + - `README.zh-CN.md` + - `docs/zh-CN/AGENTS.md` +4. If the skill is installable, update: + - `manifests/install-components.json` or + - `manifests/install-modules.json` +5. Optionally update `WORKING-CONTEXT.md`. -**Frequency**: ~4 times per month - -**Steps**: -1. Create a new directory under skills/{skill-name}/ -2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.) -3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/ -4. Address review feedback and iterate on documentation - -**Files typically involved**: -- `skills/*/SKILL.md` -- `skills/*/scripts/*.sh` -- `skills/*/scripts/*.js` - -**Example commit sequence**: +**Example directory structure:** ``` -Create a new directory under skills/{skill-name}/ -Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.) -Optionally add scripts or supporting files under skills/{skill-name}/scripts/ -Address review feedback and iterate on documentation +skills/ + myNewSkill/ + SKILL.md + index.js + assets/ ``` -### Add New Agent - -Adds a new agent to the system for code review, build resolution, or other automated tasks. - -**Frequency**: ~2 times per month - -**Steps**: -1. Create a new agent markdown file under agents/{agent-name}.md -2. Register the agent in AGENTS.md -3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md - -**Files typically involved**: -- `agents/*.md` -- `AGENTS.md` -- `README.md` -- `docs/COMMAND-AGENT-MAP.md` - -**Example commit sequence**: -``` -Create a new agent markdown file under agents/{agent-name}.md -Register the agent in AGENTS.md -Optionally update README.md and docs/COMMAND-AGENT-MAP.md -``` - -### Add New Command - -Adds a new command to the system, often paired with a backing skill. - -**Frequency**: ~1 times per month - -**Steps**: -1. Create a new markdown file under commands/{command-name}.md -2. Optionally add or update a backing skill under skills/{skill-name}/SKILL.md - -**Files typically involved**: -- `commands/*.md` -- `skills/*/SKILL.md` - -**Example commit sequence**: -``` -Create a new markdown file under commands/{command-name}.md -Optionally add or update a backing skill under skills/{skill-name}/SKILL.md -``` - -### Sync Catalog Counts - -Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state. - -**Frequency**: ~3 times per month - -**Steps**: -1. Update agent, skill, and command counts in AGENTS.md -2. Update the same counts in README.md (quick-start, comparison table, etc.) -3. Optionally update other documentation files - -**Files typically involved**: -- `AGENTS.md` -- `README.md` - -**Example commit sequence**: -``` -Update agent, skill, and command counts in AGENTS.md -Update the same counts in README.md (quick-start, comparison table, etc.) -Optionally update other documentation files -``` - -### Add Cross Harness Skill Copies - -Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms. - -**Frequency**: ~2 times per month - -**Steps**: -1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md -2. Optionally add harness-specific openai.yaml or config files -3. Address review feedback to align with CONTRIBUTING template - -**Files typically involved**: -- `.agents/skills/*/SKILL.md` -- `.cursor/skills/*/SKILL.md` -- `.agents/skills/*/agents/openai.yaml` - -**Example commit sequence**: -``` -Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md -Optionally add harness-specific openai.yaml or config files -Address review feedback to align with CONTRIBUTING template -``` - -### Add Or Update Hook - -Adds or updates git or bash hooks to enforce workflow, quality, or security policies. - -**Frequency**: ~1 times per month - -**Steps**: -1. Add or update hook scripts in hooks/ or scripts/hooks/ -2. Register the hook in hooks/hooks.json or similar config -3. Optionally add or update tests in tests/hooks/ - -**Files typically involved**: -- `hooks/*.hook` -- `hooks/hooks.json` -- `scripts/hooks/*.js` -- `tests/hooks/*.test.js` -- `.cursor/hooks.json` - -**Example commit sequence**: -``` -Add or update hook scripts in hooks/ or scripts/hooks/ -Register the hook in hooks/hooks.json or similar config -Optionally add or update tests in tests/hooks/ -``` - -### Address Review Feedback - -Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment. - -**Frequency**: ~4 times per month - -**Steps**: -1. Edit SKILL.md, agent, or command files to address reviewer comments -2. Update examples, headings, or configuration as requested -3. Iterate until all review feedback is resolved - -**Files typically involved**: -- `skills/*/SKILL.md` -- `agents/*.md` -- `commands/*.md` -- `.agents/skills/*/SKILL.md` -- `.cursor/skills/*/SKILL.md` - -**Example commit sequence**: -``` -Edit SKILL.md, agent, or command files to address reviewer comments -Update examples, headings, or configuration as requested -Iterate until all review feedback is resolved -``` - - -## Best Practices - -Based on analysis of the codebase, follow these practices: - -### Do - -- Use conventional commit format (feat:, fix:, etc.) -- Follow *.test.js naming pattern -- Use camelCase for file names -- Prefer mixed exports - -### Don't - -- Don't write vague commit messages -- Don't skip tests for new features -- Don't deviate from established patterns without discussion - --- -*This skill was auto-generated by [ECC Tools](https://ecc.tools). Review and customize as needed for your team.* +### Add New Agent or Pipeline +**Trigger:** When introducing a new agent or orchestrated workflow (pipeline) +**Command:** `/add-agent-pipeline` + +1. Create agent definition files under `agents/`. +2. Create or update a `SKILL.md` for the orchestrator under `skills//`. +3. Update `AGENTS.md` and `README.md` to document the new agent(s)/pipeline. +4. Optionally add supporting commands, scripts, or documentation. + +--- + +### Add or Extend Command +**Trigger:** When adding or enhancing CLI commands +**Command:** `/add-command` + +1. Create or update command markdown files under `commands/`. +2. Incorporate review feedback and fixes as needed. +3. Document new commands in `AGENTS.md` or other relevant docs. + +--- + +### Add Install Target or Adapter +**Trigger:** When supporting a new install target (plugin, IDE, platform) +**Command:** `/add-install-target` + +1. Create a new directory for the install target (e.g., `.codebuddy/`, `.gemini/`). +2. Add install/uninstall scripts and documentation in the new directory. +3. Update `manifests/install-modules.json` and relevant schemas. +4. Update or add scripts in `scripts/lib/install-targets/.js`. +5. Update or add tests for the new install target. + +**Example:** +``` +.codebuddy/ + install.sh + uninstall.sh + README.md +scripts/lib/install-targets/codebuddy.js +tests/lib/install-targets.test.js +``` + +--- + +### Update or Harden Hooks +**Trigger:** When improving, refactoring, or fixing hooks (e.g., CI, formatting, session management) +**Command:** `/update-hook` + +1. Update `hooks/hooks.json` to change hook configuration. +2. Update or add scripts in `scripts/hooks/*.js` or `scripts/hooks/*.sh`. +3. Update or add tests for the affected hooks. +4. Optionally update related documentation. + +--- + +### Documentation Sync and Guidance Update +**Trigger:** When updating documentation to reflect new features, skills, or workflows +**Command:** `/sync-docs` + +1. Update `README.md`, `README.zh-CN.md`, and/or `AGENTS.md`. +2. Update `docs/zh-CN/AGENTS.md` and `docs/zh-CN/README.md`. +3. Update or add `WORKING-CONTEXT.md`. +4. Optionally update `the-shortform-guide.md` or other guidance files. + +--- + +### Dependency Bump via Dependabot +**Trigger:** When a dependency update is triggered by Dependabot or similar automation +**Command:** `/bump-dependency` + +1. Update `package.json` and/or `yarn.lock` for npm dependencies. +2. Update `.github/workflows/*.yml` for GitHub Actions dependencies. +3. Commit with a standardized message and co-author. + +--- + +## Testing Patterns + +- Test files use the pattern `*.test.js`. +- Testing framework is not explicitly specified; check test files for usage. +- Place tests alongside or within a `tests/` directory, matching the structure of the code under test. +- Example test file: + ``` + tests/lib/install-targets.test.js + ``` + +## Commands + +| Command | Purpose | +|--------------------|------------------------------------------------------------------| +| /add-skill | Add a new skill, including docs and registration | +| /add-agent-pipeline| Add a new agent or orchestrated pipeline | +| /add-command | Add or extend a CLI command | +| /add-install-target| Add support for a new install target or adapter | +| /update-hook | Refactor or fix hooks and related scripts | +| /sync-docs | Synchronize and update documentation across contexts/languages | +| /bump-dependency | Automated dependency update via Dependabot or similar automation | +```