diff --git a/.agents/agents.md b/.agents/agents.md new file mode 100644 index 00000000..e8096c0b --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,29 @@ +# react-codemod - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- React codemod scripts + +## Setup +See [`agents.yaml`](./agents.yaml) for prerequisites, commands, and ports. + +### Setup Hints +- `nvm` may not be loaded in your shell. If `nvm: command not found`, source it first. + +## Running the App +- Clone the repo +- Install: `npm install` +- This is a codemod library - no dev server available + +## Architecture +- React codemod scripts using jscodeshift +- Entry point: `transforms/index.js` + +## Working Agreement +- Write modular code +- Keep testable +- Incremental validation +- Commit meaningful checkpoints +- Write tests +- Validate before handoff diff --git a/.agents/agents.yaml b/.agents/agents.yaml new file mode 100644 index 00000000..91b3c369 --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,26 @@ +repo: + name: react-codemod + description: React codemod scripts + owner: reactjs + +prerequisites: + - name: GitHub CLI + - name: npm + - name: node + version: '>=12.0.0' + +setup: + - npm install + +dev: + command: npm test + port: null + +build: + command: npm run prepublish + +test: + command: npm test + +lint: + command: npm run lint