From 8eae2b6216c7ef9e48098db84ec986f66c1a0f7e Mon Sep 17 00:00:00 2001 From: mnxmnz <48766355+mnxmnz@users.noreply.github.com> Date: Thu, 3 Sep 2026 02:05:54 +0900 Subject: [PATCH] docs: add packages/plugin to the package overview in CLAUDE.md and AGENTS.md --- AGENTS.md | 7 ++++--- CLAUDE.md | 17 ++++++++++++----- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 86dda40e..4f72b49e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,10 +5,11 @@ ## Project Overview -React utility hooks/components library. Single package monorepo: +React utility hooks/components library. Two published packages and an agent plugin: -- `react-simplikit` (`packages/react-simplikit`) — Platform-independent React hooks & components -- Mobile web utilities (viewport, keyboard, layout) live in `packages/react-simplikit/src/mobile` and are exported from the root entry +- `react-simplikit` (`packages/react-simplikit`) — React hooks & components. Mobile web utilities (viewport, keyboard, layout) live in `src/mobile` and are exported from the root entry +- `react-simplikit-codemod` (`packages/codemod`) — bin-only CLI that migrates consumers off the retired `@react-simplikit/mobile` +- `packages/plugin` — agent skills for Claude Code, Codex and skills.sh. No `package.json`, so it is neither a workspace nor on npm. `yarn skill:gen` regenerates `skills/react-simplikit` from the public exports and `yarn test:skill` fails CI when the committed copy drifts; `skills/react-simplikit-codemod` is hand-written ## Architecture diff --git a/CLAUDE.md b/CLAUDE.md index 79c25bcc..5589f6d4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,10 +2,11 @@ ## Project Overview -React utility hooks/components library. Two published packages: +React utility hooks/components library. Two published packages and an agent plugin: - `react-simplikit` (`packages/react-simplikit`) — React hooks & components plus mobile web utilities (viewport, keyboard, layout), all exported from the single root entry (mobile source lives in `src/mobile`) - `react-simplikit-codemod` (`packages/codemod`) — bin-only CLI that migrates consumers off the retired `@react-simplikit/mobile`. The rules below describe the library; the exceptions that apply to the CLI are called out where they differ +- `packages/plugin` — agent skills for Claude Code (the root `.claude-plugin/marketplace.json` points here), Codex and skills.sh. No `package.json`, so it is neither a workspace nor on npm. `yarn skill:gen` regenerates `skills/react-simplikit` from the public exports and `yarn test:skill` fails CI when the committed copy drifts; `skills/react-simplikit-codemod` is hand-written ## Development Quick Start @@ -191,10 +192,16 @@ packages/ │ │ └── mobile/ # Mobile web utilities (exported from the root entry) │ ├── dist/ # Build output (per-module, mirrors src/) │ └── package.json -└── codemod/ # react-simplikit-codemod — bin-only CLI - ├── src/ # cli.ts plus runner/ and mobileToRoot/ - ├── test/ # e2e suite that spawns the built bin - └── package.json # declares `bin`, no main/types/module/exports +├── codemod/ # react-simplikit-codemod — bin-only CLI +│ ├── src/ # cli.ts plus runner/ and mobileToRoot/ +│ ├── test/ # e2e suite that spawns the built bin +│ └── package.json # declares `bin`, no main/types/module/exports +└── plugin/ # agent plugin — no package.json, not a workspace, not on npm + ├── .claude-plugin/ # plugin.json for Claude Code + ├── .codex-plugin/ # plugin.json for Codex + └── skills/ + ├── react-simplikit/ # generated by `yarn skill:gen`, gated by `yarn test:skill` + └── react-simplikit-codemod/ # hand-written ``` ## package.json Convention