codingwithagent 1.0.0 β 1.1.0
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.
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
## [1.1.0] - 2025-12-31
|
|
6
|
+
|
|
7
|
+
### Changed
|
|
8
|
+
|
|
9
|
+
- **Rebranding**: Project name updated from "Agentic Code Standards" to "**CodingWithAgent**" across all documentation, CLI outputs, and templates.
|
|
10
|
+
- **Documentation**: Enhanced README with visual CLI examples, detailed profile descriptions, and explicit support for Cursor, Windsurf, Antigravity, and Copilot.
|
|
11
|
+
- **CLI**: Updated initialization prompts to reflect new branding.
|
|
12
|
+
|
|
13
|
+
### Fixed
|
|
14
|
+
|
|
15
|
+
- Standardized branding headers in all template files (`minimal`, `standard`, `strict`, `accessibility`).
|
|
16
|
+
|
|
17
|
+
## [1.0.0] - 2025-12-30
|
|
18
|
+
|
|
19
|
+
- Initial release of CodingWithAgent.
|
|
20
|
+
- Support for Minimal, Standard, Strict, and Accessibility profiles.
|
|
21
|
+
- Automatic configuration for Cursor, Windsurf, and Copilot.
|
package/README.md
CHANGED
|
@@ -1,37 +1,112 @@
|
|
|
1
|
-
# π€
|
|
1
|
+
# π€ CodingWithAgent
|
|
2
2
|
|
|
3
|
-
**Production-ready coding standards and best practices for AI coding agents
|
|
3
|
+
**Production-ready coding standards and best practices for AI coding agents.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[](https://www.npmjs.com/package/codingwithagent)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
Stop fighting with inconsistent AI code output. Get enterprise-grade standards that work across **all major AI coding tools**βCursor, Windsurf, Google Antigravity, GitHub Copilot, and more.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
- π **Security**: OpenSSF-aligned secure coding practices
|
|
13
|
-
- π **Code Quality**: Maintainable, scalable patterns from day one
|
|
14
|
-
- π **Universal**: One standard, every AI coding agent
|
|
10
|
+
Turn your AI assistant into a senior engineer that knows your team's rules.
|
|
11
|
+
|
|
12
|
+
---
|
|
15
13
|
|
|
16
14
|
## π Quick Start
|
|
17
15
|
|
|
18
|
-
|
|
16
|
+
Initialize standardized rules in your project with a single command. **No installation required.**
|
|
19
17
|
|
|
20
18
|
```bash
|
|
21
19
|
npx codingwithagent init
|
|
22
20
|
```
|
|
23
21
|
|
|
24
|
-
|
|
22
|
+
The interactive CLI will guide you through the setup:
|
|
25
23
|
|
|
26
24
|
```
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
π€ CodingWithAgent
|
|
26
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
27
|
+
Production-ready standards for AI coding agents
|
|
28
|
+
|
|
29
|
+
π Choose your profile:
|
|
30
|
+
|
|
31
|
+
1. Minimal Essential rules only (great for getting started)
|
|
32
|
+
2. Standard Recommended baseline β (most popular)
|
|
33
|
+
3. Strict All rules enforced (maximum code quality)
|
|
34
|
+
4. Accessibility WCAG 2.1+ focused (a11y priority)
|
|
35
|
+
|
|
36
|
+
Enter number (1-4) [default: 2]: 2
|
|
37
|
+
|
|
38
|
+
π οΈ Select your AI coding tool:
|
|
39
|
+
|
|
40
|
+
1. Cursor (.cursorrules)
|
|
41
|
+
2. Windsurf (.windsurfrules)
|
|
42
|
+
3. Antigravity (.agent/rules/)
|
|
43
|
+
4. GitHub Copilot (.github/copilot-instructions.md)
|
|
44
|
+
5. Universal Works with most tools β
|
|
45
|
+
|
|
46
|
+
Enter number (1-5) [default: 5]: 1
|
|
47
|
+
|
|
48
|
+
βοΈ Installing...
|
|
49
|
+
|
|
50
|
+
β¨ Created .cursorrules with standard profile
|
|
51
|
+
π Setup complete!
|
|
29
52
|
```
|
|
30
53
|
|
|
31
|
-
##
|
|
54
|
+
## π¦ Profiles
|
|
55
|
+
|
|
56
|
+
Choose the level of enforcement that fits your project maturity.
|
|
57
|
+
|
|
58
|
+
| Profile | Description | Best For |
|
|
59
|
+
| :------------------- | :---------------------------------------------------------------------------------------- | :------------------------------------------- |
|
|
60
|
+
| **1. Minimal** | Essential rules only. Focuses on readability and basic modern patterns. | Prototyping, Hackathons, Personal Projects |
|
|
61
|
+
| **2. Standard** β | **Recommended.** Balanced set of best practices for React, Testing, and Security. | Most Production Applications |
|
|
62
|
+
| **3. Strict** | Maximum enforcement. TypeScript required, 90% test coverage, strict accessible standards. | Enterprise, Fintech, Healthcare, Large Teams |
|
|
63
|
+
| **4. Accessibility** | Heavy focus on WCAG 2.1 AA compliance, accessible patterns, and ARIA usage. | Government, Public Sector, Inclusive Apps |
|
|
64
|
+
|
|
65
|
+
## π οΈ Supported Agents
|
|
66
|
+
|
|
67
|
+
We standardize instructions across the entire AI ecosystem.
|
|
68
|
+
|
|
69
|
+
### 1. Cursor (`.cursorrules`)
|
|
70
|
+
|
|
71
|
+
Generates a comprehensive system prompt file in your project root. Cursor reads this to understand your tech stack, testing requirements, and styling preferences before it writes a single line of code.
|
|
72
|
+
|
|
73
|
+
### 2. Windsurf (`.windsurfrules`)
|
|
74
|
+
|
|
75
|
+
Creates a rule file compatible with the Windsurf editor, ensuring your Cascade flows follow your engineering standards.
|
|
76
|
+
|
|
77
|
+
### 3. Google Antigravity (`.agent/rules/`)
|
|
78
|
+
|
|
79
|
+
Installs a modular rule set in the `.agent` directory. Antigravity acts as a "Universal" agent and can ingest these specific markdown files (e.g., `accessibility.md`, `testing.md`) to contextually apply rules based on the user's task.
|
|
80
|
+
|
|
81
|
+
### 4. GitHub Copilot (`.github/copilot-instructions.md`)
|
|
82
|
+
|
|
83
|
+
Sets up project-specific instructions for GitHub Copilot Chat. This ensures Copilot suggests code that aligns with your specific architectural patterns.
|
|
84
|
+
|
|
85
|
+
### 5. Universal
|
|
86
|
+
|
|
87
|
+
A general-format rules file that works with most LLM-based tools that verify context files.
|
|
88
|
+
|
|
89
|
+
## π― What's Included?
|
|
90
|
+
|
|
91
|
+
Depending on the profile, your rules will cover:
|
|
92
|
+
|
|
93
|
+
- **β‘ Tech Stack**: React, TypeScript, Node.js, Next.js patterns.
|
|
94
|
+
- **βΏ Accessibility**: WCAG 2.1 AA+ compliance, correct ARIA usage, semantic HTML.
|
|
95
|
+
- **π§ͺ Testing**: Unit (Jest/Vitest), Integration, and E2E testing standards.
|
|
96
|
+
- **π Security**: Input validation, output sanitization, secret management (OpenSSF aligned).
|
|
97
|
+
- **π§ Anti-Hallucinations**: Instructions to prevent AI from inventing libraries or APIs.
|
|
98
|
+
- **π File Structure**: component/container architecture, proper folder organization.
|
|
99
|
+
|
|
100
|
+
## π€ Contributing
|
|
101
|
+
|
|
102
|
+
We welcome community contributions to improve these standards!
|
|
103
|
+
|
|
104
|
+
1. Fork the repository.
|
|
105
|
+
2. Add your improvements to the `templates` directory.
|
|
106
|
+
3. Submit a Pull Request.
|
|
107
|
+
|
|
108
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.
|
|
109
|
+
|
|
110
|
+
## π License
|
|
32
111
|
|
|
33
|
-
-
|
|
34
|
-
- Standard (recommended baseline) β
|
|
35
|
-
- Strict (all rules enforced)
|
|
36
|
-
- Accessibility-focused
|
|
37
|
-
- Custom (pick and choose)
|
|
112
|
+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
|
package/bin/init.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* CodingWithAgent CLI
|
|
5
5
|
* Interactive installer for AI coding agent standards
|
|
6
6
|
*/
|
|
7
7
|
|
|
@@ -31,7 +31,7 @@ function log(message, color = 'reset') {
|
|
|
31
31
|
|
|
32
32
|
function header() {
|
|
33
33
|
console.log('');
|
|
34
|
-
log('π€
|
|
34
|
+
log('π€ CodingWithAgent', 'cyan');
|
|
35
35
|
log('β'.repeat(60), 'cyan');
|
|
36
36
|
log('Production-ready standards for AI coding agents', 'bright');
|
|
37
37
|
console.log('');
|
package/package.json
CHANGED