omgkit 2.18.0 → 2.19.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/README.md CHANGED
@@ -426,24 +426,34 @@ omgkit help # Show help
426
426
 
427
427
  ## ✅ Before-Commit Validation
428
428
 
429
- OMGKIT enforces strict quality standards with **4800+ automated tests**:
429
+ OMGKIT provides two types of before-commit rules:
430
+
431
+ | Rule Type | Location | Purpose |
432
+ |-----------|----------|---------|
433
+ | **OMGKIT Internal** | `plugin/stdrules/omgkit/` | For OMGKIT contributors |
434
+ | **Project Rules** | `.omgkit/stdrules/BEFORE_COMMIT.md` | For your projects |
435
+
436
+ ### For OMGKIT Contributors
430
437
 
431
438
  ```bash
432
- npm test # Run all validation tests before commit
439
+ npm test # Run all 4800+ validation tests
433
440
  ```
434
441
 
435
- ### Quality Gates
436
-
437
442
  | Category | Requirement |
438
443
  |----------|-------------|
439
444
  | **Agents** | 50+ lines, valid frontmatter, skills/commands arrays |
440
445
  | **Commands** | 15+ lines, description, registered as slash command |
441
446
  | **Skills** | 30+ lines, name/description if frontmatter present |
442
447
  | **Workflows** | 50+ lines, description, agents array |
443
- | **Registry** | Version sync, cross-reference validation |
444
- | **Content** | No placeholder text (TODO:, FIXME:, etc.) |
445
448
 
446
- All commands must be registered in `registry.yaml` under valid namespaces.
449
+ ### For Project Developers
450
+
451
+ When you run `omgkit init`, a comprehensive `BEFORE_COMMIT.md` is created with:
452
+ - Code quality checks
453
+ - Git commit standards
454
+ - Security guidelines
455
+ - Documentation requirements
456
+
447
457
  See [full documentation](https://omgkit.mintlify.app/resources/before-commit).
448
458
 
449
459
  ## 📁 Project Structure
@@ -463,6 +473,7 @@ your-project/
463
473
  │ ├── logs/ # Activity logs
464
474
  │ ├── devlogs/ # Development logs, planning, tracking (git-ignored)
465
475
  │ └── stdrules/ # Standards & rules for the project
476
+ │ ├── BEFORE_COMMIT.md # Before-commit checklist
466
477
  │ └── SKILL_STANDARDS.md
467
478
  └── OMEGA.md # Project context
468
479
  ```
package/lib/cli.js CHANGED
@@ -395,7 +395,8 @@ export function initProject(options = {}) {
395
395
  { src: 'settings.json', dest: '.omgkit/settings.json' },
396
396
  { src: 'devlogs/README.md', dest: '.omgkit/devlogs/README.md' },
397
397
  { src: 'stdrules/README.md', dest: '.omgkit/stdrules/README.md' },
398
- { src: 'stdrules/SKILL_STANDARDS.md', dest: '.omgkit/stdrules/SKILL_STANDARDS.md' }
398
+ { src: 'stdrules/SKILL_STANDARDS.md', dest: '.omgkit/stdrules/SKILL_STANDARDS.md' },
399
+ { src: 'stdrules/BEFORE_COMMIT.md', dest: '.omgkit/stdrules/BEFORE_COMMIT.md' }
399
400
  ];
400
401
 
401
402
  templates.forEach(({ src, dest }) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "omgkit",
3
- "version": "2.18.0",
3
+ "version": "2.19.0",
4
4
  "description": "Omega-Level Development Kit - AI Team System for Claude Code. 33 agents, 111 commands, 127 skills, 49 workflows.",
5
5
  "keywords": [
6
6
  "claude-code",
@@ -1,15 +1,15 @@
1
1
  # OMGKIT Component Registry
2
2
  # Single Source of Truth for Agents, Skills, Commands, Workflows, and MCPs
3
- # Version: 2.18.0
3
+ # Version: 2.19.0
4
4
  # Updated: 2026-01-02
5
5
 
6
- version: "2.17.0"
6
+ version: "2.19.0"
7
7
 
8
8
  # =============================================================================
9
9
  # OPTIMIZED ALIGNMENT PRINCIPLE (OAP)
10
10
  # =============================================================================
11
11
  # Core architectural rule defining component relationships.
12
- # See: plugin/stdrules/ALIGNMENT_PRINCIPLE.md for full documentation.
12
+ # See: plugin/stdrules/omgkit/ALIGNMENT_PRINCIPLE.md for full documentation.
13
13
  #
14
14
  # Hierarchy (lower levels are used by higher levels):
15
15
  # Level 0: MCPs → Foundation layer
@@ -29,7 +29,7 @@ version: "2.17.0"
29
29
  alignment_principle:
30
30
  version: "1.0.0"
31
31
  enforced: true
32
- documentation: "plugin/stdrules/ALIGNMENT_PRINCIPLE.md"
32
+ documentation: "plugin/stdrules/omgkit/ALIGNMENT_PRINCIPLE.md"
33
33
  hierarchy:
34
34
  - level: 0
35
35
  type: mcp
@@ -0,0 +1,232 @@
1
+ # Before-Commit Checklist
2
+
3
+ This checklist defines validation rules and quality standards that must be met before committing changes to this project.
4
+
5
+ ## Quick Check
6
+
7
+ Run before every commit:
8
+
9
+ ```bash
10
+ # Run tests
11
+ npm test
12
+
13
+ # Check for linting errors
14
+ npm run lint
15
+
16
+ # Build the project
17
+ npm run build
18
+ ```
19
+
20
+ ---
21
+
22
+ ## 1. Code Quality
23
+
24
+ ### 1.1 Tests
25
+ - [ ] All existing tests pass
26
+ - [ ] New code has appropriate tests
27
+ - [ ] Test coverage meets project threshold
28
+ - [ ] No skipped tests without documented reason
29
+
30
+ ### 1.2 Linting & Formatting
31
+ - [ ] No linting errors (`npm run lint`)
32
+ - [ ] Code follows project style guide
33
+ - [ ] Consistent formatting applied
34
+ - [ ] No unused imports or variables
35
+
36
+ ### 1.3 Type Safety (if applicable)
37
+ - [ ] No TypeScript errors (`tsc --noEmit`)
38
+ - [ ] Proper types for function parameters and returns
39
+ - [ ] No `any` types without justification
40
+ - [ ] Interface definitions for complex objects
41
+
42
+ ### 1.4 Build
43
+ - [ ] Project builds successfully (`npm run build`)
44
+ - [ ] No build warnings (or documented exceptions)
45
+ - [ ] Bundle size within acceptable limits
46
+
47
+ ---
48
+
49
+ ## 2. Git Standards
50
+
51
+ ### 2.1 Conventional Commits
52
+ Use the format: `type(scope): description`
53
+
54
+ | Type | Description |
55
+ |------|-------------|
56
+ | `feat` | New feature |
57
+ | `fix` | Bug fix |
58
+ | `docs` | Documentation only |
59
+ | `style` | Formatting, no code change |
60
+ | `refactor` | Code restructuring |
61
+ | `perf` | Performance improvement |
62
+ | `test` | Adding tests |
63
+ | `chore` | Maintenance tasks |
64
+ | `ci` | CI/CD changes |
65
+ | `revert` | Revert previous commit |
66
+
67
+ **Examples:**
68
+ ```
69
+ feat(auth): add social login support
70
+ fix(api): handle null response from server
71
+ docs(readme): update installation instructions
72
+ refactor(utils): simplify date formatting logic
73
+ ```
74
+
75
+ ### 2.2 Commit Message Guidelines
76
+ - [ ] First line under 72 characters
77
+ - [ ] Use imperative mood ("add" not "added")
78
+ - [ ] Reference issues when applicable (`#123`)
79
+ - [ ] Separate subject from body with blank line
80
+ - [ ] Explain "what" and "why" (not "how")
81
+
82
+ ### 2.3 Branch Hygiene
83
+ - [ ] Working on correct branch
84
+ - [ ] Branch is up-to-date with main/master
85
+ - [ ] No merge conflicts
86
+ - [ ] Feature branch naming: `feature/description`
87
+ - [ ] Fix branch naming: `fix/description`
88
+
89
+ ---
90
+
91
+ ## 3. Security
92
+
93
+ ### 3.1 Credentials & Secrets
94
+ - [ ] No API keys in code
95
+ - [ ] No passwords in code
96
+ - [ ] No tokens in code
97
+ - [ ] `.env` files not committed
98
+ - [ ] Secrets in environment variables only
99
+
100
+ ### 3.2 Dependencies
101
+ - [ ] No known vulnerabilities (`npm audit`)
102
+ - [ ] Dependencies from trusted sources
103
+ - [ ] Lock file (`package-lock.json`) updated
104
+ - [ ] No unnecessary dependencies added
105
+
106
+ ### 3.3 Input Validation
107
+ - [ ] User inputs sanitized
108
+ - [ ] SQL injection prevented
109
+ - [ ] XSS vulnerabilities addressed
110
+ - [ ] CSRF protection in place (if applicable)
111
+
112
+ ---
113
+
114
+ ## 4. Documentation
115
+
116
+ ### 4.1 Code Documentation
117
+ - [ ] Complex logic has comments
118
+ - [ ] Public APIs have JSDoc/docstrings
119
+ - [ ] README updated for new features
120
+ - [ ] Breaking changes documented
121
+
122
+ ### 4.2 Changelog
123
+ - [ ] CHANGELOG.md updated for user-facing changes
124
+ - [ ] Version number updated if releasing
125
+ - [ ] Migration guide for breaking changes
126
+
127
+ ### 4.3 API Documentation
128
+ - [ ] New endpoints documented
129
+ - [ ] Request/response examples provided
130
+ - [ ] Error responses documented
131
+
132
+ ---
133
+
134
+ ## 5. Performance
135
+
136
+ ### 5.1 Code Efficiency
137
+ - [ ] No obvious performance regressions
138
+ - [ ] Database queries optimized
139
+ - [ ] No N+1 query problems
140
+ - [ ] Appropriate caching in place
141
+
142
+ ### 5.2 Assets
143
+ - [ ] Images optimized
144
+ - [ ] Large files not committed (use LFS if needed)
145
+ - [ ] Bundle size checked
146
+ - [ ] Lazy loading where appropriate
147
+
148
+ ---
149
+
150
+ ## 6. Review Checklist
151
+
152
+ ### 6.1 Self-Review
153
+ - [ ] Code reviewed by yourself
154
+ - [ ] Changes match requirements
155
+ - [ ] Edge cases handled
156
+ - [ ] Error handling in place
157
+ - [ ] Logging appropriate (not excessive)
158
+
159
+ ### 6.2 Code Smell Check
160
+ - [ ] No duplicate code
161
+ - [ ] Functions are single-purpose
162
+ - [ ] Naming is clear and consistent
163
+ - [ ] No magic numbers/strings
164
+ - [ ] Appropriate abstraction level
165
+
166
+ ### 6.3 Testing Mindset
167
+ - [ ] "What could go wrong?" considered
168
+ - [ ] Boundary conditions tested
169
+ - [ ] Error paths tested
170
+ - [ ] Happy path works
171
+
172
+ ---
173
+
174
+ ## 7. Environment-Specific
175
+
176
+ ### 7.1 Development
177
+ - [ ] Works in development environment
178
+ - [ ] Dev dependencies separate from prod
179
+
180
+ ### 7.2 Production Readiness
181
+ - [ ] Feature flags for incomplete features
182
+ - [ ] Backwards compatibility maintained
183
+ - [ ] Rollback plan exists
184
+ - [ ] Monitoring in place for new features
185
+
186
+ ---
187
+
188
+ ## Quick Reference Commands
189
+
190
+ ```bash
191
+ # Run all checks
192
+ npm test && npm run lint && npm run build
193
+
194
+ # Check for security issues
195
+ npm audit
196
+
197
+ # Format code
198
+ npm run format
199
+
200
+ # Type check (TypeScript)
201
+ npx tsc --noEmit
202
+
203
+ # Git status
204
+ git status
205
+
206
+ # Stage changes
207
+ git add -A
208
+
209
+ # Commit with conventional format
210
+ git commit -m "type(scope): description"
211
+ ```
212
+
213
+ ---
214
+
215
+ ## AI-Assisted Development
216
+
217
+ When using OMGKIT AI agents:
218
+
219
+ 1. **Review AI-generated code** before committing
220
+ 2. **Run tests** after AI modifications
221
+ 3. **Check for sensitive data** in AI outputs
222
+ 4. **Validate logic** - AI can make mistakes
223
+
224
+ ---
225
+
226
+ ## Customization
227
+
228
+ Add project-specific rules below this line:
229
+
230
+ ---
231
+
232
+ <!-- PROJECT-SPECIFIC RULES -->