PSComplexity.psd1
|
@{ RootModule = 'PSComplexity.psm1' ModuleVersion = '0.4.0' GUID = '961aa886-4f8e-40c0-9d25-68fd4c52e69f' Author = 'Fortigi' CompanyName = 'Fortigi' Copyright = '(c) Fortigi. MIT licensed.' Description = 'Cyclomatic and cognitive complexity for PowerShell. Cognitive complexity implements the SonarSource metric in full (nesting-aware -- the better signal for "hard to understand"), scoring every reference example exactly as published, and extends it for PowerShell constructs the specification does not cover: ForEach-Object and Where-Object, the && and || pipeline chains, and ?? and ??=. Measures per unit (function/filter, class method/constructor, initialised class property, + script body) via the PowerShell AST; ships a Test-PSComplexity gate for CI.' PowerShellVersion = '7.2' CompatiblePSEditions = @('Core') FunctionsToExport = @('Measure-PSComplexity', 'Test-PSComplexity') CmdletsToExport = @() VariablesToExport = @() AliasesToExport = @() PrivateData = @{ PSData = @{ Tags = @('complexity', 'cyclomatic', 'cognitive', 'code-quality', 'ast', 'metrics', 'maintainability', 'lint', 'ci') LicenseUri = 'https://github.com/Fortigi/PSComplexity/blob/main/LICENSE' ProjectUri = 'https://github.com/Fortigi/PSComplexity' ReleaseNotes = '0.4.0: **The gate can now be scoped to what a pull request changed.** `-ChangedFile` restricts a run to units in the files you name, so the verdict stops being dominated by code the author did not write -- which is how thresholds get raised until they stop meaning anything. With `-BaselineFile` it covers both halves: the baseline stops old code degrading, the diff scope stops new code arriving over the line. You decide what changed, and there is deliberately no `-ChangedSince <ref>`: a diff needs a base, and every way that goes wrong -- a shallow clone, a ref never fetched, a merge base that is not what the reviewer sees -- goes wrong in your environment, where you can fix it. Run `git diff --name-only` yourself and pass the result. An **empty** list is refused, because that is what a diff command prints when it fails, and taken at face value it is a confident pass over zero units. A run whose changed files hold no PowerShell passes instead, and says so: a filtered run warns that it measured a subset, and the JSON report records `scope.changedFile` -- `null` for a whole-tree run, an array for a filtered one. **The gate is now adoptable on a codebase that is already over the line.** `-BaselineFile` records what each already-breaching unit scored, in a committed JSON file. A unit in the baseline may not exceed its recorded score; a unit not in it must be under the ceilings, so new and touched code meets the real bar from day one. The answer to "we have forty violations" stops being "raise the threshold", which gates nothing. It is a ratchet rather than a suppression list, and it only ratchets **down**. `-UpdateBaseline` refuses to record a unit worse than the file already does -- otherwise re-running the tool would absorb whatever regression the gate had just caught. An entry that stops describing the run fails it: the unit was renamed away, it came back within both ceilings, it is also in `-Accept`, it appears twice, or it improved and the recorded number is now larger than reality. Entries are keyed by file and unit, never by line. A unit whose name carries an ordinal -- `Get-Thing#2`, how duplicate definitions in one file are told apart -- is refused outright, because the ordinal renumbers when a duplicate is inserted above it and the entry would silently begin capping a different function. BEHAVIOUR CHANGE -- two published values change shape, and anything that stored them will not match. Read this before upgrading a pipeline that keeps records. `Unit` and `File` were neither unique within a file nor stable across machines, and both are fixed together because a half-fixed identity is still not one. **`Unit` is now qualified and disambiguated.** A function nested in another reads `Get-OuterA/Get-Inner` rather than `Get-Inner` -- two such units in one file used to be indistinguishable, and they score differently. Two units sharing a name in the same scope -- overloads, or a function defined twice -- get an ordinal on **every** member of the group: `Repo.Add#1`, `Repo.Add#2`. Both, not just the second, because suffixing only the later one would silently rename the first the day an overload is added. Class members were already qualified; this extends the same rule to the half that lacked it. **`File` is now relative to the working directory, with forward slashes.** It was absolute and platform-separated, so identical source measured on two CI legs produced disjoint key sets -- `C:\...\src\A.ps1` against `/home/.../src/A.ps1` -- and anything comparing runs across them matched nothing while appearing to work. A file outside the root keeps its full path, because a `../../` chain is no more portable and says less. The README had rendered this relative all along. If you have a stored baseline, it will not match after upgrading. That is the point: the keys it holds could not distinguish units the tool could. Full changelog: https://github.com/Fortigi/PSComplexity/blob/main/CHANGELOG.md' } } } |