Skip to content

docs: add packages/plugin to the package overview in CLAUDE.md and AGENTS.md #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mnxmnz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add packages/plugin to the package overview in CLAUDE.md and AGENTS.md #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eae2b6
docs: add packages/plugin to the package overview in CLAUDE.md and AG…
mnxmnz Sep 2, 2026
8c14694
Merge branch 'main' into docs/describe-packages-plugin-in-agent-docs
mnxmnz Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 12 additions & 5 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
Loading