metacoding 1.0.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 +91 -0
- package/LICENSE +21 -0
- package/README.md +244 -0
- package/bin/metacoding.js +27 -0
- package/lib/cli.d.ts +2 -0
- package/lib/cli.d.ts.map +1 -0
- package/lib/cli.js +83 -0
- package/lib/cli.js.map +1 -0
- package/lib/commands/init.d.ts +15 -0
- package/lib/commands/init.d.ts.map +1 -0
- package/lib/commands/init.js +185 -0
- package/lib/commands/init.js.map +1 -0
- package/lib/commands/update.d.ts +5 -0
- package/lib/commands/update.d.ts.map +1 -0
- package/lib/commands/update.js +20 -0
- package/lib/commands/update.js.map +1 -0
- package/lib/commands/validate.d.ts +5 -0
- package/lib/commands/validate.d.ts.map +1 -0
- package/lib/commands/validate.js +20 -0
- package/lib/commands/validate.js.map +1 -0
- package/lib/services/filesystem.d.ts +13 -0
- package/lib/services/filesystem.d.ts.map +1 -0
- package/lib/services/filesystem.js +84 -0
- package/lib/services/filesystem.js.map +1 -0
- package/lib/services/project-detector.d.ts +12 -0
- package/lib/services/project-detector.d.ts.map +1 -0
- package/lib/services/project-detector.js +191 -0
- package/lib/services/project-detector.js.map +1 -0
- package/lib/services/template-manager.d.ts +15 -0
- package/lib/services/template-manager.d.ts.map +1 -0
- package/lib/services/template-manager.js +167 -0
- package/lib/services/template-manager.js.map +1 -0
- package/lib/services/vscode.d.ts +10 -0
- package/lib/services/vscode.d.ts.map +1 -0
- package/lib/services/vscode.js +108 -0
- package/lib/services/vscode.js.map +1 -0
- package/lib/types/index.d.ts +66 -0
- package/lib/types/index.d.ts.map +1 -0
- package/lib/types/index.js +3 -0
- package/lib/types/index.js.map +1 -0
- package/package.json +134 -0
- package/templates/general/files/code-review.instructions.md +111 -0
- package/templates/general/files/copilot-instructions.md.template +404 -0
- package/templates/general/files/docs-update.instructions.md +203 -0
- package/templates/general/files/release.instructions.md +72 -0
- package/templates/general/files/test-runner.instructions.md +107 -0
- package/templates/general/template.json +9 -0
- package/templates/node/files/code-review.instructions.md +222 -0
- package/templates/node/files/copilot-instructions.md.template +391 -0
- package/templates/node/files/docs-update.instructions.md +203 -0
- package/templates/node/files/release.instructions.md +72 -0
- package/templates/node/files/test-runner.instructions.md +108 -0
- package/templates/node/template.json +23 -0
- package/templates/python/files/code-review.instructions.md +215 -0
- package/templates/python/files/copilot-instructions.md.template +418 -0
- package/templates/python/files/docs-update.instructions.md +203 -0
- package/templates/python/files/release.instructions.md +72 -0
- package/templates/python/files/test-runner.instructions.md +108 -0
- package/templates/python/template.json +75 -0
- package/templates/react/files/code-review.instructions.md +160 -0
- package/templates/react/files/copilot-instructions.md.template +472 -0
- package/templates/react/files/docs-update.instructions.md +203 -0
- package/templates/react/files/release.instructions.md +72 -0
- package/templates/react/files/test-runner.instructions.md +108 -0
- package/templates/react/template.json +14 -0
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Step-by-step release process automation"
|
|
3
|
+
applyTo: "package.json"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Release Process Checklist
|
|
7
|
+
|
|
8
|
+
## Pre-Release Validation
|
|
9
|
+
1. **Test Suite:** Verify all tests pass: `npm test`
|
|
10
|
+
2. **Build Verification:** Ensure clean build without errors: `npm run build`
|
|
11
|
+
3. **Linting:** Check code quality standards: `npm run lint`
|
|
12
|
+
4. **Dependencies:** Review and update dependencies if needed
|
|
13
|
+
5. **Security Audit:** Run security audit: `npm audit`
|
|
14
|
+
|
|
15
|
+
## Version Management
|
|
16
|
+
1. **Semantic Versioning:** Update version in package.json following SemVer:
|
|
17
|
+
- **MAJOR:** Breaking changes (X.0.0)
|
|
18
|
+
- **MINOR:** New features, backward compatible (0.X.0)
|
|
19
|
+
- **PATCH:** Bug fixes, backward compatible (0.0.X)
|
|
20
|
+
2. **Version Consistency:** Ensure version matches across all relevant files
|
|
21
|
+
3. **Breaking Changes:** Document breaking changes prominently in changelog
|
|
22
|
+
|
|
23
|
+
## Documentation Updates
|
|
24
|
+
1. **README.md Updates:**
|
|
25
|
+
- Update version badges to match package.json version
|
|
26
|
+
- Refresh installation instructions if needed
|
|
27
|
+
- Update feature descriptions for new capabilities
|
|
28
|
+
- Verify all links and examples work correctly
|
|
29
|
+
2. **API Documentation:** Update API docs for any interface changes
|
|
30
|
+
|
|
31
|
+
## Changelog Management
|
|
32
|
+
1. **Add New Entry:** Create new section in CHANGELOG.md with:
|
|
33
|
+
- Release version number (matching package.json)
|
|
34
|
+
- Release date in YYYY-MM-DD format
|
|
35
|
+
- Grouped changes by category:
|
|
36
|
+
- **Added:** New features
|
|
37
|
+
- **Changed:** Changes in existing functionality
|
|
38
|
+
- **Deprecated:** Soon-to-be removed features
|
|
39
|
+
- **Removed:** Now removed features
|
|
40
|
+
- **Fixed:** Bug fixes
|
|
41
|
+
- **Security:** Security vulnerability fixes
|
|
42
|
+
2. **Entry Guidelines:**
|
|
43
|
+
- Keep entries brief but descriptive (1-2 lines per change)
|
|
44
|
+
- Focus on user impact rather than technical implementation
|
|
45
|
+
- Reference issue/PR numbers when applicable: `(#123)`
|
|
46
|
+
- Highlight breaking changes with ⚠️ or **BREAKING:**
|
|
47
|
+
|
|
48
|
+
## Git Operations
|
|
49
|
+
1. **Commit Changes:** Stage all release-related changes
|
|
50
|
+
2. **Commit Message:** Use format: `chore: bump version to vX.Y.Z`
|
|
51
|
+
3. **Create Tag:** Tag the commit with version number: `git tag vX.Y.Z`
|
|
52
|
+
4. **Push Changes:** Push commits and tags: `git push && git push --tags`
|
|
53
|
+
|
|
54
|
+
## GitHub Release
|
|
55
|
+
1. **Create Release:** Create GitHub release with tag matching package.json version
|
|
56
|
+
2. **Release Title:** Use format: `vX.Y.Z - [Brief description]`
|
|
57
|
+
3. **Release Notes:**
|
|
58
|
+
- Copy relevant sections from CHANGELOG.md
|
|
59
|
+
- Include installation instructions
|
|
60
|
+
- Highlight major changes and breaking changes
|
|
61
|
+
- Thank contributors if applicable
|
|
62
|
+
|
|
63
|
+
## Post-Release Verification
|
|
64
|
+
1. **Package Registry:** Verify package published correctly (if applicable)
|
|
65
|
+
2. **Installation Test:** Test installation from registry in clean environment
|
|
66
|
+
3. **Documentation Links:** Ensure all documentation links work correctly
|
|
67
|
+
4. **Monitor Issues:** Watch for any immediate issues reported by users
|
|
68
|
+
|
|
69
|
+
## Rollback Plan
|
|
70
|
+
- **Git Revert:** Know how to revert problematic releases
|
|
71
|
+
- **Package Unpublish:** Understand package registry policies for unpublishing
|
|
72
|
+
- **Communication:** Prepare communication strategy for critical issues
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Instructions for running and maintaining tests'
|
|
3
|
+
applyTo: 'test/**/*.ts'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Test Execution Guidelines
|
|
7
|
+
|
|
8
|
+
## Pre-Commit Testing
|
|
9
|
+
|
|
10
|
+
- Run all tests before committing changes: `npm test`
|
|
11
|
+
- Ensure tests pass in both development and CI environments
|
|
12
|
+
- Fix failing tests before proceeding with commits
|
|
13
|
+
- Run specific test suites for targeted changes when appropriate
|
|
14
|
+
|
|
15
|
+
## Test Development Standards
|
|
16
|
+
|
|
17
|
+
- **New Features:** Ensure all new features have corresponding unit tests
|
|
18
|
+
- **Test Coverage:** Aim for high coverage of critical functionality paths
|
|
19
|
+
- **Test Documentation:** Follow table format in `test/test-documentation.md` for all test cases
|
|
20
|
+
- **Test Organization:** Group related tests in describe blocks with clear hierarchy
|
|
21
|
+
|
|
22
|
+
## Test Case Documentation Format
|
|
23
|
+
|
|
24
|
+
All test cases must be documented using the standardized table format:
|
|
25
|
+
|
|
26
|
+
```markdown
|
|
27
|
+
| Test Case ID | Description | Type | Status |
|
|
28
|
+
| :------------ | :------------------------------------------ | :--- | :-------- |
|
|
29
|
+
| AREA-TYPE-001 | Brief but descriptive test case description | Unit | Completed |
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Test Case Naming Conventions
|
|
33
|
+
|
|
34
|
+
### Test Case ID Format: `[AREA]-[TYPE]-[NUMBER]`
|
|
35
|
+
|
|
36
|
+
**Area Prefixes (React/Frontend specific):**
|
|
37
|
+
|
|
38
|
+
- `COMP` - React component tests
|
|
39
|
+
- `HOOK` - Custom hooks tests
|
|
40
|
+
- `PAGE` - Page/Route component tests
|
|
41
|
+
- `STORE` - State management tests (Redux/Zustand)
|
|
42
|
+
- `API` - API service layer tests
|
|
43
|
+
- `UTIL` - Utility function tests
|
|
44
|
+
- `AUTH` - Authentication flow tests
|
|
45
|
+
- `FORM` - Form validation tests
|
|
46
|
+
- `DOC` - Documentation Quality tests
|
|
47
|
+
- `E2E` - End-to-End workflow tests
|
|
48
|
+
- `INT` - Integration tests
|
|
49
|
+
|
|
50
|
+
**Type Suffixes:**
|
|
51
|
+
|
|
52
|
+
- `UNIT` - Unit tests
|
|
53
|
+
- `INT` - Integration tests
|
|
54
|
+
- `E2E` - End-to-end tests
|
|
55
|
+
|
|
56
|
+
**Examples:**
|
|
57
|
+
|
|
58
|
+
- `COMP-UNIT-001` - First unit test for React Components
|
|
59
|
+
- `HOOK-UNIT-001` - First unit test for Custom Hooks
|
|
60
|
+
- `API-INT-001` - First integration test for API Services
|
|
61
|
+
- `E2E-WF-001` - First end-to-end workflow test
|
|
62
|
+
|
|
63
|
+
### Test Method Naming
|
|
64
|
+
|
|
65
|
+
- Format: `methodName_scenario_expectedOutcome`
|
|
66
|
+
- Example: `getUserById_userExists_returnsUserObject`
|
|
67
|
+
- Use camelCase for all test method names
|
|
68
|
+
|
|
69
|
+
## Test Data Management
|
|
70
|
+
|
|
71
|
+
- **Fixtures:** Update test fixtures when data structures change
|
|
72
|
+
- **Realistic Data:** Use realistic data in integration tests to catch real-world issues
|
|
73
|
+
- **Mock Strategy:** Mock external dependencies in unit tests for isolation
|
|
74
|
+
- **Test Database:** Use separate test database/environment for integration tests
|
|
75
|
+
- **Temporary File Cleanup:** Clean up all temporary test files, debug outputs, and mock data after test execution
|
|
76
|
+
- **Fixture Organization:** Move reusable test data to `/test/fixtures/` directory for proper organization
|
|
77
|
+
|
|
78
|
+
## Test File Hygiene
|
|
79
|
+
|
|
80
|
+
- **No Orphaned Files:** Remove temporary test files created during debugging or development
|
|
81
|
+
- **Debug Output Cleanup:** Remove console.log statements and debug files before committing
|
|
82
|
+
- **Test Artifact Management:** Ensure test screenshots, logs, and reports are properly managed or cleaned up
|
|
83
|
+
- **Resource Management:** Properly dispose of file handles, database connections, and other test resources
|
|
84
|
+
|
|
85
|
+
## Test Types and Patterns
|
|
86
|
+
|
|
87
|
+
- **Unit Tests:** Test individual functions, methods, and components in isolation
|
|
88
|
+
- **Integration Tests:** Test feature workflows and component interactions
|
|
89
|
+
- **End-to-End Tests:** Test complete user scenarios and workflows
|
|
90
|
+
- **Regression Tests:** Add tests for previously fixed bugs to prevent recurrence
|
|
91
|
+
|
|
92
|
+
## Performance Testing
|
|
93
|
+
|
|
94
|
+
- **Test Execution Speed:** Keep unit tests fast (under 100ms each when possible)
|
|
95
|
+
- **Parallel Execution:** Structure tests to run safely in parallel
|
|
96
|
+
- **Resource Cleanup:** Ensure proper cleanup of test resources and temporary data
|
|
97
|
+
- **Memory Management:** Monitor and prevent memory leaks in long-running test suites
|
|
98
|
+
|
|
99
|
+
## Test Maintenance
|
|
100
|
+
|
|
101
|
+
- **Regular Review:** Periodically review and refactor outdated tests
|
|
102
|
+
- **Documentation:** Document complex test scenarios and their purposes
|
|
103
|
+
- **Continuous Updates:** Update tests when requirements or APIs change
|
|
104
|
+
- **Test Quality:** Apply the same code quality standards to test code as production code
|
|
105
|
+
- **Update test-documentation.md:** Add new test cases to the appropriate table section
|
|
106
|
+
- **Status Tracking:** Update test status as development progresses
|
|
107
|
+
- **Table Format:** Maintain consistent table formatting and column alignment
|
|
108
|
+
- **ID Assignment:** Assign sequential IDs within each area (AREA-TYPE-001, AREA-TYPE-002, etc.)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "react",
|
|
3
|
+
"description": "React frontend development template with modern patterns and best practices",
|
|
4
|
+
"prompts": [],
|
|
5
|
+
"vscodeSettings": {
|
|
6
|
+
"github.copilot.chat.codeGeneration.useInstructionFiles": true,
|
|
7
|
+
"chat.promptFiles": true,
|
|
8
|
+
"editor.formatOnSave": true,
|
|
9
|
+
"editor.codeActionsOnSave": {
|
|
10
|
+
"source.organizeImports": true,
|
|
11
|
+
"source.fixAll.eslint": true
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
}
|