From 84b9664b63f9d3dce0d6128777750e1de2bd4843 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 3 Mar 2026 16:51:07 -0600 Subject: [PATCH 1/2] feat: document dev env for agents (#1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Overview Documents dev environment for Agents. ## Related N/A ## Changes - **added** `AGENTS.md` ## Testing 1. **`npm install --include=optional`**:\ ✅ Dependencies installed successfully. 2. **`npm test -- --run`**:\ ✅ All tests passed (93 passed, 2 skipped, 1 todo). 3. **`npm run build`**:\ ✅ Build succeeded (Vite library build + TypeScript declarations generated). 4. **`npm run lint`**:\ ⚠️ ESLint is not a project dependency, and `.eslintrc.json` is a stub (pre-existing repo state). 5. **`npm start`**:\ ✅ Storybook dev server started successfully on port 9000. 6. **Manual Testing**:\ Verified Storybook UI by navigating to Button and Paginator components, and interacting with controls (e.g., `isLoading` prop on Button). ## Screenshots https://github.com/user-attachments/assets/6ee5edeb-b04f-4366-87be-3b592e6820d4 | paginator | button | | - | - | | ![paginator_component](https://github.com/user-attachments/assets/217d2993-1ba1-4abc-8166-8c52e249ef37) | ![button_loading_controls](https://github.com/user-attachments/assets/ed03960a-386d-4914-9597-c76da3537554) | ---

Open in Web Open in Cursor 

Co-authored-by: Cursor Agent Co-authored-by: Wesley B --- AGENTS.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..1288fca --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,20 @@ +# AGENTS.md + +## Cursor Cloud specific instructions + +This is `@tacc/core-components`, a React component library (TypeScript/JSX) built with Vite and demoed via Storybook. No backend, database, or Docker required. + +### Commands + +See `README.md` "Resources > Commands" for the full list. Key commands: + +- `npm start` — Storybook dev server on port 9000 +- `npm test` — Vitest unit tests (use `npm test -- --run` for single run) +- `npm run build` — Vite library build to `dist/` +- `npm run lint` — ESLint (see caveat below) + +### Caveats + +- **ESLint is not a project dependency.** The `npm run lint` script calls `eslint .` but `eslint` is not listed in `package.json`. The `.eslintrc.json` config is a stub with no parser or plugins, so linting does not currently function. Install eslint@8 globally (`npm install -g eslint@8`) if needed. +- **Storybook deps are optional.** Always use `npm install --include=optional` to get Storybook packages; plain `npm install` omits them. +- **Peer dependencies** (React, Formik, Reactstrap, etc.) are resolved from Storybook's transitive deps during development. They are not installed as direct devDependencies. From b56f0b95782e5546eb6518bdc17a43d25a2e963c Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 3 Mar 2026 17:06:58 -0600 Subject: [PATCH 2/2] docs: simply commands, delete inaccurate caveats --- AGENTS.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1288fca..09c3bd5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,15 +6,7 @@ This is `@tacc/core-components`, a React component library (TypeScript/JSX) buil ### Commands -See `README.md` "Resources > Commands" for the full list. Key commands: +See `README.md` "Developing" for key commands: -- `npm start` — Storybook dev server on port 9000 -- `npm test` — Vitest unit tests (use `npm test -- --run` for single run) -- `npm run build` — Vite library build to `dist/` -- `npm run lint` — ESLint (see caveat below) - -### Caveats - -- **ESLint is not a project dependency.** The `npm run lint` script calls `eslint .` but `eslint` is not listed in `package.json`. The `.eslintrc.json` config is a stub with no parser or plugins, so linting does not currently function. Install eslint@8 globally (`npm install -g eslint@8`) if needed. -- **Storybook deps are optional.** Always use `npm install --include=optional` to get Storybook packages; plain `npm install` omits them. -- **Peer dependencies** (React, Formik, Reactstrap, etc.) are resolved from Storybook's transitive deps during development. They are not installed as direct devDependencies. +- (if missing dependencies) `npm install --include=optional` +- `npm start`