sqlew 3.2.2 → 3.2.3

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.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,41 @@ All notable changes to sqlew will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [3.2.3] - 2025-10-20
9
+
10
+ ### Changed
11
+ - **Code Organization - Major Refactoring**
12
+ - Reduced `src/index.ts` from 1,534 lines to 525 lines (66% reduction)
13
+ - Extracted 1,009 lines of help/example documentation to respective tool files
14
+ - Moved help/example functions to 7 tool files: `context.ts`, `messaging.ts`, `files.ts`, `constraints.ts`, `utils.ts`, `config.ts`, `tasks.ts`
15
+ - Improved maintainability: Help/example documentation now co-located with tool implementations
16
+ - Zero API changes: All 14 help/example actions remain fully backward compatible
17
+
18
+ - **File Watcher Documentation Updates**
19
+ - Corrected token savings claims: Changed "97% token reduction" to "save 300 tokens per file compared to registering watchers manually"
20
+ - Updated claims in 5 locations across `taskHelp()` and `taskExample()` functions
21
+ - Added best practice recommendation: "Except in exceptional cases, it is recommended to set up file watchers for all tasks that involve code changes"
22
+ - Clarified automatic file watching benefits with accurate token efficiency metrics
23
+
24
+ - **Package Description Update**
25
+ - Updated description from "97% token reduction" to "96% token efficiency through API consolidation"
26
+ - More accurately reflects the token savings from v2.0 action-based API consolidation
27
+
28
+ ### Technical Details
29
+ - **Files Modified:**
30
+ - `src/index.ts`: Simplified to pure routing logic (525 lines)
31
+ - `src/tools/context.ts`: Added `decisionHelp()`, `decisionExample()` (+217 lines)
32
+ - `src/tools/messaging.ts`: Added `messageHelp()`, `messageExample()` (+136 lines)
33
+ - `src/tools/files.ts`: Added `fileHelp()`, `fileExample()` (+127 lines)
34
+ - `src/tools/constraints.ts`: Added `constraintHelp()`, `constraintExample()` (+169 lines)
35
+ - `src/tools/utils.ts`: Added `statsHelp()`, `statsExample()` (+137 lines)
36
+ - `src/tools/config.ts`: Added `configHelp()`, `configExample()` (+107 lines)
37
+ - `src/tools/tasks.ts`: Added `taskExample()` (+200 lines, `taskHelp()` already existed)
38
+
39
+ - **Pattern Applied:** Extract inline switch case blocks to exported functions in tool files
40
+ - **Backward Compatibility:** 100% maintained - all existing MCP tool calls work identically
41
+ - **Build:** TypeScript compilation successful with zero errors
42
+
8
43
  ## [3.2.2] - 2025-10-18
9
44
 
10
45
  ### Added
package/README.md CHANGED
@@ -209,6 +209,9 @@ Each tool supports `action: "help"` for full documentation and `action: "example
209
209
  - 🔗 **[Task Linking](docs/TASK_LINKING.md)** - Link tasks to decisions/constraints/files/tasks (900+ lines, ~23k tokens)
210
210
  - 🔄 **[Task Migration](docs/TASK_MIGRATION.md)** - Migrate from decision-based tracking (701 lines, ~18k tokens)
211
211
 
212
+ **Decision Context (v3.2.2):**
213
+ - 📝 **[Decision Context](docs/DECISION_CONTEXT.md)** - Rich decision documentation with rationale, alternatives, and tradeoffs (500+ lines, ~15k tokens) **NEW v3.2.2**
214
+
212
215
  **Auto File Tracking (v3.0.2):**
213
216
  - 🤖 **[Auto File Tracking](docs/AUTO_FILE_TRACKING.md)** - Zero-token task management, setup, troubleshooting
214
217
  - ✅ **[Acceptance Criteria](docs/ACCEPTANCE_CRITERIA.md)** - All check types (tests_pass, code_removed, code_contains, file_exists)
@@ -267,6 +270,48 @@ Each tool supports `action: "help"` for full documentation and `action: "example
267
270
  }
268
271
  ```
269
272
 
273
+ ### Decision Context (v3.2.2)
274
+
275
+ ```javascript
276
+ // Record a decision with rich context
277
+ {
278
+ action: "set",
279
+ key: "database_choice",
280
+ value: "PostgreSQL over MongoDB",
281
+ layer: "data",
282
+ tags: ["architecture", "database"]
283
+ }
284
+
285
+ // Add rationale and tradeoffs
286
+ {
287
+ action: "add_decision_context",
288
+ key: "database_choice",
289
+ rationale: "Selected PostgreSQL because: (1) Complex relational queries required for reporting, (2) ACID compliance critical for financial data, (3) Team has strong SQL expertise",
290
+ alternatives_considered: [
291
+ {
292
+ option: "MongoDB",
293
+ reason: "Rejected due to weak consistency guarantees for financial data"
294
+ },
295
+ {
296
+ option: "MySQL",
297
+ reason: "Rejected due to limited JSON support needed for metadata"
298
+ }
299
+ ],
300
+ tradeoffs: {
301
+ pros: ["Strong consistency", "Complex queries", "Team expertise"],
302
+ cons: ["Less flexible schema", "Vertical scaling limitations"]
303
+ }
304
+ }
305
+
306
+ // Retrieve decision with full context
307
+ {
308
+ action: "get",
309
+ key: "database_choice",
310
+ include_context: true
311
+ }
312
+ // → Returns decision + rationale + alternatives + tradeoffs
313
+ ```
314
+
270
315
  ### Session Continuity
271
316
 
272
317
  ```javascript
@@ -310,7 +355,7 @@ on [GitHub Sponsors](https://github.com/sponsors/sin5ddd)
310
355
 
311
356
  ## Version
312
357
 
313
- Current version: **3.0.0**
358
+ Current version: **3.2.2**
314
359
  See [CHANGELOG.md](CHANGELOG.md) for release history.
315
360
 
316
361
  ## License