Coding Standards
Enforces consistent naming conventions, code organization, and documentation across the codebase.
When to use this skill
- Writing new code
- Reviewing pull requests
- Refactoring existing code
- Onboarding to a new codebase
Skill Contents
Sections
Available Resources
📚 references/ - Detailed documentation
🔧 scripts/ - Automation scripts
📦 assets/ - Templates and resources
Quick Start
Run naming convention checks:
# Via skills CLI
node .scripts/skills-cli.ts coding-standards validate
# Programmatically
import { codingStandards } from './.scripts/lib/skills/index.ts';
const result = await codingStandards.validate('./src');Naming Conventions
| Language | Convention | Example |
|---|---|---|
| Java | PascalCase for classes | UserService.java |
| Python | snake_case for modules | user_service.py |
| TypeScript/JS | kebab-case or camelCase | user-service.ts |
| Shell | kebab-case | run-tests.sh |
For complete rules, see references/naming-conventions.md.
Available Scripts
Scripts are implemented in .scripts/lib/skills/coding-standards.ts:
| Function | Description |
|---|---|
validate(dir) | Run all naming convention checks |
checkNamingConventions(dir) | Check file naming |
checkJavaClass(path) | Validate Java class name |
checkPythonModule(path) | Validate Python module name |
checkTypeScriptFile(path) | Validate TS/JS file name |
References
| Reference | Description |
|---|---|
| references/naming-conventions.md | Naming rules by language |
| references/code-organization.md | Project structure patterns |
| references/documentation-standards.md | Documentation requirements |
Assets
| Asset | Description |
|---|---|
| assets/templates/file-header-template.txt | Standard file header |
Related Skills
quality-checks- Orchestrates coding standards with other quality checksdoc-sync- Documentation synchronization