@hivehub/rulebook 4.2.2 → 4.3.1

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 (340) 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 +15 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +43 -18
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +10 -2
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +48 -9
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/config-manager.d.ts.map +1 -1
  27. package/dist/core/config-manager.js +1 -2
  28. package/dist/core/config-manager.js.map +1 -1
  29. package/dist/core/generator.d.ts +13 -0
  30. package/dist/core/generator.d.ts.map +1 -1
  31. package/dist/core/generator.js +283 -28
  32. package/dist/core/generator.js.map +1 -1
  33. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  34. package/dist/core/indexer/background-indexer.js +10 -3
  35. package/dist/core/indexer/background-indexer.js.map +1 -1
  36. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  37. package/dist/core/workspace/workspace-manager.js +2 -6
  38. package/dist/core/workspace/workspace-manager.js.map +1 -1
  39. package/dist/index.js +1 -3
  40. package/dist/index.js.map +1 -1
  41. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  42. package/dist/mcp/rulebook-server.js +23 -10
  43. package/dist/mcp/rulebook-server.js.map +1 -1
  44. package/package.json +21 -22
  45. package/templates/agents/accessibility-reviewer.md +43 -0
  46. package/templates/agents/api-designer.md +42 -0
  47. package/templates/agents/architect.md +51 -0
  48. package/templates/agents/build-engineer.md +36 -0
  49. package/templates/agents/code-reviewer.md +47 -0
  50. package/templates/agents/database-architect.md +41 -0
  51. package/templates/agents/devops-engineer.md +42 -0
  52. package/templates/agents/docs-writer.md +38 -0
  53. package/templates/agents/i18n-engineer.md +42 -0
  54. package/templates/agents/implementer.md +38 -35
  55. package/templates/agents/migration-engineer.md +42 -0
  56. package/templates/agents/performance-engineer.md +49 -0
  57. package/templates/agents/refactoring-agent.md +41 -0
  58. package/templates/agents/researcher.md +38 -34
  59. package/templates/agents/security-reviewer.md +40 -0
  60. package/templates/agents/team-lead.md +37 -34
  61. package/templates/agents/tester.md +45 -42
  62. package/templates/agents/ux-reviewer.md +43 -0
  63. package/templates/ci/rulebook-review.yml +26 -26
  64. package/templates/cli/AIDER.md +49 -49
  65. package/templates/cli/AMAZON_Q.md +25 -25
  66. package/templates/cli/AUGGIE.md +32 -32
  67. package/templates/cli/CLAUDE.md +117 -117
  68. package/templates/cli/CLINE.md +99 -99
  69. package/templates/cli/CODEBUDDY.md +20 -20
  70. package/templates/cli/CODEIUM.md +20 -20
  71. package/templates/cli/CODEX.md +21 -21
  72. package/templates/cli/CONTINUE.md +34 -34
  73. package/templates/cli/CURSOR_CLI.md +62 -62
  74. package/templates/cli/FACTORY.md +18 -18
  75. package/templates/cli/GEMINI.md +35 -35
  76. package/templates/cli/KILOCODE.md +18 -18
  77. package/templates/cli/OPENCODE.md +18 -18
  78. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  79. package/templates/commands/rulebook-memory-save.md +48 -48
  80. package/templates/commands/rulebook-memory-search.md +47 -47
  81. package/templates/commands/rulebook-task-apply.md +67 -67
  82. package/templates/commands/rulebook-task-archive.md +94 -94
  83. package/templates/commands/rulebook-task-create.md +93 -93
  84. package/templates/commands/rulebook-task-list.md +42 -42
  85. package/templates/commands/rulebook-task-show.md +52 -52
  86. package/templates/commands/rulebook-task-validate.md +53 -53
  87. package/templates/core/AGENTS_LEAN.md +25 -25
  88. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  89. package/templates/core/AGENT_AUTOMATION.md +288 -288
  90. package/templates/core/DAG.md +304 -304
  91. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  92. package/templates/core/MULTI_AGENT.md +74 -74
  93. package/templates/core/PLANS.md +28 -28
  94. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  95. package/templates/core/RALPH.md +471 -471
  96. package/templates/core/RULEBOOK.md +1935 -1935
  97. package/templates/frameworks/ANGULAR.md +36 -36
  98. package/templates/frameworks/DJANGO.md +83 -83
  99. package/templates/frameworks/ELECTRON.md +147 -147
  100. package/templates/frameworks/FLASK.md +38 -38
  101. package/templates/frameworks/FLUTTER.md +55 -55
  102. package/templates/frameworks/JQUERY.md +32 -32
  103. package/templates/frameworks/LARAVEL.md +38 -38
  104. package/templates/frameworks/NESTJS.md +43 -43
  105. package/templates/frameworks/NEXTJS.md +127 -127
  106. package/templates/frameworks/NUXT.md +40 -40
  107. package/templates/frameworks/RAILS.md +66 -66
  108. package/templates/frameworks/REACT.md +38 -38
  109. package/templates/frameworks/REACT_NATIVE.md +47 -47
  110. package/templates/frameworks/SPRING.md +39 -39
  111. package/templates/frameworks/SYMFONY.md +36 -36
  112. package/templates/frameworks/VUE.md +36 -36
  113. package/templates/frameworks/ZEND.md +35 -35
  114. package/templates/git/CI_CD_PATTERNS.md +661 -661
  115. package/templates/git/GITHUB_ACTIONS.md +728 -728
  116. package/templates/git/GITLAB_CI.md +730 -730
  117. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  118. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  119. package/templates/hooks/COMMIT_MSG.md +530 -530
  120. package/templates/hooks/POST_CHECKOUT.md +546 -546
  121. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  122. package/templates/hooks/PRE_COMMIT.md +414 -414
  123. package/templates/hooks/PRE_PUSH.md +601 -601
  124. package/templates/ides/CONTINUE_RULES.md +16 -16
  125. package/templates/ides/COPILOT.md +37 -37
  126. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  127. package/templates/ides/CURSOR.md +43 -43
  128. package/templates/ides/GEMINI_RULES.md +17 -17
  129. package/templates/ides/JETBRAINS_AI.md +35 -35
  130. package/templates/ides/REPLIT.md +36 -36
  131. package/templates/ides/TABNINE.md +29 -29
  132. package/templates/ides/VSCODE.md +40 -40
  133. package/templates/ides/WINDSURF.md +36 -36
  134. package/templates/ides/WINDSURF_RULES.md +14 -14
  135. package/templates/ides/ZED.md +32 -32
  136. package/templates/ides/cursor-mdc/go.mdc +24 -24
  137. package/templates/ides/cursor-mdc/python.mdc +24 -24
  138. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  139. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  140. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  141. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  142. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  143. package/templates/languages/C.md +333 -333
  144. package/templates/languages/CPP.md +743 -743
  145. package/templates/languages/CSHARP.md +417 -417
  146. package/templates/languages/ELIXIR.md +454 -454
  147. package/templates/languages/ERLANG.md +361 -361
  148. package/templates/languages/GO.md +645 -645
  149. package/templates/languages/HASKELL.md +177 -177
  150. package/templates/languages/JAVA.md +607 -607
  151. package/templates/languages/JAVASCRIPT.md +631 -631
  152. package/templates/languages/JULIA.md +97 -97
  153. package/templates/languages/KOTLIN.md +511 -511
  154. package/templates/languages/LISP.md +100 -100
  155. package/templates/languages/LUA.md +74 -74
  156. package/templates/languages/OBJECTIVEC.md +90 -90
  157. package/templates/languages/PHP.md +416 -416
  158. package/templates/languages/PYTHON.md +682 -682
  159. package/templates/languages/RUBY.md +421 -421
  160. package/templates/languages/RUST.md +477 -477
  161. package/templates/languages/SAS.md +73 -73
  162. package/templates/languages/SCALA.md +348 -348
  163. package/templates/languages/SOLIDITY.md +580 -580
  164. package/templates/languages/SQL.md +137 -137
  165. package/templates/languages/SWIFT.md +466 -466
  166. package/templates/languages/TYPESCRIPT.md +591 -591
  167. package/templates/languages/ZIG.md +265 -265
  168. package/templates/modules/ATLASSIAN.md +255 -255
  169. package/templates/modules/CONTEXT7.md +54 -54
  170. package/templates/modules/FIGMA.md +267 -267
  171. package/templates/modules/GITHUB_MCP.md +64 -64
  172. package/templates/modules/GRAFANA.md +328 -328
  173. package/templates/modules/MEMORY.md +126 -126
  174. package/templates/modules/NOTION.md +247 -247
  175. package/templates/modules/PLAYWRIGHT.md +90 -90
  176. package/templates/modules/RULEBOOK_MCP.md +156 -156
  177. package/templates/modules/SERENA.md +337 -337
  178. package/templates/modules/SUPABASE.md +223 -223
  179. package/templates/modules/SYNAP.md +69 -69
  180. package/templates/modules/VECTORIZER.md +63 -63
  181. package/templates/modules/sequential-thinking.md +42 -42
  182. package/templates/ralph/ralph-history.bat +4 -4
  183. package/templates/ralph/ralph-history.sh +5 -5
  184. package/templates/ralph/ralph-init.bat +5 -5
  185. package/templates/ralph/ralph-init.sh +5 -5
  186. package/templates/ralph/ralph-pause.bat +5 -5
  187. package/templates/ralph/ralph-pause.sh +5 -5
  188. package/templates/ralph/ralph-run.bat +5 -5
  189. package/templates/ralph/ralph-run.sh +5 -5
  190. package/templates/ralph/ralph-status.bat +4 -4
  191. package/templates/ralph/ralph-status.sh +5 -5
  192. package/templates/services/AZURE_BLOB.md +184 -184
  193. package/templates/services/CASSANDRA.md +239 -239
  194. package/templates/services/DATADOG.md +26 -26
  195. package/templates/services/DOCKER.md +124 -124
  196. package/templates/services/DOCKER_COMPOSE.md +168 -168
  197. package/templates/services/DYNAMODB.md +308 -308
  198. package/templates/services/ELASTICSEARCH.md +347 -347
  199. package/templates/services/GCS.md +178 -178
  200. package/templates/services/HELM.md +194 -194
  201. package/templates/services/INFLUXDB.md +265 -265
  202. package/templates/services/KAFKA.md +341 -341
  203. package/templates/services/KUBERNETES.md +208 -208
  204. package/templates/services/MARIADB.md +183 -183
  205. package/templates/services/MEMCACHED.md +242 -242
  206. package/templates/services/MINIO.md +201 -201
  207. package/templates/services/MONGODB.md +268 -268
  208. package/templates/services/MYSQL.md +358 -358
  209. package/templates/services/NEO4J.md +247 -247
  210. package/templates/services/OPENTELEMETRY.md +25 -25
  211. package/templates/services/ORACLE.md +290 -290
  212. package/templates/services/PINO.md +24 -24
  213. package/templates/services/POSTGRESQL.md +326 -326
  214. package/templates/services/PROMETHEUS.md +33 -33
  215. package/templates/services/RABBITMQ.md +286 -286
  216. package/templates/services/REDIS.md +292 -292
  217. package/templates/services/S3.md +298 -298
  218. package/templates/services/SENTRY.md +23 -23
  219. package/templates/services/SQLITE.md +294 -294
  220. package/templates/services/SQLSERVER.md +294 -294
  221. package/templates/services/WINSTON.md +30 -30
  222. package/templates/skills/cli/aider/SKILL.md +59 -59
  223. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  224. package/templates/skills/cli/auggie/SKILL.md +42 -42
  225. package/templates/skills/cli/claude/SKILL.md +42 -42
  226. package/templates/skills/cli/cline/SKILL.md +42 -42
  227. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  228. package/templates/skills/cli/codeium/SKILL.md +30 -30
  229. package/templates/skills/cli/codex/SKILL.md +31 -31
  230. package/templates/skills/cli/continue/SKILL.md +44 -44
  231. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  232. package/templates/skills/cli/factory/SKILL.md +28 -28
  233. package/templates/skills/cli/gemini/SKILL.md +45 -45
  234. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  235. package/templates/skills/cli/opencode/SKILL.md +28 -28
  236. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  237. package/templates/skills/core/dag/SKILL.md +314 -314
  238. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  239. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  240. package/templates/skills/core/rulebook/SKILL.md +176 -176
  241. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  242. package/templates/skills/dev/api-design/SKILL.md +15 -0
  243. package/templates/skills/dev/architect/SKILL.md +17 -0
  244. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  245. package/templates/skills/dev/db-design/SKILL.md +15 -0
  246. package/templates/skills/dev/debug/SKILL.md +16 -0
  247. package/templates/skills/dev/deploy/SKILL.md +17 -0
  248. package/templates/skills/dev/docs/SKILL.md +17 -0
  249. package/templates/skills/dev/migrate/SKILL.md +15 -0
  250. package/templates/skills/dev/perf/SKILL.md +17 -0
  251. package/templates/skills/dev/refactor/SKILL.md +17 -0
  252. package/templates/skills/dev/research/SKILL.md +14 -0
  253. package/templates/skills/dev/review/SKILL.md +18 -0
  254. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  255. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  256. package/templates/skills/frameworks/django/SKILL.md +93 -93
  257. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  258. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  259. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  260. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  261. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  262. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  263. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  264. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  265. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  266. package/templates/skills/frameworks/react/SKILL.md +48 -48
  267. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  268. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  269. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  270. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  271. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  272. package/templates/skills/ides/copilot/SKILL.md +47 -47
  273. package/templates/skills/ides/cursor/SKILL.md +53 -53
  274. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  275. package/templates/skills/ides/replit/SKILL.md +46 -46
  276. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  277. package/templates/skills/ides/vscode/SKILL.md +50 -50
  278. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  279. package/templates/skills/ides/zed/SKILL.md +42 -42
  280. package/templates/skills/languages/c/SKILL.md +343 -343
  281. package/templates/skills/languages/cpp/SKILL.md +753 -753
  282. package/templates/skills/languages/csharp/SKILL.md +427 -427
  283. package/templates/skills/languages/elixir/SKILL.md +464 -464
  284. package/templates/skills/languages/erlang/SKILL.md +371 -371
  285. package/templates/skills/languages/go/SKILL.md +655 -655
  286. package/templates/skills/languages/haskell/SKILL.md +187 -187
  287. package/templates/skills/languages/java/SKILL.md +617 -617
  288. package/templates/skills/languages/javascript/SKILL.md +641 -641
  289. package/templates/skills/languages/julia/SKILL.md +107 -107
  290. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  291. package/templates/skills/languages/lisp/SKILL.md +110 -110
  292. package/templates/skills/languages/lua/SKILL.md +84 -84
  293. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  294. package/templates/skills/languages/php/SKILL.md +426 -426
  295. package/templates/skills/languages/python/SKILL.md +692 -692
  296. package/templates/skills/languages/ruby/SKILL.md +431 -431
  297. package/templates/skills/languages/rust/SKILL.md +487 -487
  298. package/templates/skills/languages/sas/SKILL.md +83 -83
  299. package/templates/skills/languages/scala/SKILL.md +358 -358
  300. package/templates/skills/languages/solidity/SKILL.md +590 -590
  301. package/templates/skills/languages/sql/SKILL.md +147 -147
  302. package/templates/skills/languages/swift/SKILL.md +476 -476
  303. package/templates/skills/languages/typescript/SKILL.md +302 -302
  304. package/templates/skills/languages/zig/SKILL.md +275 -275
  305. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  306. package/templates/skills/modules/context7/SKILL.md +64 -64
  307. package/templates/skills/modules/figma/SKILL.md +277 -277
  308. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  309. package/templates/skills/modules/grafana/SKILL.md +338 -338
  310. package/templates/skills/modules/memory/SKILL.md +73 -73
  311. package/templates/skills/modules/notion/SKILL.md +257 -257
  312. package/templates/skills/modules/playwright/SKILL.md +100 -100
  313. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  314. package/templates/skills/modules/serena/SKILL.md +347 -347
  315. package/templates/skills/modules/supabase/SKILL.md +233 -233
  316. package/templates/skills/modules/synap/SKILL.md +79 -79
  317. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  318. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  319. package/templates/skills/services/cassandra/SKILL.md +249 -249
  320. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  321. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  322. package/templates/skills/services/gcs/SKILL.md +188 -188
  323. package/templates/skills/services/influxdb/SKILL.md +275 -275
  324. package/templates/skills/services/kafka/SKILL.md +351 -351
  325. package/templates/skills/services/mariadb/SKILL.md +193 -193
  326. package/templates/skills/services/memcached/SKILL.md +252 -252
  327. package/templates/skills/services/minio/SKILL.md +211 -211
  328. package/templates/skills/services/mongodb/SKILL.md +278 -278
  329. package/templates/skills/services/mysql/SKILL.md +368 -368
  330. package/templates/skills/services/neo4j/SKILL.md +257 -257
  331. package/templates/skills/services/oracle/SKILL.md +300 -300
  332. package/templates/skills/services/postgresql/SKILL.md +336 -336
  333. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  334. package/templates/skills/services/redis/SKILL.md +302 -302
  335. package/templates/skills/services/s3/SKILL.md +308 -308
  336. package/templates/skills/services/sqlite/SKILL.md +304 -304
  337. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  338. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  339. package/templates/skills/workflows/ralph/install.sh +87 -87
  340. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,631 +1,631 @@
1
- <!-- JAVASCRIPT:START -->
2
- # JavaScript 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 lint # Linting (0 warnings required)
11
- npm run format # Code formatting
12
- npm test # All tests (100% pass required)
13
- npm run test:coverage # Coverage check (95%+ required)
14
- npm run build # Build verification (if applicable)
15
-
16
- # Security audit:
17
- npm audit --production # Vulnerability scan
18
- npm outdated # Check outdated deps
19
- ```
20
-
21
- ## JavaScript Configuration
22
-
23
- **CRITICAL**: Use modern JavaScript (ES2022+) with strict linting and testing.
24
-
25
- - **Version**: Node.js 18+
26
- - **Recommended**: Node.js 22 LTS
27
- - **Standard**: ES2022 or later
28
- - **Module System**: ESM (ES Modules)
29
- - **Type**: Set `"type": "module"` in package.json
30
-
31
- ### package.json Requirements
32
-
33
- ```json
34
- {
35
- "name": "your-package",
36
- "version": "1.0.0",
37
- "description": "Package description",
38
- "type": "module",
39
- "main": "./dist/index.js",
40
- "exports": {
41
- ".": {
42
- "import": "./dist/index.js"
43
- }
44
- },
45
- "files": [
46
- "dist",
47
- "README.md",
48
- "LICENSE"
49
- ],
50
- "scripts": {
51
- "build": "esbuild src/index.js --bundle --platform=node --outfile=dist/index.js",
52
- "test": "vitest --run",
53
- "test:watch": "vitest",
54
- "test:coverage": "vitest --coverage",
55
- "lint": "eslint src/**/*.js tests/**/*.js",
56
- "lint:fix": "eslint src/**/*.js tests/**/*.js --fix",
57
- "format": "prettier --write 'src/**/*.js' 'tests/**/*.js'",
58
- "format:check": "prettier --check 'src/**/*.js' 'tests/**/*.js'"
59
- },
60
- "engines": {
61
- "node": ">=18.0.0"
62
- },
63
- "devDependencies": {
64
- "eslint": "^9.19.0",
65
- "prettier": "^3.4.0",
66
- "vitest": "^2.1.0",
67
- "@vitest/coverage-v8": "^2.1.0",
68
- "esbuild": "^0.24.0"
69
- }
70
- }
71
- ```
72
-
73
- ## Code Quality Standards
74
-
75
- ### Mandatory Quality Checks
76
-
77
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
78
-
79
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
80
-
81
- ```bash
82
- # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
83
-
84
- # 1. Lint (MUST pass with no warnings - matches workflow)
85
- npm run lint
86
-
87
- # 2. Format check (matches workflow - use check, not write!)
88
- npm run format:check
89
- # or: npx prettier --check 'src/**/*.js' 'tests/**/*.js'
90
-
91
- # 3. Run all tests (MUST pass 100% - matches workflow)
92
- npm test
93
-
94
- # 4. Build (if applicable - matches workflow)
95
- npm run build
96
-
97
- # 5. Check coverage (MUST meet threshold)
98
- npm run test:coverage
99
-
100
- # If ANY fails: ❌ DO NOT COMMIT - Fix first!
101
- ```
102
-
103
- **If ANY of these fail, you MUST fix the issues before committing.**
104
-
105
- **Why This Matters:**
106
- - Running different commands locally than in CI causes "works on my machine" failures
107
- - CI/CD workflows will fail if commands don't match
108
- - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
109
- - Example: Skipping lint locally = CI ESLint failures catch errors you missed
110
-
111
- ### Linting
112
-
113
- - Use ESLint 9+ with flat config
114
- - Configuration in `eslint.config.js`
115
- - Must pass with no warnings
116
- - Use recommended rule sets
117
-
118
- Example `eslint.config.js`:
119
- ```javascript
120
- import js from '@eslint/js';
121
-
122
- export default [
123
- js.configs.recommended,
124
- {
125
- files: ['src/**/*.js', 'tests/**/*.js'],
126
- languageOptions: {
127
- ecmaVersion: 2022,
128
- sourceType: 'module',
129
- globals: {
130
- console: 'readonly',
131
- process: 'readonly',
132
- },
133
- },
134
- rules: {
135
- 'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
136
- 'no-console': 'off', // Allow console in Node.js
137
- 'prefer-const': 'error',
138
- 'no-var': 'error',
139
- },
140
- },
141
- ];
142
- ```
143
-
144
- ### Formatting
145
-
146
- - Use Prettier for code formatting
147
- - Configuration in `.prettierrc.json`
148
- - Integrate with ESLint for consistency
149
- - Format before committing
150
-
151
- Example `.prettierrc.json`:
152
- ```json
153
- {
154
- "semi": true,
155
- "trailingComma": "es5",
156
- "singleQuote": true,
157
- "printWidth": 100,
158
- "tabWidth": 2,
159
- "arrowParens": "always"
160
- }
161
- ```
162
-
163
- ### Testing
164
-
165
- - **Framework**: Vitest (recommended), Jest, or Mocha
166
- - **Location**: `/tests` directory
167
- - **Coverage**: Must meet project threshold (default 80%)
168
- - **Watch Mode**: Use `vitest` or `vitest --watch` for development
169
- - **CI Mode**: **CRITICAL** - Default `npm test` command MUST include `--run` flag
170
- - This prevents Vitest from entering watch mode, which never terminates
171
- - In `package.json`: `"test": "vitest --run"`
172
- - For manual development, use `npm run test:watch`
173
-
174
- Example test structure:
175
- ```javascript
176
- import { describe, it, expect, beforeEach, afterEach } from 'vitest';
177
- import { myFunction } from '../src/module.js';
178
-
179
- describe('myFunction', () => {
180
- let testData;
181
-
182
- beforeEach(() => {
183
- testData = { value: 'test' };
184
- });
185
-
186
- afterEach(() => {
187
- // Cleanup
188
- });
189
-
190
- it('should return expected value', () => {
191
- const result = myFunction(testData);
192
- expect(result).toBe('expected');
193
- });
194
-
195
- it('should throw on invalid input', () => {
196
- expect(() => myFunction(null)).toThrow('Invalid input');
197
- });
198
- });
199
- ```
200
-
201
- ### S2S (Server-to-Server) and Slow Tests
202
-
203
- **CRITICAL**: Separate fast tests from slow/S2S tests.
204
-
205
- **Problem**: Mixing fast unit tests with slow integration tests or tests requiring external servers causes:
206
- - ❌ Slow CI/CD pipelines (10+ minutes instead of < 2 minutes)
207
- - ❌ Flaky tests (external services unreliable)
208
- - ❌ Developer frustration (slow test feedback)
209
- - ❌ Blocked commits (waiting for slow tests)
210
-
211
- **Solution**: Isolate S2S and slow tests using environment variables and tags.
212
-
213
- #### What are S2S/Slow Tests?
214
-
215
- **S2S (Server-to-Server) Tests**:
216
- - Require external running servers (databases, APIs, message queues)
217
- - Network I/O heavy
218
- - Typically 5-30 seconds per test
219
- - Examples: Database integration tests, API endpoint tests, message queue tests
220
-
221
- **Slow Tests**:
222
- - Long-running operations (processing large files, complex calculations)
223
- - Typically > 5 seconds per test
224
- - Examples: File processing tests, image manipulation, encryption tests
225
-
226
- **Fast Tests** (Regular Unit Tests):
227
- - No external dependencies
228
- - In-memory only
229
- - < 100ms per test
230
- - Should be 95%+ of your test suite
231
-
232
- #### Implementation Pattern
233
-
234
- **1. Mark S2S/slow tests with conditional execution**:
235
-
236
- ```javascript
237
- // tests/integration/database.test.js
238
- import { describe, it, expect, beforeAll, afterAll } from 'vitest';
239
- import { setupDatabase, teardownDatabase } from './test-helpers.js';
240
-
241
- // Only run if RUN_S2S_TESTS environment variable is set
242
- const runS2STests = process.env.RUN_S2S_TESTS === '1';
243
- const describeS2S = runS2STests ? describe : describe.skip;
244
-
245
- describeS2S('Database Integration', () => {
246
- beforeAll(async () => {
247
- await setupDatabase();
248
- });
249
-
250
- afterAll(async () => {
251
- await teardownDatabase();
252
- });
253
-
254
- it('should connect to database', async () => {
255
- const result = await query('SELECT 1');
256
- expect(result).toBeDefined();
257
- }, { timeout: 30000 }); // 30 second timeout for S2S tests
258
- });
259
- ```
260
-
261
- **2. Mark slow tests similarly**:
262
-
263
- ```javascript
264
- // tests/slow/file-processing.test.js
265
- const runSlowTests = process.env.RUN_SLOW_TESTS === '1';
266
- const describeSlow = runSlowTests ? describe : describe.skip;
267
-
268
- describeSlow('Large File Processing', () => {
269
- it('should process 1GB file', async () => {
270
- const result = await processLargeFile('large-file.dat');
271
- expect(result).toBeDefined();
272
- }, { timeout: 60000 }); // 60 second timeout
273
- });
274
- ```
275
-
276
- **3. Organize tests by speed**:
277
-
278
- ```
279
- tests/
280
- ├── unit/ # Fast tests (< 100ms) - DEFAULT
281
- │ ├── parser.test.js
282
- │ └── validator.test.js
283
- ├── integration/ # S2S tests (require servers)
284
- │ ├── database.test.js
285
- │ └── api.test.js
286
- └── slow/ # Slow tests (> 5 seconds)
287
- └── file-processing.test.js
288
- ```
289
-
290
- **4. Add npm scripts in `package.json`**:
291
-
292
- ```json
293
- {
294
- "scripts": {
295
- "test": "vitest --run",
296
- "test:watch": "vitest",
297
- "test:s2s": "RUN_S2S_TESTS=1 vitest --run",
298
- "test:slow": "RUN_SLOW_TESTS=1 vitest --run",
299
- "test:all": "RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 vitest --run"
300
- }
301
- }
302
- ```
303
-
304
- **Windows users**: Use `cross-env` for environment variables:
305
-
306
- ```bash
307
- npm install --save-dev cross-env
308
- ```
309
-
310
- ```json
311
- {
312
- "scripts": {
313
- "test:s2s": "cross-env RUN_S2S_TESTS=1 vitest --run",
314
- "test:slow": "cross-env RUN_SLOW_TESTS=1 vitest --run"
315
- }
316
- }
317
- ```
318
-
319
- #### Best Practices
320
-
321
- - ✅ **Always run fast tests** in CI/CD by default
322
- - ✅ **Isolate S2S tests** - never run them in standard test suite
323
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
324
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
325
- - ✅ **Use timeouts** - Set appropriate timeouts: `{ timeout: 30000 }` for S2S tests
326
- - ✅ **Use environment variables** - Control test execution with `RUN_S2S_TESTS` and `RUN_SLOW_TESTS`
327
- - ❌ **Never mix** fast and slow/S2S tests in same test run
328
- - ❌ **Never require** external services for standard test suite
329
- - ❌ **Never exceed** 10-20 seconds for regular tests
330
-
331
- #### Example: Complete Test Setup
332
-
333
- **Fast test** (runs by default):
334
- ```javascript
335
- // tests/unit/calculator.test.js
336
- import { describe, it, expect } from 'vitest';
337
- import { add, multiply } from '../src/calculator.js';
338
-
339
- describe('Calculator', () => {
340
- it('should add numbers', () => {
341
- expect(add(2, 3)).toBe(5);
342
- });
343
-
344
- it('should multiply numbers', () => {
345
- expect(multiply(2, 3)).toBe(6);
346
- });
347
- });
348
- ```
349
-
350
- **S2S test** (skipped by default):
351
- ```javascript
352
- // tests/integration/api.test.js
353
- import { describe, it, expect, beforeAll, afterAll } from 'vitest';
354
-
355
- const runS2STests = process.env.RUN_S2S_TESTS === '1';
356
- const describeS2S = runS2STests ? describe : describe.skip;
357
-
358
- describeS2S('API Integration', () => {
359
- let server;
360
-
361
- beforeAll(async () => {
362
- // Start server on port 3001
363
- server = await startTestServer(3001);
364
- });
365
-
366
- afterAll(async () => {
367
- await server.close();
368
- });
369
-
370
- it('should fetch users from API', async () => {
371
- const response = await fetch('http://localhost:3001/users');
372
- expect(response.status).toBe(200);
373
- const data = await response.json();
374
- expect(Array.isArray(data)).toBe(true);
375
- }, { timeout: 30000 });
376
- });
377
- ```
378
-
379
- **Running tests**:
380
- ```bash
381
- # Fast tests only (default - for development and CI)
382
- npm test
383
-
384
- # Include S2S tests (manual or scheduled CI)
385
- npm run test:s2s
386
-
387
- # Include slow tests
388
- npm run test:slow
389
-
390
- # All tests (nightly builds)
391
- npm run test:all
392
- ```
393
-
394
- ## Module System
395
-
396
- - Use ES modules (`import`/`export`)
397
- - Set `"type": "module"` in `package.json`
398
- - Use `.js` extensions in imports for Node.js compatibility
399
- - No CommonJS (`require`/`module.exports`) in new code
400
-
401
- Example:
402
- ```javascript
403
- // Good: ES modules with .js extension
404
- import { myFunction } from './my-module.js';
405
- import fs from 'node:fs';
406
-
407
- export { myFunction };
408
- export default class MyClass {}
409
- ```
410
-
411
- ```javascript
412
- // Bad: CommonJS
413
- const { myFunction } = require('./my-module');
414
- module.exports = { myFunction };
415
- ```
416
-
417
- ## Error Handling
418
-
419
- - Always handle errors explicitly
420
- - Use try/catch for async operations
421
- - Create custom error classes for domain errors
422
- - Never swallow errors silently
423
-
424
- Example:
425
- ```javascript
426
- export class ValidationError extends Error {
427
- constructor(message, field) {
428
- super(message);
429
- this.name = 'ValidationError';
430
- this.field = field;
431
- }
432
- }
433
-
434
- export async function fetchData(url) {
435
- try {
436
- const response = await fetch(url);
437
- if (!response.ok) {
438
- throw new Error(`HTTP ${response.status}: ${response.statusText}`);
439
- }
440
- return await response.json();
441
- } catch (error) {
442
- if (error instanceof TypeError) {
443
- throw new ValidationError('Invalid URL', 'url');
444
- }
445
- throw error;
446
- }
447
- }
448
- ```
449
-
450
- ## Documentation
451
-
452
- - Use JSDoc for documentation
453
- - Document all public APIs
454
- - Include examples
455
- - Export types for consumers (if using TypeScript types via JSDoc)
456
-
457
- Example:
458
- ```javascript
459
- /**
460
- * Processes the input data and returns a formatted result.
461
- *
462
- * @param {string} input - The input string to process
463
- * @param {Object} [options] - Optional processing options
464
- * @param {boolean} [options.trim=false] - Whether to trim whitespace
465
- * @returns {string} The processed string in uppercase
466
- * @throws {ValidationError} If input is empty
467
- *
468
- * @example
469
- * ```javascript
470
- * const result = process('hello', { trim: true });
471
- * console.log(result); // 'HELLO'
472
- * ```
473
- */
474
- export function process(input, options = {}) {
475
- if (!input) {
476
- throw new ValidationError('Input cannot be empty', 'input');
477
- }
478
- const processed = options.trim ? input.trim() : input;
479
- return processed.toUpperCase();
480
- }
481
- ```
482
-
483
- ## Async/Await Patterns
484
-
485
- - Always use async/await (not callbacks or raw promises)
486
- - Handle promise rejections
487
- - Use Promise.all for concurrent operations
488
- - Avoid blocking operations
489
-
490
- Example:
491
- ```javascript
492
- // Good: Async/await with error handling
493
- export async function processMultiple(urls) {
494
- try {
495
- const results = await Promise.all(
496
- urls.map(url => fetchData(url))
497
- );
498
- return results;
499
- } catch (error) {
500
- console.error('Failed to process URLs:', error);
501
- throw error;
502
- }
503
- }
504
-
505
- // Bad: Callback hell
506
- function processMultipleCallback(urls, callback) {
507
- let results = [];
508
- urls.forEach((url, i) => {
509
- fetchDataCallback(url, (err, data) => {
510
- if (err) return callback(err);
511
- results.push(data);
512
- if (i === urls.length - 1) callback(null, results);
513
- });
514
- });
515
- }
516
- ```
517
-
518
- ## Package Management
519
-
520
- **CRITICAL**: Use consistent package manager across team.
521
-
522
- - **Default**: npm (most compatible, built-in)
523
- - **Alternative**: pnpm (fast, disk-efficient) or yarn
524
- - **Lockfile**: Always commit lockfile (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`)
525
- - **IMPORTANT**: GitHub Actions `setup-node` with `cache: 'npm'` requires lockfile to be committed
526
- - Without lockfile: CI/CD fails with "Dependencies lock file is not found"
527
- - Solution: Commit `package-lock.json` and use `npm ci` in workflows
528
-
529
- ### Dependencies
530
-
531
- 1. **Check for latest versions**:
532
- - Use Context7 MCP tool if available
533
- - Check npm registry: `npm view <package> versions`
534
- - Review changelog for breaking changes
535
-
536
- 2. **Dependency Guidelines**:
537
- - ✅ Use exact versions for applications (`"1.2.3"`)
538
- - ✅ Use semver for libraries (`"^1.2.3"`)
539
- - ✅ Keep dependencies updated regularly
540
- - ✅ Use `npm audit` for security
541
- - ❌ Don't use deprecated packages
542
- - ❌ Don't add unnecessary dependencies
543
-
544
- ## CI/CD Requirements
545
-
546
- **CRITICAL**: GitHub Actions `cache: 'npm'` requires `package-lock.json` to be committed.
547
-
548
- Must include GitHub Actions workflows for:
549
-
550
- 1. **Testing** (`javascript-test.yml`):
551
- - Test on ubuntu-latest, windows-latest, macos-latest
552
- - Node.js versions: 18.x, 20.x, 22.x
553
- - Use Vitest for fast execution
554
- - Upload coverage reports
555
- - **MUST**: Commit package-lock.json for caching
556
-
557
- 2. **Linting** (`javascript-lint.yml`):
558
- - ESLint: `npm run lint`
559
- - Prettier: `npm run format:check`
560
- - **MUST**: Commit package-lock.json for caching
561
-
562
- 3. **Build** (`javascript-build.yml`):
563
- - Build: `npm run build`
564
- - Verify output artifacts
565
- - **MUST**: Commit package-lock.json for caching
566
-
567
- ## Project Structure
568
-
569
- ```
570
- project/
571
- ├── package.json # Package manifest
572
- ├── package-lock.json # Lockfile (MUST commit for CI cache)
573
- ├── eslint.config.js # ESLint configuration
574
- ├── .prettierrc.json # Prettier configuration
575
- ├── vitest.config.js # Test configuration
576
- ├── README.md # Project overview
577
- ├── LICENSE # Project license
578
- ├── src/
579
- │ ├── index.js # Main entry point
580
- │ └── ...
581
- ├── tests/ # Test files
582
- ├── dist/ # Build output (gitignored)
583
- └── docs/ # Documentation
584
- ```
585
-
586
- ## Best Practices
587
-
588
- ### DO's ✅
589
-
590
- - **USE** modern ES2022+ features
591
- - **USE** async/await for asynchronous code
592
- - **USE** strict equality (`===`) over loose equality (`==`)
593
- - **VALIDATE** all inputs
594
- - **HANDLE** errors explicitly
595
- - **DOCUMENT** public APIs with JSDoc
596
- - **TEST** all code paths
597
- - **KEEP** dependencies minimal and updated
598
-
599
- ### DON'Ts ❌
600
-
601
- - **NEVER** use `var` (use `const` or `let`)
602
- - **NEVER** use `==` (use `===`)
603
- - **NEVER** swallow errors silently
604
- - **NEVER** commit `node_modules/`
605
- - **NEVER** commit `.env` files
606
- - **NEVER** use deprecated packages
607
- - **NEVER** skip tests
608
- - **NEVER** commit console.log debugging code
609
-
610
- ## Security
611
-
612
- - Never commit secrets or API keys
613
- - Use environment variables for sensitive data
614
- - Run `npm audit` regularly
615
- - Keep dependencies updated
616
- - Use `.env` files (add to `.gitignore`)
617
-
618
- Example `.env`:
619
- ```bash
620
- API_KEY=your-secret-key
621
- DATABASE_URL=postgres://localhost/db
622
- ```
623
-
624
- Load with:
625
- ```javascript
626
- import 'dotenv/config';
627
-
628
- const apiKey = process.env.API_KEY;
629
- ```
630
-
631
- <!-- JAVASCRIPT:END -->
1
+ <!-- JAVASCRIPT:START -->
2
+ # JavaScript 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 lint # Linting (0 warnings required)
11
+ npm run format # Code formatting
12
+ npm test # All tests (100% pass required)
13
+ npm run test:coverage # Coverage check (95%+ required)
14
+ npm run build # Build verification (if applicable)
15
+
16
+ # Security audit:
17
+ npm audit --production # Vulnerability scan
18
+ npm outdated # Check outdated deps
19
+ ```
20
+
21
+ ## JavaScript Configuration
22
+
23
+ **CRITICAL**: Use modern JavaScript (ES2022+) with strict linting and testing.
24
+
25
+ - **Version**: Node.js 18+
26
+ - **Recommended**: Node.js 22 LTS
27
+ - **Standard**: ES2022 or later
28
+ - **Module System**: ESM (ES Modules)
29
+ - **Type**: Set `"type": "module"` in package.json
30
+
31
+ ### package.json Requirements
32
+
33
+ ```json
34
+ {
35
+ "name": "your-package",
36
+ "version": "1.0.0",
37
+ "description": "Package description",
38
+ "type": "module",
39
+ "main": "./dist/index.js",
40
+ "exports": {
41
+ ".": {
42
+ "import": "./dist/index.js"
43
+ }
44
+ },
45
+ "files": [
46
+ "dist",
47
+ "README.md",
48
+ "LICENSE"
49
+ ],
50
+ "scripts": {
51
+ "build": "esbuild src/index.js --bundle --platform=node --outfile=dist/index.js",
52
+ "test": "vitest --run",
53
+ "test:watch": "vitest",
54
+ "test:coverage": "vitest --coverage",
55
+ "lint": "eslint src/**/*.js tests/**/*.js",
56
+ "lint:fix": "eslint src/**/*.js tests/**/*.js --fix",
57
+ "format": "prettier --write 'src/**/*.js' 'tests/**/*.js'",
58
+ "format:check": "prettier --check 'src/**/*.js' 'tests/**/*.js'"
59
+ },
60
+ "engines": {
61
+ "node": ">=18.0.0"
62
+ },
63
+ "devDependencies": {
64
+ "eslint": "^9.19.0",
65
+ "prettier": "^3.4.0",
66
+ "vitest": "^2.1.0",
67
+ "@vitest/coverage-v8": "^2.1.0",
68
+ "esbuild": "^0.24.0"
69
+ }
70
+ }
71
+ ```
72
+
73
+ ## Code Quality Standards
74
+
75
+ ### Mandatory Quality Checks
76
+
77
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
78
+
79
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
80
+
81
+ ```bash
82
+ # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
83
+
84
+ # 1. Lint (MUST pass with no warnings - matches workflow)
85
+ npm run lint
86
+
87
+ # 2. Format check (matches workflow - use check, not write!)
88
+ npm run format:check
89
+ # or: npx prettier --check 'src/**/*.js' 'tests/**/*.js'
90
+
91
+ # 3. Run all tests (MUST pass 100% - matches workflow)
92
+ npm test
93
+
94
+ # 4. Build (if applicable - matches workflow)
95
+ npm run build
96
+
97
+ # 5. Check coverage (MUST meet threshold)
98
+ npm run test:coverage
99
+
100
+ # If ANY fails: ❌ DO NOT COMMIT - Fix first!
101
+ ```
102
+
103
+ **If ANY of these fail, you MUST fix the issues before committing.**
104
+
105
+ **Why This Matters:**
106
+ - Running different commands locally than in CI causes "works on my machine" failures
107
+ - CI/CD workflows will fail if commands don't match
108
+ - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
109
+ - Example: Skipping lint locally = CI ESLint failures catch errors you missed
110
+
111
+ ### Linting
112
+
113
+ - Use ESLint 9+ with flat config
114
+ - Configuration in `eslint.config.js`
115
+ - Must pass with no warnings
116
+ - Use recommended rule sets
117
+
118
+ Example `eslint.config.js`:
119
+ ```javascript
120
+ import js from '@eslint/js';
121
+
122
+ export default [
123
+ js.configs.recommended,
124
+ {
125
+ files: ['src/**/*.js', 'tests/**/*.js'],
126
+ languageOptions: {
127
+ ecmaVersion: 2022,
128
+ sourceType: 'module',
129
+ globals: {
130
+ console: 'readonly',
131
+ process: 'readonly',
132
+ },
133
+ },
134
+ rules: {
135
+ 'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
136
+ 'no-console': 'off', // Allow console in Node.js
137
+ 'prefer-const': 'error',
138
+ 'no-var': 'error',
139
+ },
140
+ },
141
+ ];
142
+ ```
143
+
144
+ ### Formatting
145
+
146
+ - Use Prettier for code formatting
147
+ - Configuration in `.prettierrc.json`
148
+ - Integrate with ESLint for consistency
149
+ - Format before committing
150
+
151
+ Example `.prettierrc.json`:
152
+ ```json
153
+ {
154
+ "semi": true,
155
+ "trailingComma": "es5",
156
+ "singleQuote": true,
157
+ "printWidth": 100,
158
+ "tabWidth": 2,
159
+ "arrowParens": "always"
160
+ }
161
+ ```
162
+
163
+ ### Testing
164
+
165
+ - **Framework**: Vitest (recommended), Jest, or Mocha
166
+ - **Location**: `/tests` directory
167
+ - **Coverage**: Must meet project threshold (default 80%)
168
+ - **Watch Mode**: Use `vitest` or `vitest --watch` for development
169
+ - **CI Mode**: **CRITICAL** - Default `npm test` command MUST include `--run` flag
170
+ - This prevents Vitest from entering watch mode, which never terminates
171
+ - In `package.json`: `"test": "vitest --run"`
172
+ - For manual development, use `npm run test:watch`
173
+
174
+ Example test structure:
175
+ ```javascript
176
+ import { describe, it, expect, beforeEach, afterEach } from 'vitest';
177
+ import { myFunction } from '../src/module.js';
178
+
179
+ describe('myFunction', () => {
180
+ let testData;
181
+
182
+ beforeEach(() => {
183
+ testData = { value: 'test' };
184
+ });
185
+
186
+ afterEach(() => {
187
+ // Cleanup
188
+ });
189
+
190
+ it('should return expected value', () => {
191
+ const result = myFunction(testData);
192
+ expect(result).toBe('expected');
193
+ });
194
+
195
+ it('should throw on invalid input', () => {
196
+ expect(() => myFunction(null)).toThrow('Invalid input');
197
+ });
198
+ });
199
+ ```
200
+
201
+ ### S2S (Server-to-Server) and Slow Tests
202
+
203
+ **CRITICAL**: Separate fast tests from slow/S2S tests.
204
+
205
+ **Problem**: Mixing fast unit tests with slow integration tests or tests requiring external servers causes:
206
+ - ❌ Slow CI/CD pipelines (10+ minutes instead of < 2 minutes)
207
+ - ❌ Flaky tests (external services unreliable)
208
+ - ❌ Developer frustration (slow test feedback)
209
+ - ❌ Blocked commits (waiting for slow tests)
210
+
211
+ **Solution**: Isolate S2S and slow tests using environment variables and tags.
212
+
213
+ #### What are S2S/Slow Tests?
214
+
215
+ **S2S (Server-to-Server) Tests**:
216
+ - Require external running servers (databases, APIs, message queues)
217
+ - Network I/O heavy
218
+ - Typically 5-30 seconds per test
219
+ - Examples: Database integration tests, API endpoint tests, message queue tests
220
+
221
+ **Slow Tests**:
222
+ - Long-running operations (processing large files, complex calculations)
223
+ - Typically > 5 seconds per test
224
+ - Examples: File processing tests, image manipulation, encryption tests
225
+
226
+ **Fast Tests** (Regular Unit Tests):
227
+ - No external dependencies
228
+ - In-memory only
229
+ - < 100ms per test
230
+ - Should be 95%+ of your test suite
231
+
232
+ #### Implementation Pattern
233
+
234
+ **1. Mark S2S/slow tests with conditional execution**:
235
+
236
+ ```javascript
237
+ // tests/integration/database.test.js
238
+ import { describe, it, expect, beforeAll, afterAll } from 'vitest';
239
+ import { setupDatabase, teardownDatabase } from './test-helpers.js';
240
+
241
+ // Only run if RUN_S2S_TESTS environment variable is set
242
+ const runS2STests = process.env.RUN_S2S_TESTS === '1';
243
+ const describeS2S = runS2STests ? describe : describe.skip;
244
+
245
+ describeS2S('Database Integration', () => {
246
+ beforeAll(async () => {
247
+ await setupDatabase();
248
+ });
249
+
250
+ afterAll(async () => {
251
+ await teardownDatabase();
252
+ });
253
+
254
+ it('should connect to database', async () => {
255
+ const result = await query('SELECT 1');
256
+ expect(result).toBeDefined();
257
+ }, { timeout: 30000 }); // 30 second timeout for S2S tests
258
+ });
259
+ ```
260
+
261
+ **2. Mark slow tests similarly**:
262
+
263
+ ```javascript
264
+ // tests/slow/file-processing.test.js
265
+ const runSlowTests = process.env.RUN_SLOW_TESTS === '1';
266
+ const describeSlow = runSlowTests ? describe : describe.skip;
267
+
268
+ describeSlow('Large File Processing', () => {
269
+ it('should process 1GB file', async () => {
270
+ const result = await processLargeFile('large-file.dat');
271
+ expect(result).toBeDefined();
272
+ }, { timeout: 60000 }); // 60 second timeout
273
+ });
274
+ ```
275
+
276
+ **3. Organize tests by speed**:
277
+
278
+ ```
279
+ tests/
280
+ ├── unit/ # Fast tests (< 100ms) - DEFAULT
281
+ │ ├── parser.test.js
282
+ │ └── validator.test.js
283
+ ├── integration/ # S2S tests (require servers)
284
+ │ ├── database.test.js
285
+ │ └── api.test.js
286
+ └── slow/ # Slow tests (> 5 seconds)
287
+ └── file-processing.test.js
288
+ ```
289
+
290
+ **4. Add npm scripts in `package.json`**:
291
+
292
+ ```json
293
+ {
294
+ "scripts": {
295
+ "test": "vitest --run",
296
+ "test:watch": "vitest",
297
+ "test:s2s": "RUN_S2S_TESTS=1 vitest --run",
298
+ "test:slow": "RUN_SLOW_TESTS=1 vitest --run",
299
+ "test:all": "RUN_S2S_TESTS=1 RUN_SLOW_TESTS=1 vitest --run"
300
+ }
301
+ }
302
+ ```
303
+
304
+ **Windows users**: Use `cross-env` for environment variables:
305
+
306
+ ```bash
307
+ npm install --save-dev cross-env
308
+ ```
309
+
310
+ ```json
311
+ {
312
+ "scripts": {
313
+ "test:s2s": "cross-env RUN_S2S_TESTS=1 vitest --run",
314
+ "test:slow": "cross-env RUN_SLOW_TESTS=1 vitest --run"
315
+ }
316
+ }
317
+ ```
318
+
319
+ #### Best Practices
320
+
321
+ - ✅ **Always run fast tests** in CI/CD by default
322
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
323
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
324
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
325
+ - ✅ **Use timeouts** - Set appropriate timeouts: `{ timeout: 30000 }` for S2S tests
326
+ - ✅ **Use environment variables** - Control test execution with `RUN_S2S_TESTS` and `RUN_SLOW_TESTS`
327
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
328
+ - ❌ **Never require** external services for standard test suite
329
+ - ❌ **Never exceed** 10-20 seconds for regular tests
330
+
331
+ #### Example: Complete Test Setup
332
+
333
+ **Fast test** (runs by default):
334
+ ```javascript
335
+ // tests/unit/calculator.test.js
336
+ import { describe, it, expect } from 'vitest';
337
+ import { add, multiply } from '../src/calculator.js';
338
+
339
+ describe('Calculator', () => {
340
+ it('should add numbers', () => {
341
+ expect(add(2, 3)).toBe(5);
342
+ });
343
+
344
+ it('should multiply numbers', () => {
345
+ expect(multiply(2, 3)).toBe(6);
346
+ });
347
+ });
348
+ ```
349
+
350
+ **S2S test** (skipped by default):
351
+ ```javascript
352
+ // tests/integration/api.test.js
353
+ import { describe, it, expect, beforeAll, afterAll } from 'vitest';
354
+
355
+ const runS2STests = process.env.RUN_S2S_TESTS === '1';
356
+ const describeS2S = runS2STests ? describe : describe.skip;
357
+
358
+ describeS2S('API Integration', () => {
359
+ let server;
360
+
361
+ beforeAll(async () => {
362
+ // Start server on port 3001
363
+ server = await startTestServer(3001);
364
+ });
365
+
366
+ afterAll(async () => {
367
+ await server.close();
368
+ });
369
+
370
+ it('should fetch users from API', async () => {
371
+ const response = await fetch('http://localhost:3001/users');
372
+ expect(response.status).toBe(200);
373
+ const data = await response.json();
374
+ expect(Array.isArray(data)).toBe(true);
375
+ }, { timeout: 30000 });
376
+ });
377
+ ```
378
+
379
+ **Running tests**:
380
+ ```bash
381
+ # Fast tests only (default - for development and CI)
382
+ npm test
383
+
384
+ # Include S2S tests (manual or scheduled CI)
385
+ npm run test:s2s
386
+
387
+ # Include slow tests
388
+ npm run test:slow
389
+
390
+ # All tests (nightly builds)
391
+ npm run test:all
392
+ ```
393
+
394
+ ## Module System
395
+
396
+ - Use ES modules (`import`/`export`)
397
+ - Set `"type": "module"` in `package.json`
398
+ - Use `.js` extensions in imports for Node.js compatibility
399
+ - No CommonJS (`require`/`module.exports`) in new code
400
+
401
+ Example:
402
+ ```javascript
403
+ // Good: ES modules with .js extension
404
+ import { myFunction } from './my-module.js';
405
+ import fs from 'node:fs';
406
+
407
+ export { myFunction };
408
+ export default class MyClass {}
409
+ ```
410
+
411
+ ```javascript
412
+ // Bad: CommonJS
413
+ const { myFunction } = require('./my-module');
414
+ module.exports = { myFunction };
415
+ ```
416
+
417
+ ## Error Handling
418
+
419
+ - Always handle errors explicitly
420
+ - Use try/catch for async operations
421
+ - Create custom error classes for domain errors
422
+ - Never swallow errors silently
423
+
424
+ Example:
425
+ ```javascript
426
+ export class ValidationError extends Error {
427
+ constructor(message, field) {
428
+ super(message);
429
+ this.name = 'ValidationError';
430
+ this.field = field;
431
+ }
432
+ }
433
+
434
+ export async function fetchData(url) {
435
+ try {
436
+ const response = await fetch(url);
437
+ if (!response.ok) {
438
+ throw new Error(`HTTP ${response.status}: ${response.statusText}`);
439
+ }
440
+ return await response.json();
441
+ } catch (error) {
442
+ if (error instanceof TypeError) {
443
+ throw new ValidationError('Invalid URL', 'url');
444
+ }
445
+ throw error;
446
+ }
447
+ }
448
+ ```
449
+
450
+ ## Documentation
451
+
452
+ - Use JSDoc for documentation
453
+ - Document all public APIs
454
+ - Include examples
455
+ - Export types for consumers (if using TypeScript types via JSDoc)
456
+
457
+ Example:
458
+ ```javascript
459
+ /**
460
+ * Processes the input data and returns a formatted result.
461
+ *
462
+ * @param {string} input - The input string to process
463
+ * @param {Object} [options] - Optional processing options
464
+ * @param {boolean} [options.trim=false] - Whether to trim whitespace
465
+ * @returns {string} The processed string in uppercase
466
+ * @throws {ValidationError} If input is empty
467
+ *
468
+ * @example
469
+ * ```javascript
470
+ * const result = process('hello', { trim: true });
471
+ * console.log(result); // 'HELLO'
472
+ * ```
473
+ */
474
+ export function process(input, options = {}) {
475
+ if (!input) {
476
+ throw new ValidationError('Input cannot be empty', 'input');
477
+ }
478
+ const processed = options.trim ? input.trim() : input;
479
+ return processed.toUpperCase();
480
+ }
481
+ ```
482
+
483
+ ## Async/Await Patterns
484
+
485
+ - Always use async/await (not callbacks or raw promises)
486
+ - Handle promise rejections
487
+ - Use Promise.all for concurrent operations
488
+ - Avoid blocking operations
489
+
490
+ Example:
491
+ ```javascript
492
+ // Good: Async/await with error handling
493
+ export async function processMultiple(urls) {
494
+ try {
495
+ const results = await Promise.all(
496
+ urls.map(url => fetchData(url))
497
+ );
498
+ return results;
499
+ } catch (error) {
500
+ console.error('Failed to process URLs:', error);
501
+ throw error;
502
+ }
503
+ }
504
+
505
+ // Bad: Callback hell
506
+ function processMultipleCallback(urls, callback) {
507
+ let results = [];
508
+ urls.forEach((url, i) => {
509
+ fetchDataCallback(url, (err, data) => {
510
+ if (err) return callback(err);
511
+ results.push(data);
512
+ if (i === urls.length - 1) callback(null, results);
513
+ });
514
+ });
515
+ }
516
+ ```
517
+
518
+ ## Package Management
519
+
520
+ **CRITICAL**: Use consistent package manager across team.
521
+
522
+ - **Default**: npm (most compatible, built-in)
523
+ - **Alternative**: pnpm (fast, disk-efficient) or yarn
524
+ - **Lockfile**: Always commit lockfile (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`)
525
+ - **IMPORTANT**: GitHub Actions `setup-node` with `cache: 'npm'` requires lockfile to be committed
526
+ - Without lockfile: CI/CD fails with "Dependencies lock file is not found"
527
+ - Solution: Commit `package-lock.json` and use `npm ci` in workflows
528
+
529
+ ### Dependencies
530
+
531
+ 1. **Check for latest versions**:
532
+ - Use Context7 MCP tool if available
533
+ - Check npm registry: `npm view <package> versions`
534
+ - Review changelog for breaking changes
535
+
536
+ 2. **Dependency Guidelines**:
537
+ - ✅ Use exact versions for applications (`"1.2.3"`)
538
+ - ✅ Use semver for libraries (`"^1.2.3"`)
539
+ - ✅ Keep dependencies updated regularly
540
+ - ✅ Use `npm audit` for security
541
+ - ❌ Don't use deprecated packages
542
+ - ❌ Don't add unnecessary dependencies
543
+
544
+ ## CI/CD Requirements
545
+
546
+ **CRITICAL**: GitHub Actions `cache: 'npm'` requires `package-lock.json` to be committed.
547
+
548
+ Must include GitHub Actions workflows for:
549
+
550
+ 1. **Testing** (`javascript-test.yml`):
551
+ - Test on ubuntu-latest, windows-latest, macos-latest
552
+ - Node.js versions: 18.x, 20.x, 22.x
553
+ - Use Vitest for fast execution
554
+ - Upload coverage reports
555
+ - **MUST**: Commit package-lock.json for caching
556
+
557
+ 2. **Linting** (`javascript-lint.yml`):
558
+ - ESLint: `npm run lint`
559
+ - Prettier: `npm run format:check`
560
+ - **MUST**: Commit package-lock.json for caching
561
+
562
+ 3. **Build** (`javascript-build.yml`):
563
+ - Build: `npm run build`
564
+ - Verify output artifacts
565
+ - **MUST**: Commit package-lock.json for caching
566
+
567
+ ## Project Structure
568
+
569
+ ```
570
+ project/
571
+ ├── package.json # Package manifest
572
+ ├── package-lock.json # Lockfile (MUST commit for CI cache)
573
+ ├── eslint.config.js # ESLint configuration
574
+ ├── .prettierrc.json # Prettier configuration
575
+ ├── vitest.config.js # Test configuration
576
+ ├── README.md # Project overview
577
+ ├── LICENSE # Project license
578
+ ├── src/
579
+ │ ├── index.js # Main entry point
580
+ │ └── ...
581
+ ├── tests/ # Test files
582
+ ├── dist/ # Build output (gitignored)
583
+ └── docs/ # Documentation
584
+ ```
585
+
586
+ ## Best Practices
587
+
588
+ ### DO's ✅
589
+
590
+ - **USE** modern ES2022+ features
591
+ - **USE** async/await for asynchronous code
592
+ - **USE** strict equality (`===`) over loose equality (`==`)
593
+ - **VALIDATE** all inputs
594
+ - **HANDLE** errors explicitly
595
+ - **DOCUMENT** public APIs with JSDoc
596
+ - **TEST** all code paths
597
+ - **KEEP** dependencies minimal and updated
598
+
599
+ ### DON'Ts ❌
600
+
601
+ - **NEVER** use `var` (use `const` or `let`)
602
+ - **NEVER** use `==` (use `===`)
603
+ - **NEVER** swallow errors silently
604
+ - **NEVER** commit `node_modules/`
605
+ - **NEVER** commit `.env` files
606
+ - **NEVER** use deprecated packages
607
+ - **NEVER** skip tests
608
+ - **NEVER** commit console.log debugging code
609
+
610
+ ## Security
611
+
612
+ - Never commit secrets or API keys
613
+ - Use environment variables for sensitive data
614
+ - Run `npm audit` regularly
615
+ - Keep dependencies updated
616
+ - Use `.env` files (add to `.gitignore`)
617
+
618
+ Example `.env`:
619
+ ```bash
620
+ API_KEY=your-secret-key
621
+ DATABASE_URL=postgres://localhost/db
622
+ ```
623
+
624
+ Load with:
625
+ ```javascript
626
+ import 'dotenv/config';
627
+
628
+ const apiKey = process.env.API_KEY;
629
+ ```
630
+
631
+ <!-- JAVASCRIPT:END -->