agents-config 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +12 -3
  2. package/bin/agents-init.js +15 -35
  3. package/instructions/development-standards.instructions.md +1 -1
  4. package/instructions/github-issue.instructions.md +1 -1
  5. package/instructions/github-release-notes.instructions.md +1 -1
  6. package/instructions/storybook.instructions.md +1 -1
  7. package/package.json +1 -1
  8. package/prompts/create-pr.prompt.md +2 -2
  9. package/skills/vercel-react-best-practices/AGENTS.md +0 -2719
  10. package/skills/vercel-react-best-practices/SKILL.md +0 -125
  11. package/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +0 -55
  12. package/skills/vercel-react-best-practices/rules/advanced-use-latest.md +0 -39
  13. package/skills/vercel-react-best-practices/rules/async-api-routes.md +0 -38
  14. package/skills/vercel-react-best-practices/rules/async-defer-await.md +0 -80
  15. package/skills/vercel-react-best-practices/rules/async-dependencies.md +0 -51
  16. package/skills/vercel-react-best-practices/rules/async-parallel.md +0 -28
  17. package/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +0 -99
  18. package/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +0 -59
  19. package/skills/vercel-react-best-practices/rules/bundle-conditional.md +0 -31
  20. package/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +0 -49
  21. package/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +0 -35
  22. package/skills/vercel-react-best-practices/rules/bundle-preload.md +0 -50
  23. package/skills/vercel-react-best-practices/rules/client-event-listeners.md +0 -74
  24. package/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +0 -71
  25. package/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +0 -48
  26. package/skills/vercel-react-best-practices/rules/client-swr-dedup.md +0 -56
  27. package/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +0 -107
  28. package/skills/vercel-react-best-practices/rules/js-cache-function-results.md +0 -80
  29. package/skills/vercel-react-best-practices/rules/js-cache-property-access.md +0 -28
  30. package/skills/vercel-react-best-practices/rules/js-cache-storage.md +0 -70
  31. package/skills/vercel-react-best-practices/rules/js-combine-iterations.md +0 -32
  32. package/skills/vercel-react-best-practices/rules/js-early-exit.md +0 -50
  33. package/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +0 -45
  34. package/skills/vercel-react-best-practices/rules/js-index-maps.md +0 -37
  35. package/skills/vercel-react-best-practices/rules/js-length-check-first.md +0 -49
  36. package/skills/vercel-react-best-practices/rules/js-min-max-loop.md +0 -82
  37. package/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +0 -24
  38. package/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +0 -57
  39. package/skills/vercel-react-best-practices/rules/rendering-activity.md +0 -26
  40. package/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +0 -47
  41. package/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +0 -40
  42. package/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +0 -38
  43. package/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +0 -46
  44. package/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +0 -82
  45. package/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +0 -28
  46. package/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +0 -75
  47. package/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +0 -39
  48. package/skills/vercel-react-best-practices/rules/rerender-dependencies.md +0 -45
  49. package/skills/vercel-react-best-practices/rules/rerender-derived-state.md +0 -29
  50. package/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +0 -74
  51. package/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +0 -58
  52. package/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +0 -38
  53. package/skills/vercel-react-best-practices/rules/rerender-memo.md +0 -44
  54. package/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +0 -35
  55. package/skills/vercel-react-best-practices/rules/rerender-transitions.md +0 -40
  56. package/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +0 -73
  57. package/skills/vercel-react-best-practices/rules/server-auth-actions.md +0 -96
  58. package/skills/vercel-react-best-practices/rules/server-cache-lru.md +0 -41
  59. package/skills/vercel-react-best-practices/rules/server-cache-react.md +0 -76
  60. package/skills/vercel-react-best-practices/rules/server-dedup-props.md +0 -65
  61. package/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +0 -83
  62. package/skills/vercel-react-best-practices/rules/server-serialization.md +0 -38
package/README.md CHANGED
@@ -3,7 +3,11 @@
3
3
  A comprehensive knowledge base and skill library for building production-grade React applications with AI-powered tools and best practices.
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/agents-config.svg)](https://www.npmjs.com/package/agents-config)
6
+ [![npm downloads](https://img.shields.io/npm/dm/agents-config.svg)](https://www.npmjs.com/package/agents-config)
6
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
8
+ [![GitHub stars](https://img.shields.io/github/stars/ericthayer/agents-config.svg)](https://github.com/ericthayer/agents-config/stargazers)
9
+ [![Node.js](https://img.shields.io/node/v/agents-config.svg)](https://nodejs.org/)
10
+ [![CI](https://github.com/ericthayer/agents-config/actions/workflows/ci.yml/badge.svg)](https://github.com/ericthayer/agents-config/actions/workflows/ci.yml)
7
11
 
8
12
  ## Overview
9
13
 
@@ -96,7 +100,7 @@ Detailed operational guidelines for specific development tasks:
96
100
  - **`github-issue.instructions.md`** - Process for creating and managing GitHub issues
97
101
  - **`github-release-notes.instructions.md`** - Guidelines for writing release notes
98
102
  - **`mui.instructions.md`** - Material-UI (MUI v7+) specific patterns, theming, and dark mode implementation
99
- - **`storybook.instructions.md`** - Setting up and maintaining Storybook documentation
103
+ - **`storybook.instructions.md`** - Setting up and maintaining Storybook v10.2 documentation
100
104
  - **`web-interface-guidelines.instructions.md`** - Accessibility and UX standards for web interfaces
101
105
 
102
106
  ### 📂 `rules/`
@@ -144,7 +148,7 @@ Implement Google Gemini API integration with:
144
148
  - Loading and streaming UI states
145
149
  - Attribution and safety requirements
146
150
 
147
- #### **`vercel-react-best-practices/`**
151
+ #### **`vercel-react-best-practices/`** (Optional via `npx add-skill vercel-labs/agent-skills`)
148
152
  Performance optimization guidelines from Vercel Engineering. Covers 45+ rules across 8 categories:
149
153
  - Eliminating waterfalls (async patterns)
150
154
  - Bundle size optimization
@@ -155,6 +159,11 @@ Performance optimization guidelines from Vercel Engineering. Covers 45+ rules ac
155
159
  - Event handling and refs
156
160
  - JavaScript optimization
157
161
 
162
+ **Installation:**
163
+ ```bash
164
+ npx add-skill vercel-labs/agent-skills
165
+ ```
166
+
158
167
  Includes subdirectories:
159
168
  - **`rules/`** - Individual rule documents (45+ files organized by category)
160
169
  - **`workflows/`** - Task-specific workflows:
@@ -177,7 +186,7 @@ Reference the appropriate skill or rule based on the development task:
177
186
  - Use `accessibility-audit` before marking features complete
178
187
  - Use `scaffold-component` when creating new components
179
188
  - Use `integrate-gemini` for AI feature implementation
180
- - Reference `vercel-react-best-practices` for performance optimization
189
+ - Install and reference `vercel-react-best-practices` for performance optimization (optional: `npx add-skill vercel-labs/agent-skills`)
181
190
 
182
191
  ### For Developers
183
192
  - Start with [AGENTS.md](AGENTS.md) for core principles
@@ -96,13 +96,13 @@ const DATABASES = {
96
96
  };
97
97
 
98
98
  // Core rules always included
99
- const CORE_RULES = ['accessibility', 'component-architecture', 'spec-driven-development'];
99
+ const CORE_RULES = ['accessibility', 'component-architecture', 'spec-driven-development', 'web-performance'];
100
100
 
101
101
  // Core skills always included
102
102
  const CORE_SKILLS = ['accessibility-audit', 'scaffold-component'];
103
103
 
104
104
  // Core instructions always included
105
- const CORE_INSTRUCTIONS = ['development-standards'];
105
+ const CORE_INSTRUCTIONS = ['development-standards', 'web-interface-guidelines'];
106
106
 
107
107
  // Parse command line arguments
108
108
  const args = process.argv.slice(2);
@@ -291,8 +291,7 @@ function determineSkills(config) {
291
291
 
292
292
  if (config.gemini) skills.push('integrate-gemini');
293
293
 
294
- // Always include vercel-react-best-practices (just the SKILL.md, not full rules subfolder)
295
- skills.push('vercel-react-best-practices');
294
+ // Additional skills can be installed via: npx add-skill vercel-labs/agent-skills
296
295
 
297
296
  return skills;
298
297
  }
@@ -403,37 +402,13 @@ function copyAgentsFolder(projectDir, config, filesToCreate) {
403
402
  const destDir = path.join(agentsDir, 'skills', skill);
404
403
 
405
404
  if (fs.existsSync(srcDir)) {
406
- // For vercel-react-best-practices, only copy SKILL.md and AGENTS.md (not the huge rules subfolder)
407
- if (skill === 'vercel-react-best-practices') {
408
- const skillMdSrc = path.join(srcDir, 'SKILL.md');
409
- const skillMdDest = path.join(destDir, 'SKILL.md');
410
- if (fs.existsSync(skillMdSrc)) {
411
- filesToCreate.push({
412
- src: skillMdSrc,
413
- dest: skillMdDest,
414
- relativePath: `.agents/skills/${skill}/SKILL.md`,
415
- type: 'file',
416
- });
417
- }
418
- const agentsMdSrc2 = path.join(srcDir, 'AGENTS.md');
419
- const agentsMdDest2 = path.join(destDir, 'AGENTS.md');
420
- if (fs.existsSync(agentsMdSrc2)) {
421
- filesToCreate.push({
422
- src: agentsMdSrc2,
423
- dest: agentsMdDest2,
424
- relativePath: `.agents/skills/${skill}/AGENTS.md`,
425
- type: 'file',
426
- });
427
- }
428
- } else {
429
- // Copy entire skill folder
430
- filesToCreate.push({
431
- src: srcDir,
432
- dest: destDir,
433
- relativePath: `.agents/skills/${skill}/`,
434
- type: 'folder',
435
- });
436
- }
405
+ // Copy entire skill folder
406
+ filesToCreate.push({
407
+ src: srcDir,
408
+ dest: destDir,
409
+ relativePath: `.agents/skills/${skill}/`,
410
+ type: 'folder',
411
+ });
437
412
  }
438
413
  }
439
414
 
@@ -679,6 +654,11 @@ ${colors.cyan}Next steps:${colors.reset}
679
654
  2. Commit the .agents/ folder and adapter files to git
680
655
  3. Your AI agents will now follow consistent guidelines
681
656
 
657
+ ${colors.cyan}Optional skills:${colors.reset}
658
+
659
+ ${colors.bright}npx add-skill vercel-labs/agent-skills${colors.reset}
660
+ Install Vercel's React best practices (45+ performance rules)
661
+
682
662
  ${colors.cyan}Useful commands:${colors.reset}
683
663
 
684
664
  ${colors.bright}npx agents-init --force${colors.reset} Regenerate all config files
@@ -3,7 +3,7 @@ applyTo: '**'
3
3
  ---
4
4
  # Development Standards and Best Practices
5
5
 
6
- This document outlines the standards and best practices for DevLog Application Development which uses React, TypeScript, Material UI, and follows the [Airbnb style guide](https://airbnb.io/javascript/) page.
6
+ This document outlines the standards and best practices for Application Development which uses React, TypeScript, Material UI, and follows the [Airbnb style guide](https://airbnb.io/javascript/) page.
7
7
 
8
8
  ## Web Interface Guidelines - Development Standards and Guidelines
9
9
  ALWAYS refer to the `.github/instructions/web-interface-guidelines.instructions.md` file for detailed explicit guidelines to follow when building _any_ web interface.
@@ -4,7 +4,7 @@ applyTo: '**/*.md, **/*.mdx'
4
4
 
5
5
  # GitHub Issue Creation Instructions
6
6
 
7
- Use these instructions to create well-structured, comprehensive GitHub issues for the DevLog application.
7
+ Use these instructions to create well-structured, comprehensive GitHub issues for the Application Development.
8
8
 
9
9
  ## Issue Structure Template
10
10
 
@@ -4,7 +4,7 @@ applyTo: '**/*.md, **/*.mdx'
4
4
 
5
5
  # GitHub Release Notes Instructions
6
6
 
7
- This document provides comprehensive instructions for creating professional, well-structured GitHub release notes for the DevLog application. Release notes are published in two formats: a **detailed version** and a **summary version**.
7
+ This document provides comprehensive instructions for creating professional, well-structured GitHub release notes for the Application Development. Release notes are published in two formats: a **detailed version** and a **summary version**.
8
8
 
9
9
  ## File Naming and Location
10
10
 
@@ -5,7 +5,7 @@ Provide project context and coding guidelines that AI should follow when generat
5
5
 
6
6
  # /build.storybook - Scaffold Storybook Story
7
7
 
8
- Generate a Storybook story file following the DevLog application patterns.
8
+ Generate a Storybook story file following the Application Development patterns.
9
9
 
10
10
  ## Usage
11
11
  - `/build.storybook ComponentName` - Creates basic story with Primary/Secondary variants
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agents-config",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "description": "A comprehensive knowledge base and skill library for building production-grade React applications with AI-powered tools and best practices.",
5
5
  "author": "Eric Thayer",
6
6
  "license": "MIT",
@@ -12,7 +12,7 @@ Analyze the last git commit and create a comprehensive PR description.
12
12
  1. **Get the latest commit details:**
13
13
  - Use `mcp_github_get_commit` with:
14
14
  - owner: `ericthayer`
15
- - repo: `devlog`
15
+ - repo: `agents-config`
16
16
  - sha: Get from `git log -1 --pretty=format:"%H"`
17
17
  - include_diff: `true`
18
18
 
@@ -66,7 +66,7 @@ gh pr create \
66
66
  See `.github/GITHUB_AUTH_SETUP.md` for authentication setup.
67
67
 
68
68
  ## Context
69
- - Repository: github.com/ericthayer/devlog
69
+ - Repository: github.com/ericthayer/agents-config
70
70
  - Default base branch: `main`
71
71
  - See `.github/pr-template-commits.md` for reusable PR description template
72
72
  - See `.github/GITHUB_AUTH_SETUP.md` for GitHub authentication guide