@hivehub/rulebook 4.2.2 → 4.3.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.
Files changed (334) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +8 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +4 -4
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +8 -1
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +32 -1
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/generator.d.ts +13 -0
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +283 -28
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  31. package/dist/core/workspace/workspace-manager.js +2 -6
  32. package/dist/core/workspace/workspace-manager.js.map +1 -1
  33. package/dist/index.js +1 -3
  34. package/dist/index.js.map +1 -1
  35. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  36. package/dist/mcp/rulebook-server.js +5 -4
  37. package/dist/mcp/rulebook-server.js.map +1 -1
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -0
  40. package/templates/agents/api-designer.md +42 -0
  41. package/templates/agents/architect.md +51 -0
  42. package/templates/agents/build-engineer.md +36 -0
  43. package/templates/agents/code-reviewer.md +47 -0
  44. package/templates/agents/database-architect.md +41 -0
  45. package/templates/agents/devops-engineer.md +42 -0
  46. package/templates/agents/docs-writer.md +38 -0
  47. package/templates/agents/i18n-engineer.md +42 -0
  48. package/templates/agents/implementer.md +38 -35
  49. package/templates/agents/migration-engineer.md +42 -0
  50. package/templates/agents/performance-engineer.md +49 -0
  51. package/templates/agents/refactoring-agent.md +41 -0
  52. package/templates/agents/researcher.md +38 -34
  53. package/templates/agents/security-reviewer.md +40 -0
  54. package/templates/agents/team-lead.md +37 -34
  55. package/templates/agents/tester.md +45 -42
  56. package/templates/agents/ux-reviewer.md +43 -0
  57. package/templates/ci/rulebook-review.yml +26 -26
  58. package/templates/cli/AIDER.md +49 -49
  59. package/templates/cli/AMAZON_Q.md +25 -25
  60. package/templates/cli/AUGGIE.md +32 -32
  61. package/templates/cli/CLAUDE.md +117 -117
  62. package/templates/cli/CLINE.md +99 -99
  63. package/templates/cli/CODEBUDDY.md +20 -20
  64. package/templates/cli/CODEIUM.md +20 -20
  65. package/templates/cli/CODEX.md +21 -21
  66. package/templates/cli/CONTINUE.md +34 -34
  67. package/templates/cli/CURSOR_CLI.md +62 -62
  68. package/templates/cli/FACTORY.md +18 -18
  69. package/templates/cli/GEMINI.md +35 -35
  70. package/templates/cli/KILOCODE.md +18 -18
  71. package/templates/cli/OPENCODE.md +18 -18
  72. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  73. package/templates/commands/rulebook-memory-save.md +48 -48
  74. package/templates/commands/rulebook-memory-search.md +47 -47
  75. package/templates/commands/rulebook-task-apply.md +67 -67
  76. package/templates/commands/rulebook-task-archive.md +94 -94
  77. package/templates/commands/rulebook-task-create.md +93 -93
  78. package/templates/commands/rulebook-task-list.md +42 -42
  79. package/templates/commands/rulebook-task-show.md +52 -52
  80. package/templates/commands/rulebook-task-validate.md +53 -53
  81. package/templates/core/AGENTS_LEAN.md +25 -25
  82. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  83. package/templates/core/AGENT_AUTOMATION.md +288 -288
  84. package/templates/core/DAG.md +304 -304
  85. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  86. package/templates/core/MULTI_AGENT.md +74 -74
  87. package/templates/core/PLANS.md +28 -28
  88. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  89. package/templates/core/RALPH.md +471 -471
  90. package/templates/core/RULEBOOK.md +1935 -1935
  91. package/templates/frameworks/ANGULAR.md +36 -36
  92. package/templates/frameworks/DJANGO.md +83 -83
  93. package/templates/frameworks/ELECTRON.md +147 -147
  94. package/templates/frameworks/FLASK.md +38 -38
  95. package/templates/frameworks/FLUTTER.md +55 -55
  96. package/templates/frameworks/JQUERY.md +32 -32
  97. package/templates/frameworks/LARAVEL.md +38 -38
  98. package/templates/frameworks/NESTJS.md +43 -43
  99. package/templates/frameworks/NEXTJS.md +127 -127
  100. package/templates/frameworks/NUXT.md +40 -40
  101. package/templates/frameworks/RAILS.md +66 -66
  102. package/templates/frameworks/REACT.md +38 -38
  103. package/templates/frameworks/REACT_NATIVE.md +47 -47
  104. package/templates/frameworks/SPRING.md +39 -39
  105. package/templates/frameworks/SYMFONY.md +36 -36
  106. package/templates/frameworks/VUE.md +36 -36
  107. package/templates/frameworks/ZEND.md +35 -35
  108. package/templates/git/CI_CD_PATTERNS.md +661 -661
  109. package/templates/git/GITHUB_ACTIONS.md +728 -728
  110. package/templates/git/GITLAB_CI.md +730 -730
  111. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  112. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  113. package/templates/hooks/COMMIT_MSG.md +530 -530
  114. package/templates/hooks/POST_CHECKOUT.md +546 -546
  115. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  116. package/templates/hooks/PRE_COMMIT.md +414 -414
  117. package/templates/hooks/PRE_PUSH.md +601 -601
  118. package/templates/ides/CONTINUE_RULES.md +16 -16
  119. package/templates/ides/COPILOT.md +37 -37
  120. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  121. package/templates/ides/CURSOR.md +43 -43
  122. package/templates/ides/GEMINI_RULES.md +17 -17
  123. package/templates/ides/JETBRAINS_AI.md +35 -35
  124. package/templates/ides/REPLIT.md +36 -36
  125. package/templates/ides/TABNINE.md +29 -29
  126. package/templates/ides/VSCODE.md +40 -40
  127. package/templates/ides/WINDSURF.md +36 -36
  128. package/templates/ides/WINDSURF_RULES.md +14 -14
  129. package/templates/ides/ZED.md +32 -32
  130. package/templates/ides/cursor-mdc/go.mdc +24 -24
  131. package/templates/ides/cursor-mdc/python.mdc +24 -24
  132. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  133. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  134. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  135. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  136. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  137. package/templates/languages/C.md +333 -333
  138. package/templates/languages/CPP.md +743 -743
  139. package/templates/languages/CSHARP.md +417 -417
  140. package/templates/languages/ELIXIR.md +454 -454
  141. package/templates/languages/ERLANG.md +361 -361
  142. package/templates/languages/GO.md +645 -645
  143. package/templates/languages/HASKELL.md +177 -177
  144. package/templates/languages/JAVA.md +607 -607
  145. package/templates/languages/JAVASCRIPT.md +631 -631
  146. package/templates/languages/JULIA.md +97 -97
  147. package/templates/languages/KOTLIN.md +511 -511
  148. package/templates/languages/LISP.md +100 -100
  149. package/templates/languages/LUA.md +74 -74
  150. package/templates/languages/OBJECTIVEC.md +90 -90
  151. package/templates/languages/PHP.md +416 -416
  152. package/templates/languages/PYTHON.md +682 -682
  153. package/templates/languages/RUBY.md +421 -421
  154. package/templates/languages/RUST.md +477 -477
  155. package/templates/languages/SAS.md +73 -73
  156. package/templates/languages/SCALA.md +348 -348
  157. package/templates/languages/SOLIDITY.md +580 -580
  158. package/templates/languages/SQL.md +137 -137
  159. package/templates/languages/SWIFT.md +466 -466
  160. package/templates/languages/TYPESCRIPT.md +591 -591
  161. package/templates/languages/ZIG.md +265 -265
  162. package/templates/modules/ATLASSIAN.md +255 -255
  163. package/templates/modules/CONTEXT7.md +54 -54
  164. package/templates/modules/FIGMA.md +267 -267
  165. package/templates/modules/GITHUB_MCP.md +64 -64
  166. package/templates/modules/GRAFANA.md +328 -328
  167. package/templates/modules/MEMORY.md +126 -126
  168. package/templates/modules/NOTION.md +247 -247
  169. package/templates/modules/PLAYWRIGHT.md +90 -90
  170. package/templates/modules/RULEBOOK_MCP.md +156 -156
  171. package/templates/modules/SERENA.md +337 -337
  172. package/templates/modules/SUPABASE.md +223 -223
  173. package/templates/modules/SYNAP.md +69 -69
  174. package/templates/modules/VECTORIZER.md +63 -63
  175. package/templates/modules/sequential-thinking.md +42 -42
  176. package/templates/ralph/ralph-history.bat +4 -4
  177. package/templates/ralph/ralph-history.sh +5 -5
  178. package/templates/ralph/ralph-init.bat +5 -5
  179. package/templates/ralph/ralph-init.sh +5 -5
  180. package/templates/ralph/ralph-pause.bat +5 -5
  181. package/templates/ralph/ralph-pause.sh +5 -5
  182. package/templates/ralph/ralph-run.bat +5 -5
  183. package/templates/ralph/ralph-run.sh +5 -5
  184. package/templates/ralph/ralph-status.bat +4 -4
  185. package/templates/ralph/ralph-status.sh +5 -5
  186. package/templates/services/AZURE_BLOB.md +184 -184
  187. package/templates/services/CASSANDRA.md +239 -239
  188. package/templates/services/DATADOG.md +26 -26
  189. package/templates/services/DOCKER.md +124 -124
  190. package/templates/services/DOCKER_COMPOSE.md +168 -168
  191. package/templates/services/DYNAMODB.md +308 -308
  192. package/templates/services/ELASTICSEARCH.md +347 -347
  193. package/templates/services/GCS.md +178 -178
  194. package/templates/services/HELM.md +194 -194
  195. package/templates/services/INFLUXDB.md +265 -265
  196. package/templates/services/KAFKA.md +341 -341
  197. package/templates/services/KUBERNETES.md +208 -208
  198. package/templates/services/MARIADB.md +183 -183
  199. package/templates/services/MEMCACHED.md +242 -242
  200. package/templates/services/MINIO.md +201 -201
  201. package/templates/services/MONGODB.md +268 -268
  202. package/templates/services/MYSQL.md +358 -358
  203. package/templates/services/NEO4J.md +247 -247
  204. package/templates/services/OPENTELEMETRY.md +25 -25
  205. package/templates/services/ORACLE.md +290 -290
  206. package/templates/services/PINO.md +24 -24
  207. package/templates/services/POSTGRESQL.md +326 -326
  208. package/templates/services/PROMETHEUS.md +33 -33
  209. package/templates/services/RABBITMQ.md +286 -286
  210. package/templates/services/REDIS.md +292 -292
  211. package/templates/services/S3.md +298 -298
  212. package/templates/services/SENTRY.md +23 -23
  213. package/templates/services/SQLITE.md +294 -294
  214. package/templates/services/SQLSERVER.md +294 -294
  215. package/templates/services/WINSTON.md +30 -30
  216. package/templates/skills/cli/aider/SKILL.md +59 -59
  217. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  218. package/templates/skills/cli/auggie/SKILL.md +42 -42
  219. package/templates/skills/cli/claude/SKILL.md +42 -42
  220. package/templates/skills/cli/cline/SKILL.md +42 -42
  221. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  222. package/templates/skills/cli/codeium/SKILL.md +30 -30
  223. package/templates/skills/cli/codex/SKILL.md +31 -31
  224. package/templates/skills/cli/continue/SKILL.md +44 -44
  225. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  226. package/templates/skills/cli/factory/SKILL.md +28 -28
  227. package/templates/skills/cli/gemini/SKILL.md +45 -45
  228. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  229. package/templates/skills/cli/opencode/SKILL.md +28 -28
  230. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  231. package/templates/skills/core/dag/SKILL.md +314 -314
  232. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  233. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  234. package/templates/skills/core/rulebook/SKILL.md +176 -176
  235. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  236. package/templates/skills/dev/api-design/SKILL.md +15 -0
  237. package/templates/skills/dev/architect/SKILL.md +17 -0
  238. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  239. package/templates/skills/dev/db-design/SKILL.md +15 -0
  240. package/templates/skills/dev/debug/SKILL.md +16 -0
  241. package/templates/skills/dev/deploy/SKILL.md +17 -0
  242. package/templates/skills/dev/docs/SKILL.md +17 -0
  243. package/templates/skills/dev/migrate/SKILL.md +15 -0
  244. package/templates/skills/dev/perf/SKILL.md +17 -0
  245. package/templates/skills/dev/refactor/SKILL.md +17 -0
  246. package/templates/skills/dev/research/SKILL.md +14 -0
  247. package/templates/skills/dev/review/SKILL.md +18 -0
  248. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  249. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  250. package/templates/skills/frameworks/django/SKILL.md +93 -93
  251. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  252. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  253. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  254. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  255. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  256. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  257. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  258. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  259. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  260. package/templates/skills/frameworks/react/SKILL.md +48 -48
  261. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  262. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  263. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  264. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  265. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  266. package/templates/skills/ides/copilot/SKILL.md +47 -47
  267. package/templates/skills/ides/cursor/SKILL.md +53 -53
  268. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  269. package/templates/skills/ides/replit/SKILL.md +46 -46
  270. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  271. package/templates/skills/ides/vscode/SKILL.md +50 -50
  272. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  273. package/templates/skills/ides/zed/SKILL.md +42 -42
  274. package/templates/skills/languages/c/SKILL.md +343 -343
  275. package/templates/skills/languages/cpp/SKILL.md +753 -753
  276. package/templates/skills/languages/csharp/SKILL.md +427 -427
  277. package/templates/skills/languages/elixir/SKILL.md +464 -464
  278. package/templates/skills/languages/erlang/SKILL.md +371 -371
  279. package/templates/skills/languages/go/SKILL.md +655 -655
  280. package/templates/skills/languages/haskell/SKILL.md +187 -187
  281. package/templates/skills/languages/java/SKILL.md +617 -617
  282. package/templates/skills/languages/javascript/SKILL.md +641 -641
  283. package/templates/skills/languages/julia/SKILL.md +107 -107
  284. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  285. package/templates/skills/languages/lisp/SKILL.md +110 -110
  286. package/templates/skills/languages/lua/SKILL.md +84 -84
  287. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  288. package/templates/skills/languages/php/SKILL.md +426 -426
  289. package/templates/skills/languages/python/SKILL.md +692 -692
  290. package/templates/skills/languages/ruby/SKILL.md +431 -431
  291. package/templates/skills/languages/rust/SKILL.md +487 -487
  292. package/templates/skills/languages/sas/SKILL.md +83 -83
  293. package/templates/skills/languages/scala/SKILL.md +358 -358
  294. package/templates/skills/languages/solidity/SKILL.md +590 -590
  295. package/templates/skills/languages/sql/SKILL.md +147 -147
  296. package/templates/skills/languages/swift/SKILL.md +476 -476
  297. package/templates/skills/languages/typescript/SKILL.md +302 -302
  298. package/templates/skills/languages/zig/SKILL.md +275 -275
  299. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  300. package/templates/skills/modules/context7/SKILL.md +64 -64
  301. package/templates/skills/modules/figma/SKILL.md +277 -277
  302. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  303. package/templates/skills/modules/grafana/SKILL.md +338 -338
  304. package/templates/skills/modules/memory/SKILL.md +73 -73
  305. package/templates/skills/modules/notion/SKILL.md +257 -257
  306. package/templates/skills/modules/playwright/SKILL.md +100 -100
  307. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  308. package/templates/skills/modules/serena/SKILL.md +347 -347
  309. package/templates/skills/modules/supabase/SKILL.md +233 -233
  310. package/templates/skills/modules/synap/SKILL.md +79 -79
  311. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  312. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  313. package/templates/skills/services/cassandra/SKILL.md +249 -249
  314. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  315. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  316. package/templates/skills/services/gcs/SKILL.md +188 -188
  317. package/templates/skills/services/influxdb/SKILL.md +275 -275
  318. package/templates/skills/services/kafka/SKILL.md +351 -351
  319. package/templates/skills/services/mariadb/SKILL.md +193 -193
  320. package/templates/skills/services/memcached/SKILL.md +252 -252
  321. package/templates/skills/services/minio/SKILL.md +211 -211
  322. package/templates/skills/services/mongodb/SKILL.md +278 -278
  323. package/templates/skills/services/mysql/SKILL.md +368 -368
  324. package/templates/skills/services/neo4j/SKILL.md +257 -257
  325. package/templates/skills/services/oracle/SKILL.md +300 -300
  326. package/templates/skills/services/postgresql/SKILL.md +336 -336
  327. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  328. package/templates/skills/services/redis/SKILL.md +302 -302
  329. package/templates/skills/services/s3/SKILL.md +308 -308
  330. package/templates/skills/services/sqlite/SKILL.md +304 -304
  331. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  332. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  333. package/templates/skills/workflows/ralph/install.sh +87 -87
  334. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,591 +1,591 @@
1
- <!-- TYPESCRIPT:START -->
2
- # TypeScript Project Rules
3
-
4
- ## Agent Automation Commands
5
-
6
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
-
8
- ```bash
9
- # Complete quality check sequence:
10
- npm run type-check # Type checking
11
- npm run lint # Linting (0 warnings required)
12
- npm run format # Code formatting
13
- npm test # All tests (100% pass required)
14
- npm run test:coverage # Coverage check (95%+ required)
15
- npm run build # Build verification
16
-
17
- # Security audit:
18
- npm audit --production # Vulnerability scan
19
- npm outdated # Check outdated deps (informational)
20
- ```
21
-
22
- ## TypeScript Configuration
23
-
24
- **CRITICAL**: Use TypeScript 5.3+ with strict mode enabled.
25
-
26
- - **Version**: TypeScript 5.3+
27
- - **Mode**: Strict mode enabled
28
- - **Target**: ES2022 or later
29
- - **Module**: ESNext with Node16 module resolution
30
-
31
- ### tsconfig.json Requirements
32
-
33
- ```json
34
- {
35
- "compilerOptions": {
36
- "target": "ES2022",
37
- "module": "ESNext",
38
- "moduleResolution": "node",
39
- "strict": true,
40
- "esModuleInterop": true,
41
- "skipLibCheck": true,
42
- "forceConsistentCasingInFileNames": true,
43
- "resolveJsonModule": true,
44
- "declaration": true,
45
- "declarationMap": true,
46
- "sourceMap": true,
47
- "noUnusedLocals": true,
48
- "noUnusedParameters": true,
49
- "noImplicitReturns": true,
50
- "noFallthroughCasesInSwitch": true
51
- }
52
- }
53
- ```
54
-
55
- ## Code Quality Standards
56
-
57
- ### Mandatory Quality Checks
58
-
59
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
60
-
61
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
62
-
63
- ```bash
64
- # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
65
-
66
- # 1. Type check (matches workflow)
67
- npm run type-check # or: tsc --noEmit
68
-
69
- # 2. Lint (MUST pass with no warnings - matches workflow)
70
- npm run lint
71
-
72
- # 3. Format check (matches workflow - use same command as CI)
73
- npx prettier --check 'src/**/*.ts' 'tests/**/*.ts'
74
-
75
- # 4. Run all tests (MUST pass 100% - matches workflow)
76
- npm test
77
-
78
- # 5. Build (MUST succeed - matches workflow)
79
- npm run build
80
-
81
- # 6. Check coverage (MUST meet threshold)
82
- npm run test:coverage
83
- ```
84
-
85
- **If ANY of these fail, you MUST fix the issues before committing.**
86
-
87
- **Why This Matters:**
88
- - Running different commands locally than in CI causes "works on my machine" failures
89
- - CI/CD workflows will fail if commands don't match
90
- - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
91
- - Example: Forgetting `npm run build` locally = CI build failures
92
-
93
- ### Linting
94
-
95
- - Use ESLint with TypeScript plugin
96
- - Configuration in `eslint.config.js` or `.eslintrc.json`
97
- - Must pass with no warnings: `eslint src/**/*.ts`
98
- - Fix automatically when possible: `eslint src/**/*.ts --fix`
99
-
100
- Example ESLint config:
101
- ```json
102
- {
103
- "extends": [
104
- "eslint:recommended",
105
- "plugin:@typescript-eslint/recommended"
106
- ],
107
- "parser": "@typescript-eslint/parser",
108
- "plugins": ["@typescript-eslint"],
109
- "rules": {
110
- "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
111
- "@typescript-eslint/explicit-function-return-type": "warn",
112
- "@typescript-eslint/no-explicit-any": "warn"
113
- }
114
- }
115
- ```
116
-
117
- ### Formatting
118
-
119
- - Use Prettier for code formatting
120
- - Configuration in `.prettierrc.json`
121
- - Integrate with ESLint for consistency
122
- - Format before committing: `prettier --write "src/**/*.ts"`
123
-
124
- Example Prettier config:
125
- ```json
126
- {
127
- "semi": true,
128
- "trailingComma": "es5",
129
- "singleQuote": true,
130
- "printWidth": 100,
131
- "tabWidth": 2
132
- }
133
- ```
134
-
135
- ### Testing
136
-
137
- - **Framework**: Vitest (recommended) or Jest
138
- - **Location**: `/tests` directory or co-located `*.test.ts` files
139
- - **Coverage**: Must meet project threshold (default 95%)
140
- - **Watch Mode**: Use `vitest` or `vitest --watch` for development
141
- - **CI Mode**: **CRITICAL** - Default `npm test` command MUST include `--run` flag
142
- - This prevents Vitest from entering watch mode, which never terminates
143
- - In `package.json`: `"test": "vitest --run"`
144
- - In CI workflows: use `npm test` (do NOT add `--run` argument)
145
- - For manual development, use `npm run test:watch`
146
-
147
- Example test structure:
148
- ```typescript
149
- import { describe, it, expect, beforeEach, afterEach } from 'vitest';
150
- import { myFunction } from './my-module';
151
-
152
- describe('myFunction', () => {
153
- beforeEach(() => {
154
- // Setup
155
- });
156
-
157
- afterEach(() => {
158
- // Cleanup
159
- });
160
-
161
- it('should handle valid input', () => {
162
- const result = myFunction('input');
163
- expect(result).toBe('expected');
164
- });
165
-
166
- it('should throw on invalid input', () => {
167
- expect(() => myFunction('')).toThrow('Invalid input');
168
- });
169
- });
170
- ```
171
-
172
- ### Test Categories: S2S and Slow Tests
173
-
174
- **CRITICAL**: Tests must be categorized based on execution time and dependencies.
175
-
176
- #### Test Time Limits
177
-
178
- - **Fast Tests**: Must complete in ≤ 10-20 seconds
179
- - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
180
- - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
181
-
182
- #### S2S (Server-to-Server) Tests
183
-
184
- **Tests that require active servers, databases, or external services must be isolated using test tags.**
185
-
186
- **Implementation**:
187
-
188
- 1. **Use Vitest test tags**:
189
- ```typescript
190
- import { describe, it, expect } from 'vitest';
191
-
192
- // Regular fast test (always runs)
193
- describe('local computation', () => {
194
- it('should compute correctly', () => {
195
- // Fast test, no external dependencies
196
- });
197
- });
198
-
199
- // S2S test (only runs with --grep s2s)
200
- describe('database integration', () => {
201
- it.skipIf(!process.env.RUN_S2S_TESTS)('should connect to database', async () => {
202
- // Requires active database server
203
- const db = await connectToDatabase();
204
- // ... test implementation
205
- });
206
- });
207
-
208
- // Alternative: Use Vitest tags
209
- describe('API integration', () => {
210
- it.tags('s2s')('should call external API', async () => {
211
- // Requires active API server
212
- const client = createApiClient();
213
- // ... test implementation
214
- });
215
- });
216
- ```
217
-
218
- 2. **Configure `vitest.config.ts`**:
219
- ```typescript
220
- import { defineConfig } from 'vitest/config';
221
-
222
- export default defineConfig({
223
- test: {
224
- // Exclude S2S tests by default
225
- exclude: ['**/node_modules/**', '**/dist/**', '**/*.s2s.test.ts'],
226
- // Include S2S tests when explicitly requested
227
- include: process.env.RUN_S2S_TESTS
228
- ? ['**/*.{test,spec}.ts', '**/*.s2s.test.ts']
229
- : ['**/*.{test,spec}.ts'],
230
- },
231
- });
232
- ```
233
-
234
- 3. **Run tests**:
235
- ```bash
236
- # Regular tests (excludes S2S)
237
- npm test
238
-
239
- # Include S2S tests (requires active servers)
240
- RUN_S2S_TESTS=1 npm test
241
-
242
- # Run only S2S tests
243
- npm test -- --grep s2s
244
- ```
245
-
246
- #### Slow Tests
247
-
248
- **Tests that take > 10-20 seconds must be marked and run separately.**
249
-
250
- **Implementation**:
251
-
252
- 1. **Mark slow tests with tags or separate files**:
253
- ```typescript
254
- import { describe, it, expect } from 'vitest';
255
-
256
- // Fast test (always runs)
257
- describe('quick operations', () => {
258
- it('should complete quickly', () => {
259
- // Completes in < 1 second
260
- });
261
- });
262
-
263
- // Slow test (only runs with --grep slow)
264
- describe('heavy computation', () => {
265
- it.tags('slow')('should process large dataset', async () => {
266
- // Takes 30+ seconds
267
- // Heavy processing, large dataset, etc.
268
- });
269
- });
270
-
271
- // Or use separate file: `large-file.test.slow.ts`
272
- describe('large file processing', () => {
273
- it('should process large files', async () => {
274
- // Processes large files, takes > 20 seconds
275
- });
276
- });
277
- ```
278
-
279
- 2. **Configure `vitest.config.ts`**:
280
- ```typescript
281
- export default defineConfig({
282
- test: {
283
- // Exclude slow tests by default
284
- exclude: ['**/node_modules/**', '**/dist/**', '**/*.slow.test.ts'],
285
- // Include slow tests when explicitly requested
286
- include: process.env.RUN_SLOW_TESTS
287
- ? ['**/*.{test,spec}.ts', '**/*.slow.test.ts']
288
- : ['**/*.{test,spec}.ts'],
289
- // Set timeout for slow tests
290
- testTimeout: process.env.RUN_SLOW_TESTS ? 60000 : 20000,
291
- },
292
- });
293
- ```
294
-
295
- 3. **Run tests**:
296
- ```bash
297
- # Regular tests (excludes slow)
298
- npm test
299
-
300
- # Include slow tests
301
- RUN_SLOW_TESTS=1 npm test
302
-
303
- # Run only slow tests
304
- npm test -- --grep slow
305
- ```
306
-
307
- 4. **Add npm scripts in `package.json`**:
308
- ```json
309
- {
310
- "scripts": {
311
- "test": "vitest --run",
312
- "test:watch": "vitest",
313
- "test:s2s": "RUN_S2S_TESTS=1 vitest --run",
314
- "test:slow": "RUN_SLOW_TESTS=1 vitest --run",
315
- "test:all": "RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 vitest --run"
316
- }
317
- }
318
- ```
319
-
320
- #### Best Practices
321
-
322
- - ✅ **Always run fast tests** in CI/CD by default
323
- - ✅ **Isolate S2S tests** - never run them in standard test suite
324
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
325
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
326
- - ✅ **Use timeouts** - Set appropriate timeouts: `it('test', async () => { ... }, { timeout: 30000 })`
327
- - ✅ **Use test tags** - Vitest tags (`it.tags('s2s')`) or Jest tags (`it.tags(['s2s'])`)
328
- - ❌ **Never mix** fast and slow/S2S tests in same test run
329
- - ❌ **Never require** external services for standard test suite
330
- - ❌ **Never exceed** 10-20 seconds for regular tests
331
-
332
- ## Package Management
333
-
334
- **CRITICAL**: Use consistent package manager across team.
335
-
336
- - **Default**: npm (most compatible, built-in)
337
- - **Alternative**: pnpm (fast, disk-efficient) or yarn
338
- - **Lockfile**: Always commit lockfile (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`)
339
- - **Workspaces**: Use for monorepos
340
- - **CI/CD**: Update GitHub Actions workflows to match your package manager (see workflow comments)
341
-
342
- ### Dependencies
343
-
344
- 1. **Check for latest versions**:
345
- - Use Context7 MCP tool if available
346
- - Check npm registry: `npm view <package> versions`
347
- - Review changelog for breaking changes
348
-
349
- 2. **Dependency Guidelines**:
350
- - ✅ Use exact versions for applications (`"1.2.3"`)
351
- - ✅ Use semver for libraries (`"^1.2.3"`)
352
- - ✅ Keep dependencies updated regularly
353
- - ✅ Use `npm audit` or `pnpm audit` for security
354
- - ❌ Don't use deprecated packages
355
- - ❌ Don't add unnecessary dependencies
356
-
357
- 3. **Document new dependencies**:
358
- - Update CHANGELOG.md
359
- - Document why dependency was added
360
- - Note any peer dependencies
361
-
362
- ## Type Safety
363
-
364
- - **No `any`**: Avoid `any` type - use `unknown` and type guards
365
- - **Strict null checks**: Handle null/undefined explicitly
366
- - **Type assertions**: Minimize use of `as` - prefer type guards
367
- - **Generics**: Use for reusable type-safe code
368
-
369
- Example type-safe code:
370
- ```typescript
371
- // Good: Type guard
372
- function isString(value: unknown): value is string {
373
- return typeof value === 'string';
374
- }
375
-
376
- function process(input: unknown): string {
377
- if (isString(input)) {
378
- return input.toUpperCase();
379
- }
380
- throw new Error('Invalid input');
381
- }
382
-
383
- // Bad: Type assertion
384
- function processUnsafe(input: unknown): string {
385
- return (input as string).toUpperCase(); // Runtime error if not string
386
- }
387
- ```
388
-
389
- ## Error Handling
390
-
391
- - Create custom error classes
392
- - Use type guards for error checking
393
- - Document errors in JSDoc/TSDoc
394
- - Never swallow errors silently
395
-
396
- Example:
397
- ```typescript
398
- export class ValidationError extends Error {
399
- constructor(
400
- message: string,
401
- public readonly field: string
402
- ) {
403
- super(message);
404
- this.name = 'ValidationError';
405
- }
406
- }
407
-
408
- export function validate(data: unknown): Data {
409
- if (!isValidData(data)) {
410
- throw new ValidationError('Invalid data structure', 'data');
411
- }
412
- return data;
413
- }
414
- ```
415
-
416
- ## Documentation
417
-
418
- - **JSDoc/TSDoc**: Document public APIs
419
- - **Examples**: Include usage examples
420
- - **Type exports**: Export types for library consumers
421
- - **README**: Include API documentation
422
-
423
- Example:
424
- ```typescript
425
- /**
426
- * Processes the input data and returns a formatted result.
427
- *
428
- * @param input - The input string to process
429
- * @param options - Optional processing options
430
- * @returns The processed string in uppercase
431
- * @throws {ValidationError} If input is empty
432
- *
433
- * @example
434
- * ```typescript
435
- * const result = process('hello', { trim: true });
436
- * console.log(result); // 'HELLO'
437
- * ```
438
- */
439
- export function process(
440
- input: string,
441
- options?: ProcessOptions
442
- ): string {
443
- // Implementation
444
- }
445
- ```
446
-
447
- ## Project Structure
448
-
449
- ```
450
- project/
451
- ├── package.json # Package manifest
452
- ├── tsconfig.json # TypeScript config
453
- ├── vitest.config.ts # Test config
454
- ├── README.md # Project overview (allowed in root)
455
- ├── CHANGELOG.md # Version history (allowed in root)
456
- ├── AGENTS.md # AI assistant rules (allowed in root)
457
- ├── LICENSE # Project license (allowed in root)
458
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
459
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
460
- ├── SECURITY.md # Security policy (allowed in root)
461
- ├── src/
462
- │ ├── index.ts # Main entry point
463
- │ ├── types.ts # Type definitions
464
- │ └── ...
465
- ├── tests/ # Test files
466
- ├── dist/ # Compiled output (gitignored)
467
- └── docs/ # Project documentation
468
- ```
469
-
470
- ## Module System
471
-
472
- - Use ES modules (`import`/`export`)
473
- - Set `"type": "module"` in `package.json`
474
- - Use `.js` extensions in imports for Node.js compatibility
475
- - Configure `moduleResolution: "node"` in tsconfig.json
476
-
477
- Example:
478
- ```typescript
479
- // Good: ES modules with .js extension
480
- import { myFunction } from './my-module.js';
481
-
482
- export { myFunction };
483
- export default class MyClass {}
484
- ```
485
-
486
- ## CI/CD Requirements
487
-
488
- **CRITICAL**: GitHub Actions `cache: 'npm'` requires `package-lock.json` to be committed.
489
-
490
- - **Lockfile Requirement**: Remove `package-lock.json` from `.gitignore`
491
- - **Cache Strategy**: Use `cache: 'npm'` in `setup-node` action
492
- - **Install Command**: Use `npm ci` (not `npm install`) for reproducible builds
493
- - **Error Prevention**: Without committed lockfile, you'll get:
494
- ```
495
- Error: Dependencies lock file is not found in repository
496
- Supported file patterns: package-lock.json,npm-shrinkwrap.json,yarn.lock
497
- ```
498
-
499
- Must include GitHub Actions workflows for:
500
-
501
- 1. **Testing** (`typescript-test.yml`):
502
- - Test on ubuntu-latest, windows-latest, macos-latest
503
- - Use Vitest for fast execution
504
- - Upload coverage reports
505
- - **MUST**: Commit package-lock.json for caching
506
-
507
- 2. **Linting** (`typescript-lint.yml`):
508
- - Type check: `tsc --noEmit`
509
- - ESLint: `eslint src/**/*.ts`
510
- - Prettier: `prettier --check "src/**/*.ts"`
511
- - **MUST**: Commit package-lock.json for caching
512
-
513
- 3. **Build** (`typescript-build.yml`):
514
- - Build: `npm run build`
515
- - Verify no type errors
516
- - Check output artifacts
517
- - **MUST**: Commit package-lock.json for caching
518
-
519
- ## Package Publication
520
-
521
- ### Publishing to npm
522
-
523
- **Prerequisites:**
524
- 1. Create npm account at https://www.npmjs.com
525
- 2. Generate npm token (Account Settings → Access Tokens → Generate New Token)
526
- 3. Add `NPM_TOKEN` to GitHub repository secrets
527
-
528
- **package.json Configuration:**
529
-
530
- ```json
531
- {
532
- "name": "@your-org/package-name",
533
- "version": "1.0.0",
534
- "description": "Package description",
535
- "main": "./dist/index.js",
536
- "types": "./dist/index.d.ts",
537
- "type": "module",
538
- "exports": {
539
- ".": {
540
- "types": "./dist/index.d.ts",
541
- "import": "./dist/index.js"
542
- }
543
- },
544
- "files": [
545
- "dist",
546
- "README.md",
547
- "LICENSE"
548
- ],
549
- "scripts": {
550
- "prepublishOnly": "npm run build && npm test"
551
- },
552
- "keywords": ["your", "keywords"],
553
- "author": "Your Name",
554
- "license": "MIT",
555
- "repository": {
556
- "type": "git",
557
- "url": "https://github.com/your-org/package-name"
558
- }
559
- }
560
- ```
561
-
562
- **Publishing Workflow:**
563
-
564
- 1. Update version: `npm version patch|minor|major`
565
- 2. Create release tag: `git push --tags`
566
- 3. GitHub Actions automatically publishes to npm
567
- 4. Or manual publish: `npm publish --access public`
568
-
569
- **Publishing Checklist:**
570
-
571
- - ✅ All tests passing
572
- - ✅ Code linted and formatted
573
- - ✅ Version updated in package.json
574
- - ✅ CHANGELOG.md updated
575
- - ✅ README.md up to date
576
- - ✅ Type declarations generated
577
- - ✅ Package size reasonable (`npm pack` to check)
578
- - ✅ .npmignore or package.json "files" configured
579
- - ✅ Provenance enabled for security
580
-
581
- **npm Provenance:**
582
-
583
- Enable provenance for better security and transparency:
584
- ```bash
585
- npm publish --provenance --access public
586
- ```
587
-
588
- This links your package to its source code and build process.
589
-
590
- <!-- TYPESCRIPT:END -->
591
-
1
+ <!-- TYPESCRIPT:START -->
2
+ # TypeScript Project Rules
3
+
4
+ ## Agent Automation Commands
5
+
6
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
+
8
+ ```bash
9
+ # Complete quality check sequence:
10
+ npm run type-check # Type checking
11
+ npm run lint # Linting (0 warnings required)
12
+ npm run format # Code formatting
13
+ npm test # All tests (100% pass required)
14
+ npm run test:coverage # Coverage check (95%+ required)
15
+ npm run build # Build verification
16
+
17
+ # Security audit:
18
+ npm audit --production # Vulnerability scan
19
+ npm outdated # Check outdated deps (informational)
20
+ ```
21
+
22
+ ## TypeScript Configuration
23
+
24
+ **CRITICAL**: Use TypeScript 5.3+ with strict mode enabled.
25
+
26
+ - **Version**: TypeScript 5.3+
27
+ - **Mode**: Strict mode enabled
28
+ - **Target**: ES2022 or later
29
+ - **Module**: ESNext with Node16 module resolution
30
+
31
+ ### tsconfig.json Requirements
32
+
33
+ ```json
34
+ {
35
+ "compilerOptions": {
36
+ "target": "ES2022",
37
+ "module": "ESNext",
38
+ "moduleResolution": "node",
39
+ "strict": true,
40
+ "esModuleInterop": true,
41
+ "skipLibCheck": true,
42
+ "forceConsistentCasingInFileNames": true,
43
+ "resolveJsonModule": true,
44
+ "declaration": true,
45
+ "declarationMap": true,
46
+ "sourceMap": true,
47
+ "noUnusedLocals": true,
48
+ "noUnusedParameters": true,
49
+ "noImplicitReturns": true,
50
+ "noFallthroughCasesInSwitch": true
51
+ }
52
+ }
53
+ ```
54
+
55
+ ## Code Quality Standards
56
+
57
+ ### Mandatory Quality Checks
58
+
59
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
60
+
61
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
62
+
63
+ ```bash
64
+ # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
65
+
66
+ # 1. Type check (matches workflow)
67
+ npm run type-check # or: tsc --noEmit
68
+
69
+ # 2. Lint (MUST pass with no warnings - matches workflow)
70
+ npm run lint
71
+
72
+ # 3. Format check (matches workflow - use same command as CI)
73
+ npx prettier --check 'src/**/*.ts' 'tests/**/*.ts'
74
+
75
+ # 4. Run all tests (MUST pass 100% - matches workflow)
76
+ npm test
77
+
78
+ # 5. Build (MUST succeed - matches workflow)
79
+ npm run build
80
+
81
+ # 6. Check coverage (MUST meet threshold)
82
+ npm run test:coverage
83
+ ```
84
+
85
+ **If ANY of these fail, you MUST fix the issues before committing.**
86
+
87
+ **Why This Matters:**
88
+ - Running different commands locally than in CI causes "works on my machine" failures
89
+ - CI/CD workflows will fail if commands don't match
90
+ - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
91
+ - Example: Forgetting `npm run build` locally = CI build failures
92
+
93
+ ### Linting
94
+
95
+ - Use ESLint with TypeScript plugin
96
+ - Configuration in `eslint.config.js` or `.eslintrc.json`
97
+ - Must pass with no warnings: `eslint src/**/*.ts`
98
+ - Fix automatically when possible: `eslint src/**/*.ts --fix`
99
+
100
+ Example ESLint config:
101
+ ```json
102
+ {
103
+ "extends": [
104
+ "eslint:recommended",
105
+ "plugin:@typescript-eslint/recommended"
106
+ ],
107
+ "parser": "@typescript-eslint/parser",
108
+ "plugins": ["@typescript-eslint"],
109
+ "rules": {
110
+ "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
111
+ "@typescript-eslint/explicit-function-return-type": "warn",
112
+ "@typescript-eslint/no-explicit-any": "warn"
113
+ }
114
+ }
115
+ ```
116
+
117
+ ### Formatting
118
+
119
+ - Use Prettier for code formatting
120
+ - Configuration in `.prettierrc.json`
121
+ - Integrate with ESLint for consistency
122
+ - Format before committing: `prettier --write "src/**/*.ts"`
123
+
124
+ Example Prettier config:
125
+ ```json
126
+ {
127
+ "semi": true,
128
+ "trailingComma": "es5",
129
+ "singleQuote": true,
130
+ "printWidth": 100,
131
+ "tabWidth": 2
132
+ }
133
+ ```
134
+
135
+ ### Testing
136
+
137
+ - **Framework**: Vitest (recommended) or Jest
138
+ - **Location**: `/tests` directory or co-located `*.test.ts` files
139
+ - **Coverage**: Must meet project threshold (default 95%)
140
+ - **Watch Mode**: Use `vitest` or `vitest --watch` for development
141
+ - **CI Mode**: **CRITICAL** - Default `npm test` command MUST include `--run` flag
142
+ - This prevents Vitest from entering watch mode, which never terminates
143
+ - In `package.json`: `"test": "vitest --run"`
144
+ - In CI workflows: use `npm test` (do NOT add `--run` argument)
145
+ - For manual development, use `npm run test:watch`
146
+
147
+ Example test structure:
148
+ ```typescript
149
+ import { describe, it, expect, beforeEach, afterEach } from 'vitest';
150
+ import { myFunction } from './my-module';
151
+
152
+ describe('myFunction', () => {
153
+ beforeEach(() => {
154
+ // Setup
155
+ });
156
+
157
+ afterEach(() => {
158
+ // Cleanup
159
+ });
160
+
161
+ it('should handle valid input', () => {
162
+ const result = myFunction('input');
163
+ expect(result).toBe('expected');
164
+ });
165
+
166
+ it('should throw on invalid input', () => {
167
+ expect(() => myFunction('')).toThrow('Invalid input');
168
+ });
169
+ });
170
+ ```
171
+
172
+ ### Test Categories: S2S and Slow Tests
173
+
174
+ **CRITICAL**: Tests must be categorized based on execution time and dependencies.
175
+
176
+ #### Test Time Limits
177
+
178
+ - **Fast Tests**: Must complete in ≤ 10-20 seconds
179
+ - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
180
+ - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
181
+
182
+ #### S2S (Server-to-Server) Tests
183
+
184
+ **Tests that require active servers, databases, or external services must be isolated using test tags.**
185
+
186
+ **Implementation**:
187
+
188
+ 1. **Use Vitest test tags**:
189
+ ```typescript
190
+ import { describe, it, expect } from 'vitest';
191
+
192
+ // Regular fast test (always runs)
193
+ describe('local computation', () => {
194
+ it('should compute correctly', () => {
195
+ // Fast test, no external dependencies
196
+ });
197
+ });
198
+
199
+ // S2S test (only runs with --grep s2s)
200
+ describe('database integration', () => {
201
+ it.skipIf(!process.env.RUN_S2S_TESTS)('should connect to database', async () => {
202
+ // Requires active database server
203
+ const db = await connectToDatabase();
204
+ // ... test implementation
205
+ });
206
+ });
207
+
208
+ // Alternative: Use Vitest tags
209
+ describe('API integration', () => {
210
+ it.tags('s2s')('should call external API', async () => {
211
+ // Requires active API server
212
+ const client = createApiClient();
213
+ // ... test implementation
214
+ });
215
+ });
216
+ ```
217
+
218
+ 2. **Configure `vitest.config.ts`**:
219
+ ```typescript
220
+ import { defineConfig } from 'vitest/config';
221
+
222
+ export default defineConfig({
223
+ test: {
224
+ // Exclude S2S tests by default
225
+ exclude: ['**/node_modules/**', '**/dist/**', '**/*.s2s.test.ts'],
226
+ // Include S2S tests when explicitly requested
227
+ include: process.env.RUN_S2S_TESTS
228
+ ? ['**/*.{test,spec}.ts', '**/*.s2s.test.ts']
229
+ : ['**/*.{test,spec}.ts'],
230
+ },
231
+ });
232
+ ```
233
+
234
+ 3. **Run tests**:
235
+ ```bash
236
+ # Regular tests (excludes S2S)
237
+ npm test
238
+
239
+ # Include S2S tests (requires active servers)
240
+ RUN_S2S_TESTS=1 npm test
241
+
242
+ # Run only S2S tests
243
+ npm test -- --grep s2s
244
+ ```
245
+
246
+ #### Slow Tests
247
+
248
+ **Tests that take > 10-20 seconds must be marked and run separately.**
249
+
250
+ **Implementation**:
251
+
252
+ 1. **Mark slow tests with tags or separate files**:
253
+ ```typescript
254
+ import { describe, it, expect } from 'vitest';
255
+
256
+ // Fast test (always runs)
257
+ describe('quick operations', () => {
258
+ it('should complete quickly', () => {
259
+ // Completes in < 1 second
260
+ });
261
+ });
262
+
263
+ // Slow test (only runs with --grep slow)
264
+ describe('heavy computation', () => {
265
+ it.tags('slow')('should process large dataset', async () => {
266
+ // Takes 30+ seconds
267
+ // Heavy processing, large dataset, etc.
268
+ });
269
+ });
270
+
271
+ // Or use separate file: `large-file.test.slow.ts`
272
+ describe('large file processing', () => {
273
+ it('should process large files', async () => {
274
+ // Processes large files, takes > 20 seconds
275
+ });
276
+ });
277
+ ```
278
+
279
+ 2. **Configure `vitest.config.ts`**:
280
+ ```typescript
281
+ export default defineConfig({
282
+ test: {
283
+ // Exclude slow tests by default
284
+ exclude: ['**/node_modules/**', '**/dist/**', '**/*.slow.test.ts'],
285
+ // Include slow tests when explicitly requested
286
+ include: process.env.RUN_SLOW_TESTS
287
+ ? ['**/*.{test,spec}.ts', '**/*.slow.test.ts']
288
+ : ['**/*.{test,spec}.ts'],
289
+ // Set timeout for slow tests
290
+ testTimeout: process.env.RUN_SLOW_TESTS ? 60000 : 20000,
291
+ },
292
+ });
293
+ ```
294
+
295
+ 3. **Run tests**:
296
+ ```bash
297
+ # Regular tests (excludes slow)
298
+ npm test
299
+
300
+ # Include slow tests
301
+ RUN_SLOW_TESTS=1 npm test
302
+
303
+ # Run only slow tests
304
+ npm test -- --grep slow
305
+ ```
306
+
307
+ 4. **Add npm scripts in `package.json`**:
308
+ ```json
309
+ {
310
+ "scripts": {
311
+ "test": "vitest --run",
312
+ "test:watch": "vitest",
313
+ "test:s2s": "RUN_S2S_TESTS=1 vitest --run",
314
+ "test:slow": "RUN_SLOW_TESTS=1 vitest --run",
315
+ "test:all": "RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 vitest --run"
316
+ }
317
+ }
318
+ ```
319
+
320
+ #### Best Practices
321
+
322
+ - ✅ **Always run fast tests** in CI/CD by default
323
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
324
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
325
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
326
+ - ✅ **Use timeouts** - Set appropriate timeouts: `it('test', async () => { ... }, { timeout: 30000 })`
327
+ - ✅ **Use test tags** - Vitest tags (`it.tags('s2s')`) or Jest tags (`it.tags(['s2s'])`)
328
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
329
+ - ❌ **Never require** external services for standard test suite
330
+ - ❌ **Never exceed** 10-20 seconds for regular tests
331
+
332
+ ## Package Management
333
+
334
+ **CRITICAL**: Use consistent package manager across team.
335
+
336
+ - **Default**: npm (most compatible, built-in)
337
+ - **Alternative**: pnpm (fast, disk-efficient) or yarn
338
+ - **Lockfile**: Always commit lockfile (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`)
339
+ - **Workspaces**: Use for monorepos
340
+ - **CI/CD**: Update GitHub Actions workflows to match your package manager (see workflow comments)
341
+
342
+ ### Dependencies
343
+
344
+ 1. **Check for latest versions**:
345
+ - Use Context7 MCP tool if available
346
+ - Check npm registry: `npm view <package> versions`
347
+ - Review changelog for breaking changes
348
+
349
+ 2. **Dependency Guidelines**:
350
+ - ✅ Use exact versions for applications (`"1.2.3"`)
351
+ - ✅ Use semver for libraries (`"^1.2.3"`)
352
+ - ✅ Keep dependencies updated regularly
353
+ - ✅ Use `npm audit` or `pnpm audit` for security
354
+ - ❌ Don't use deprecated packages
355
+ - ❌ Don't add unnecessary dependencies
356
+
357
+ 3. **Document new dependencies**:
358
+ - Update CHANGELOG.md
359
+ - Document why dependency was added
360
+ - Note any peer dependencies
361
+
362
+ ## Type Safety
363
+
364
+ - **No `any`**: Avoid `any` type - use `unknown` and type guards
365
+ - **Strict null checks**: Handle null/undefined explicitly
366
+ - **Type assertions**: Minimize use of `as` - prefer type guards
367
+ - **Generics**: Use for reusable type-safe code
368
+
369
+ Example type-safe code:
370
+ ```typescript
371
+ // Good: Type guard
372
+ function isString(value: unknown): value is string {
373
+ return typeof value === 'string';
374
+ }
375
+
376
+ function process(input: unknown): string {
377
+ if (isString(input)) {
378
+ return input.toUpperCase();
379
+ }
380
+ throw new Error('Invalid input');
381
+ }
382
+
383
+ // Bad: Type assertion
384
+ function processUnsafe(input: unknown): string {
385
+ return (input as string).toUpperCase(); // Runtime error if not string
386
+ }
387
+ ```
388
+
389
+ ## Error Handling
390
+
391
+ - Create custom error classes
392
+ - Use type guards for error checking
393
+ - Document errors in JSDoc/TSDoc
394
+ - Never swallow errors silently
395
+
396
+ Example:
397
+ ```typescript
398
+ export class ValidationError extends Error {
399
+ constructor(
400
+ message: string,
401
+ public readonly field: string
402
+ ) {
403
+ super(message);
404
+ this.name = 'ValidationError';
405
+ }
406
+ }
407
+
408
+ export function validate(data: unknown): Data {
409
+ if (!isValidData(data)) {
410
+ throw new ValidationError('Invalid data structure', 'data');
411
+ }
412
+ return data;
413
+ }
414
+ ```
415
+
416
+ ## Documentation
417
+
418
+ - **JSDoc/TSDoc**: Document public APIs
419
+ - **Examples**: Include usage examples
420
+ - **Type exports**: Export types for library consumers
421
+ - **README**: Include API documentation
422
+
423
+ Example:
424
+ ```typescript
425
+ /**
426
+ * Processes the input data and returns a formatted result.
427
+ *
428
+ * @param input - The input string to process
429
+ * @param options - Optional processing options
430
+ * @returns The processed string in uppercase
431
+ * @throws {ValidationError} If input is empty
432
+ *
433
+ * @example
434
+ * ```typescript
435
+ * const result = process('hello', { trim: true });
436
+ * console.log(result); // 'HELLO'
437
+ * ```
438
+ */
439
+ export function process(
440
+ input: string,
441
+ options?: ProcessOptions
442
+ ): string {
443
+ // Implementation
444
+ }
445
+ ```
446
+
447
+ ## Project Structure
448
+
449
+ ```
450
+ project/
451
+ ├── package.json # Package manifest
452
+ ├── tsconfig.json # TypeScript config
453
+ ├── vitest.config.ts # Test config
454
+ ├── README.md # Project overview (allowed in root)
455
+ ├── CHANGELOG.md # Version history (allowed in root)
456
+ ├── AGENTS.md # AI assistant rules (allowed in root)
457
+ ├── LICENSE # Project license (allowed in root)
458
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
459
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
460
+ ├── SECURITY.md # Security policy (allowed in root)
461
+ ├── src/
462
+ │ ├── index.ts # Main entry point
463
+ │ ├── types.ts # Type definitions
464
+ │ └── ...
465
+ ├── tests/ # Test files
466
+ ├── dist/ # Compiled output (gitignored)
467
+ └── docs/ # Project documentation
468
+ ```
469
+
470
+ ## Module System
471
+
472
+ - Use ES modules (`import`/`export`)
473
+ - Set `"type": "module"` in `package.json`
474
+ - Use `.js` extensions in imports for Node.js compatibility
475
+ - Configure `moduleResolution: "node"` in tsconfig.json
476
+
477
+ Example:
478
+ ```typescript
479
+ // Good: ES modules with .js extension
480
+ import { myFunction } from './my-module.js';
481
+
482
+ export { myFunction };
483
+ export default class MyClass {}
484
+ ```
485
+
486
+ ## CI/CD Requirements
487
+
488
+ **CRITICAL**: GitHub Actions `cache: 'npm'` requires `package-lock.json` to be committed.
489
+
490
+ - **Lockfile Requirement**: Remove `package-lock.json` from `.gitignore`
491
+ - **Cache Strategy**: Use `cache: 'npm'` in `setup-node` action
492
+ - **Install Command**: Use `npm ci` (not `npm install`) for reproducible builds
493
+ - **Error Prevention**: Without committed lockfile, you'll get:
494
+ ```
495
+ Error: Dependencies lock file is not found in repository
496
+ Supported file patterns: package-lock.json,npm-shrinkwrap.json,yarn.lock
497
+ ```
498
+
499
+ Must include GitHub Actions workflows for:
500
+
501
+ 1. **Testing** (`typescript-test.yml`):
502
+ - Test on ubuntu-latest, windows-latest, macos-latest
503
+ - Use Vitest for fast execution
504
+ - Upload coverage reports
505
+ - **MUST**: Commit package-lock.json for caching
506
+
507
+ 2. **Linting** (`typescript-lint.yml`):
508
+ - Type check: `tsc --noEmit`
509
+ - ESLint: `eslint src/**/*.ts`
510
+ - Prettier: `prettier --check "src/**/*.ts"`
511
+ - **MUST**: Commit package-lock.json for caching
512
+
513
+ 3. **Build** (`typescript-build.yml`):
514
+ - Build: `npm run build`
515
+ - Verify no type errors
516
+ - Check output artifacts
517
+ - **MUST**: Commit package-lock.json for caching
518
+
519
+ ## Package Publication
520
+
521
+ ### Publishing to npm
522
+
523
+ **Prerequisites:**
524
+ 1. Create npm account at https://www.npmjs.com
525
+ 2. Generate npm token (Account Settings → Access Tokens → Generate New Token)
526
+ 3. Add `NPM_TOKEN` to GitHub repository secrets
527
+
528
+ **package.json Configuration:**
529
+
530
+ ```json
531
+ {
532
+ "name": "@your-org/package-name",
533
+ "version": "1.0.0",
534
+ "description": "Package description",
535
+ "main": "./dist/index.js",
536
+ "types": "./dist/index.d.ts",
537
+ "type": "module",
538
+ "exports": {
539
+ ".": {
540
+ "types": "./dist/index.d.ts",
541
+ "import": "./dist/index.js"
542
+ }
543
+ },
544
+ "files": [
545
+ "dist",
546
+ "README.md",
547
+ "LICENSE"
548
+ ],
549
+ "scripts": {
550
+ "prepublishOnly": "npm run build && npm test"
551
+ },
552
+ "keywords": ["your", "keywords"],
553
+ "author": "Your Name",
554
+ "license": "MIT",
555
+ "repository": {
556
+ "type": "git",
557
+ "url": "https://github.com/your-org/package-name"
558
+ }
559
+ }
560
+ ```
561
+
562
+ **Publishing Workflow:**
563
+
564
+ 1. Update version: `npm version patch|minor|major`
565
+ 2. Create release tag: `git push --tags`
566
+ 3. GitHub Actions automatically publishes to npm
567
+ 4. Or manual publish: `npm publish --access public`
568
+
569
+ **Publishing Checklist:**
570
+
571
+ - ✅ All tests passing
572
+ - ✅ Code linted and formatted
573
+ - ✅ Version updated in package.json
574
+ - ✅ CHANGELOG.md updated
575
+ - ✅ README.md up to date
576
+ - ✅ Type declarations generated
577
+ - ✅ Package size reasonable (`npm pack` to check)
578
+ - ✅ .npmignore or package.json "files" configured
579
+ - ✅ Provenance enabled for security
580
+
581
+ **npm Provenance:**
582
+
583
+ Enable provenance for better security and transparency:
584
+ ```bash
585
+ npm publish --provenance --access public
586
+ ```
587
+
588
+ This links your package to its source code and build process.
589
+
590
+ <!-- TYPESCRIPT:END -->
591
+