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