AGENT SKILL
post-edit-conventions
Monorepo coding conventions to follow when writing or editing code in this repository
- License 许可
- MIT
- 最近更新
- 2026-11-06
- Stars
- ★ 3
- Forks
- 1
01 前言 Front Matter
- name
- post-edit-conventions
- description
- Monorepo coding conventions to follow when writing or editing code in this repository
- user-invocable
- false
03 SKILL.md 正文
Coding Conventions
Always follow these conventions when writing or editing code in this monorepo:
Formatting
- Tabs for indentation (never spaces)
- Biome handles formatting — don't manually adjust style
File Extensions
- No
.jsfiles — use.mjsor.cjsfor JavaScript - TypeScript files use
.ts(ESM is default via"type": "module") - This is enforced by the
NoJsFileExtensionsrepopo policy
Imports
- No barrel re-exports — import directly from the source module, not through index files
- Use
patheinstead ofnode:pathfor cross-platform path handling - Use
fs/promises(async) instead offssync methods (readFilenotreadFileSync) - Use explicit file extensions in imports where required
Dependencies
- Internal workspace deps use
workspace:^protocol - Never add runtime dependencies to
@tylerbu/fundamentals(zero-dep package) - Use
pnpmexclusively (never npm or yarn)
TypeScript
- Use proper types — avoid
any - Prefer
satisfiesoverasfor type assertions - Don't add lint-disable comments to work around type issues
- All packages extend base tsconfig from
config/tsconfig.strict.json
Package Structure
- Output directory is
esm/(notdist/orlib/) - Source in
src/, tests intest/ - Every package needs
"type": "module"in package.json - Package.json keys must be sorted (enforced by repopo)
Testing
- Use Vitest (not Jest)
- Test files:
test/**/*.test.ts - Merge base config:
import defaultConfig from "../../config/vitest.config"
04 同仓库更多 Skills
scaffold-package
Scaffold a new package in the monorepo with correct conventions, configs, and policy compliance
★ 3
release-check
Validate release readiness - changesets, policy compliance, build, test, and dependency sync
★ 3
pr-changeset-check
Check if PR has appropriate changesets before creating
★ 3
oclif-command-guide
Reference for OCLIF command patterns, base classes, and conventions used in CLI packages
★ 3
nx-task-guide
Reference for Nx task architecture, orchestration patterns, and how to add or modify build tasks
★ 3
nx-affected
Run Nx affected commands for the current changes
★ 3