energy-state-analyzer 0.17.0 → 0.18.0

package/CHANGELOG.md

@@ -1,8 +1,11 @@
 ---
-last_commit_released: d3b62b03378b0ef2e9b31391515866e9c0a602d9
+last_commit_released: 9cff149fd78949a772a402cc26bb4c29cf6857fe
 name: energy-state-analyzer
 updaters:
   - command: npm version {version} --no-git-tag-version --allow-same-version
+  - regex:
+      file: src/Core/ReportSarif.fs
+      pattern: (?<=let private toolVersion = ").*(?=")
 ---
 
 # Change Log
@@ -11,6 +14,30 @@ All notable changes to the "energy-state-analyzer" extension are generated by
 [EasyBuild.ShipIt](https://github.com/easybuild-org/EasyBuild.ShipIt) from
 [Conventional Commits](https://www.conventionalcommits.org/).
 
+## 0.18.0 - 2026-09-14
+
+### 🚀 Features
+
+* Separate broad protected scope, recovery dominance, and oversized recovery blocks (#142) ([26564a3](https://github.com/cardamomcode/energy-state-analyzer/commit/26564a3e89d15fbe2abc0f4caf200fe48fb7392b))
+
+### 🐞 Bug Fixes
+
+* Make inversion feedback respect control flow (#136) ([271676f](https://github.com/cardamomcode/energy-state-analyzer/commit/271676f2043dd7fbc8c9ff593e859dd6c6b1c5da))
+* Clarify energy-state model and report interpretation (#140) ([f2c9ae6](https://github.com/cardamomcode/energy-state-analyzer/commit/f2c9ae6879f76220d72b9a72b5afc53b142a6ca2))
+* Report tool version in SARIF output (#141) ([ad611cf](https://github.com/cardamomcode/energy-state-analyzer/commit/ad611cf7f7d24b6f9daeb9e8bfb8413b585b6a40))
+* Ordinal StartsWith comparison + watch task matcher (#145) ([9cff149](https://github.com/cardamomcode/energy-state-analyzer/commit/9cff149fd78949a772a402cc26bb4c29cf6857fe))
+
+<strong><small>[View changes on Github](https://github.com/cardamomcode/energy-state-analyzer/compare/94105c06c3a96d2ab1bce15729fb26a64da92154..9cff149fd78949a772a402cc26bb4c29cf6857fe)</small></strong>
+
+## 0.17.1 - 2026-09-13
+
+### 🐞 Bug Fixes
+
+* Align cognitive complexity scoring with documented rules (#132) ([7b28561](https://github.com/cardamomcode/energy-state-analyzer/commit/7b285618630793b753c660887fc8078b9d784fb7))
+* Use explicit StringComparison overload in C# adapter (#134) ([94105c0](https://github.com/cardamomcode/energy-state-analyzer/commit/94105c06c3a96d2ab1bce15729fb26a64da92154))
+
+<strong><small>[View changes on Github](https://github.com/cardamomcode/energy-state-analyzer/compare/d3b62b03378b0ef2e9b31391515866e9c0a602d9..94105c06c3a96d2ab1bce15729fb26a64da92154)</small></strong>
+
 ## 0.17.0 - 2026-09-13
 
 ### 🚀 Features

package/README.md

@@ -15,7 +15,9 @@ Real-time analysis of the active Python, F#, TypeScript, Kotlin, C++, or C# file
 - [Magic numbers](docs/detectors/magic-numbers.md), unnamed numeric literals.
 - [Magic strings](docs/detectors/magic-strings.md), unnamed string literals at decision points.
 - [Parameter explosion](docs/detectors/parameter-explosion.md), functions with too many parameters.
-- [Error shadowing](docs/detectors/error-shadowing.md), error handling that overwhelms a function's happy path.
+- [Broad Protected Scope](docs/detectors/error-shadowing.md), overly broad protected try bodies.
+- [Recovery Dominance](docs/detectors/recovery-dominance.md), recovery policy that dominates a function.
+- [Oversized Recovery Block](docs/detectors/oversized-recovery-block.md), individual handlers or cleanup bodies exceeding their line limit.
 - [Inversion opportunities](docs/detectors/inversion-opportunities.md), nested conditionals that could be guard clauses.
 - [Primitive obsession](docs/detectors/primitive-obsession.md), strings/numbers standing in for a real type.
 - [Match opportunities](docs/detectors/match-opportunities.md), if/elif chains that could be a match/switch.
@@ -33,17 +35,28 @@ For functions flagged as too complex (cyclomatic or cognitive), a progressive he
 
 ## Energy and Entropy
 
-The name is a deliberate analogy to thermodynamics: a function's "energy" is its complexity, nesting, and parameter count, while its "entropy" is how many ways it can be called, misunderstood, or silently broken by a change. Primitive obsession raises entropy too: broad, interchangeable strings and numbers admit invalid calls and swaps, and force the reader to retain conventions that distinct, validated domain types could express. See [docs/energy-and-entropy.md](docs/energy-and-entropy.md) for the full explanation of why cyclomatic and cognitive complexity are tracked as separate metrics rather than one score.
+The energy-state model asks which possibilities a maintainer must distinguish, what knowledge
+they need, and how relationships in a design allow a change to have unintended consequences.
+The analyzer highlights selected signs of that work: branching, nesting, broad signatures,
+implicit meanings, and dependency breadth. These are related signals, not interchangeable
+quantities on a common scale, and source code has no thermodynamic unit.
+
+Use findings to remove unnecessary possibilities, preserve domain knowledge, and keep
+change local. Severity communicates the seriousness of the detected readability and
+maintainability risks under the configured rules. Fix valid findings and document legitimate
+exceptions; verify that each change improves the code rather than merely lowering a score. See
+[Energy and Entropy](docs/energy-and-entropy.md) for the model, the maintainer's role in
+interpreting code, and what the metrics reveal.
 
 ## Command-Line Usage
 
-The same detectors also run headlessly, without VS Code, useful for CI or for an AI coding agent that wants to check the complexity of code it just generated and keep refactoring until it's clean:
+The same detectors also run headlessly, without VS Code, useful for CI or for an AI coding agent fixing findings in code it just generated and verifying the result:
 
 ```bash
 npx energy-state-analyzer path/to/file.py   # or .fs / .fsx / .ts / .kt / .cpp / .cs
 ```
 
-See [docs/cli.md](docs/cli.md) for scanning a whole repo, aggregated markdown/JSON/human reports, and diffing a PR against a base branch.
+See [docs/cli.md](docs/cli.md) for scanning a whole repo, aggregated markdown/JSON/human reports, and diffing a PR against a base branch. See [docs/agent-integration.md](docs/agent-integration.md) for wiring the CLI into an AI coding agent's edit-and-verify loop.
 
 ## Requirements
 
@@ -85,7 +98,9 @@ Every detector has an `enabled` toggle, plus the magic-number/string switches an
 - `energyStateAnalyzer.opaqueBoolean.enabled` (`true`)
 - `energyStateAnalyzer.logicalControlFlow.enabled` (`true`)
 - `energyStateAnalyzer.inversion.enabled` (`true`)
-- `energyStateAnalyzer.errorShadowing.enabled` (`true`)
+- `energyStateAnalyzer.errorShadowing.enabled` (`true`, family switch)
+- `energyStateAnalyzer.recoveryDominance.enabled` (`true`)
+- `energyStateAnalyzer.oversizedRecoveryBlock.enabled` (`true`)
 - `energyStateAnalyzer.magicNumber.enabled` (`true`)
 - `energyStateAnalyzer.magicString.enabled` (`true`)
 - `energyStateAnalyzer.colors.highEnergy` / `.mediumEnergy` / `.lowEnergy` (`#fb8500` / `#ffb703` / `#99dd99`)
@@ -102,6 +117,7 @@ Set thresholds, ratios, and magic-number/string allowlists in an `.esaconfig.jso
 - `parameterCount.mediumThreshold` / `highThreshold` (`5` / `8`)
 - `errorShadowing.protectedScope.*` (`threshold` / `highThreshold` / `minItems`: `0.5` / `0.7` / `8`)
 - `errorShadowing.recovery.*` (`threshold` / `highThreshold` / `minItems`: `0.5` / `0.7` / `5`)
+- `errorShadowing.recoveryBlock.maxLines` (`20`)
 - `magicNumber.allowlist` (`[0, 1, -1, 2]`)
 - `magicString.minDuplicates` (`2`), `allowlist` (`["", "utf-8", "__main__"]`)