energy-state-analyzer 0.14.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -1
- package/README.md +4 -1
- package/dist/cli.js +1 -1
- package/docs/cli.md +3 -1
- package/docs/detectors/README.md +17 -16
- package/docs/detectors/magic-values.md +7 -0
- package/docs/energy-and-entropy.md +3 -1
- package/package.json +9 -2
- package/docs/fable-rewrite-plan.md +0 -101
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
last_commit_released:
|
|
2
|
+
last_commit_released: b685a15415160c1ff9dcf6f0505b19a70e52db2b
|
|
3
3
|
name: energy-state-analyzer
|
|
4
4
|
updaters:
|
|
5
5
|
- command: npm version {version} --no-git-tag-version --allow-same-version
|
|
@@ -11,6 +11,21 @@ All notable changes to the "energy-state-analyzer" extension are generated by
|
|
|
11
11
|
[EasyBuild.ShipIt](https://github.com/easybuild-org/EasyBuild.ShipIt) from
|
|
12
12
|
[Conventional Commits](https://www.conventionalcommits.org/).
|
|
13
13
|
|
|
14
|
+
## 0.15.0 - 2026-09-06
|
|
15
|
+
|
|
16
|
+
### 🚀 Features
|
|
17
|
+
|
|
18
|
+
* *(sarif)* Add stable IDs and VS Code export (#99) ([97049bf](https://github.com/cardamomcode/energy-state-analyzer/commit/97049bf1a498da8b4917d009d7849b085b7645a4))
|
|
19
|
+
|
|
20
|
+
### 🐞 Bug Fixes
|
|
21
|
+
|
|
22
|
+
* Prefix command titles with plugin name (#102) ([e25eb9a](https://github.com/cardamomcode/energy-state-analyzer/commit/e25eb9a009e5c70e6174ffc589fb413512694101))
|
|
23
|
+
* Specify report URI suffix comparison (#104) ([da8d22f](https://github.com/cardamomcode/energy-state-analyzer/commit/da8d22fede5b4103ff478c9c4d3b0a971a6f408d))
|
|
24
|
+
* *(ci)* Correct security-events permission key (#103) ([181b310](https://github.com/cardamomcode/energy-state-analyzer/commit/181b310cc32dfd865147b861962583022e1dd6c9))
|
|
25
|
+
* *(sarif)* Link rules to detector guides (#101) ([4087dee](https://github.com/cardamomcode/energy-state-analyzer/commit/4087deeab082a4890abd28aed9233369be0b24de))
|
|
26
|
+
|
|
27
|
+
<strong><small>[View changes on Github](https://github.com/cardamomcode/energy-state-analyzer/compare/eec025fc61c7d60083567d605817aa38ba64d314..b685a15415160c1ff9dcf6f0505b19a70e52db2b)</small></strong>
|
|
28
|
+
|
|
14
29
|
## 0.14.0 - 2026-09-06
|
|
15
30
|
|
|
16
31
|
### 🚀 Features
|
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Visualizes "energy states" in Python, F#, TypeScript, Kotlin, and C++ code as you edit: parts of a file that are complex, deeply nested, or otherwise harder to understand and maintain get highlighted with colored gutter icons, inline decorations, and entries in the Problems panel.
|
|
4
4
|
|
|
5
|
+

|
|
6
|
+
|
|
5
7
|
## Features
|
|
6
8
|
|
|
7
9
|
Real-time analysis of the active Python, F#, TypeScript, Kotlin, or C++ file, re-run on every edit and on editor focus change, via these detectors (see [docs/detectors](docs/detectors/README.md) for full detail on each):
|
|
@@ -30,7 +32,7 @@ For functions flagged as too complex (cyclomatic or cognitive), a progressive he
|
|
|
30
32
|
|
|
31
33
|
## Energy and Entropy
|
|
32
34
|
|
|
33
|
-
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
|
|
35
|
+
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.
|
|
34
36
|
|
|
35
37
|
## Command-Line Usage
|
|
36
38
|
|
|
@@ -109,6 +111,7 @@ To exclude files/folders (e.g. test fixtures, generated code) from both the exte
|
|
|
109
111
|
## Commands
|
|
110
112
|
|
|
111
113
|
- **Energy State Analyzer: Analyze Energy State** (`energy-state-analyzer.analyze`), manually re-run analysis on the active editor.
|
|
114
|
+
- **Energy State Analyzer: Export SARIF Report** (`energy-state-analyzer.exportSarif`), scan the workspace and write `.energy-state/latest.sarif` for SARIF-compatible tools.
|
|
112
115
|
|
|
113
116
|
## Known Issues
|
|
114
117
|
|