Skip to content

Commit 32e6866

Browse files
committed
UXDENG-394: Create react claude code plugin with agents/commands for standards and test gen
1 parent 8c557a5 commit 32e6866

File tree

8 files changed

+1100
-1
lines changed

8 files changed

+1100
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The primary aim is to offer a comprehensive, AI-friendly knowledge base and star
1414
## Core Components
1515
The core components of this repository are the README and markdown files found throughout the project. These files provide indexed documentation, guidelines, and best practices to support AI-assisted PatternFly development, regardless of which AI coding tool you use.
1616

17-
- **Table of Contents:** See [`.pf-ai-documentation/README.md`](documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.
17+
- **Table of Contents:** See [`.pf-ai-documentation/README.md`](.pf-ai-documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.
1818

1919
## Using This Documentation with Cursor and AI Tools
2020

@@ -52,6 +52,14 @@ To get the full benefit of these docs and rules:
5252
> 3. Save and restart your client/editor.
5353
> 4. For more details and setup instructions for other editors, see the official guide: https://github.com/upstash/context7#installation
5454
55+
## Claude Code plugins
56+
57+
For [Claude Code](https://code.claude.com) users, this repository includes plugins with agents for PatternFly development.
58+
59+
See [`claude-code/`](claude-code/) for available plugins and installation instructions.
60+
61+
---
62+
5563
## Reference Documentation
5664
- [PatternFly.org](https://www.patternfly.org/)
5765
- [PatternFly React GitHub Repository](https://github.com/patternfly/patternfly-react)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"name": "patternfly-ai-coding",
3+
"owner": {
4+
"name": "PatternFly Team"
5+
},
6+
"plugins": [
7+
{
8+
"name": "pf-react",
9+
"source": "./plugins/pf-react",
10+
"description": "PatternFly React coding standards and test generation agents"
11+
}
12+
]
13+
}

claude-code/README.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# PatternFly Claude Code Resources
2+
3+
This directory contains [Claude Code](https://code.claude.com) resources for PatternFly development.
4+
5+
## Available resources
6+
7+
### Plugins
8+
- **[pf-react](plugins/pf-react/)** - Coding standards and test generation agents for PatternFly React
9+
10+
---
11+
12+
## Installing plugins
13+
14+
### pf-react plugin
15+
16+
Once installed, these agents work across all your projects:
17+
18+
```bash
19+
# 1. Add the PatternFly marketplace
20+
/plugin marketplace add patternfly/patternfly-ai-coding
21+
22+
# 2. Install the plugin
23+
/plugin install pf-react@patternfly-ai-coding
24+
```
25+
26+
Done! The agents are now available globally.
27+
28+
## Using the agents
29+
30+
Use these agents from any project directory:
31+
32+
```bash
33+
cd ~/my-patternfly-app # Any project directory
34+
claude
35+
36+
# Use the agents
37+
/coding-standards # PatternFly React coding standards
38+
/test-generator # Generate tests for components
39+
```
40+
41+
## What's included
42+
43+
The `pf-react` plugin provides two agents:
44+
45+
### coding-standards
46+
PatternFly v6 React coding standards based on official PatternFly guidelines:
47+
- Component composition patterns
48+
- Design token usage
49+
- Accessibility requirements (WCAG 2.1 Level AA)
50+
- React and TypeScript best practices
51+
- Testing standards
52+
53+
### test-generator
54+
Unit test generation following Testing Library best practices:
55+
- User behavior testing over implementation details
56+
- Accessibility testing patterns
57+
- Semantic queries and OUIA guidelines
58+
- Proper mocking patterns
59+
60+
## Updating
61+
62+
Get the latest version:
63+
64+
```bash
65+
/plugin marketplace update patternfly-ai-coding
66+
/plugin install pf-react@patternfly-ai-coding
67+
```
68+
69+
## How it works
70+
71+
- **One-time install** - Add marketplace and install plugin (done once)
72+
- **Global availability** - Agents work in any project directory after installation
73+
- **No project setup needed** - Just run `/coding-standards` or `/test-generator` from any project
74+
- **Direct from GitHub** - No need to clone the repository
75+
76+
## Sources
77+
78+
The agents are based on:
79+
- [PatternFly.org](https://www.patternfly.org/) official documentation
80+
- [PatternFly React CONTRIBUTING.md](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md)
81+
- [PatternFly React Testing Wiki](https://github.com/patternfly/patternfly-react/wiki/React-Testing-Library-Basics,-Best-Practices,-and-Guidelines)
82+
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) official documentation
83+
- [React.dev](https://react.dev/learn) official documentation
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "pf-react",
3+
"description": "PatternFly React coding standards and test generation agents",
4+
"version": "1.0.0",
5+
"author": {
6+
"name": "PatternFly Team",
7+
"url": "https://www.patternfly.org"
8+
},
9+
"repository": "https://github.com/patternfly/patternfly-ai-coding",
10+
"license": "MIT"
11+
}

0 commit comments

Comments
 (0)