flagrm 0.1.0 → 0.2.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 +103 -1
- package/LICENSE +202 -21
- package/NOTICE +5 -0
- package/README.md +110 -65
- package/dist/adapters/dotnet/flow.js +429 -0
- package/dist/adapters/dotnet/index.js +2 -0
- package/dist/adapters/dotnet/setup.js +163 -0
- package/dist/cli.js +97 -19
- package/dist/core/baseline.js +140 -20
- package/dist/core/config-snapshot.js +183 -0
- package/dist/core/config.js +22 -1
- package/dist/core/doctor.js +37 -17
- package/dist/core/environment.js +79 -0
- package/dist/core/flag-words.js +36 -0
- package/dist/core/git.js +8 -0
- package/dist/core/hook.js +18 -8
- package/dist/core/install.js +128 -22
- package/dist/core/inventory.js +39 -0
- package/dist/core/markdown.js +16 -5
- package/dist/core/report.js +54 -11
- package/dist/core/scope.js +192 -0
- package/dist/core/tools.js +108 -0
- package/dist/core/types.js +7 -1
- package/dist/core/util.js +10 -0
- package/dist/core/verify/commands.js +127 -19
- package/dist/core/verify/context.js +9 -0
- package/dist/core/verify/deleted-text.js +180 -0
- package/dist/core/verify/index.js +3 -1
- package/dist/core/verify/leftovers.js +19 -2
- package/dist/core/verify/removed-tests.js +141 -0
- package/dist/core/verify/test-results.js +31 -6
- package/package.json +4 -3
- package/skills/flagrm-remove/SKILL.md +14 -14
package/CHANGELOG.md
CHANGED
|
@@ -5,7 +5,107 @@ All notable changes to this project are documented here. The format follows
|
|
|
5
5
|
[Semantic Versioning](https://semver.org/). Before 1.0, a minor version may
|
|
6
6
|
contain breaking changes.
|
|
7
7
|
|
|
8
|
-
## [0.
|
|
8
|
+
## [0.2.0] - 2026-10-04
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- **Breaking:** JSON schema version 7. `baseline --json` prints a summary of
|
|
13
|
+
`baseline.json` instead of the whole file: each test run's results as
|
|
14
|
+
counts with at most 20 short failed test names (`failedTests`,
|
|
15
|
+
`moreFailedTests`), and no `config` snapshot. On a large suite the full
|
|
16
|
+
output was megabytes. `baseline.json` is unchanged, and version 6 files are
|
|
17
|
+
still read.
|
|
18
|
+
- The Stop hook only blocks once the removal has edited a file git tracks
|
|
19
|
+
(other than `flagrm.config.yaml`), or the last verify used `--skip`. A
|
|
20
|
+
removal paused on a question to the user, a config fix or an untracked
|
|
21
|
+
file such as a stray test result no longer blocks.
|
|
22
|
+
- `verify`'s `tests[]` reports `failed` and the short names of `newFailures`
|
|
23
|
+
and `knownFailures` per project.
|
|
24
|
+
- `verify` no longer fails the `tests` check when every failing test already
|
|
25
|
+
failed at the baseline: those are reported as known failures and only warn.
|
|
26
|
+
Only new failures fail it, and they are listed. Test names are compared
|
|
27
|
+
without xUnit data-row arguments. Needs `testResults`.
|
|
28
|
+
- `baseline --force` refuses to replace a baseline once the code has changed
|
|
29
|
+
since its commit (`.flagrm/`, `flagrm.config.yaml` and files matching
|
|
30
|
+
`testResults` don't count), so a
|
|
31
|
+
rerun after fixing the setup can't record a half-done removal. The error
|
|
32
|
+
says how to set uncommitted edits aside with `git stash`.
|
|
33
|
+
- Tests that no longer run are sorted by why (`tests[]` in `verify --json`):
|
|
34
|
+
`deleted` (gone from a changed test file, or a data row dropped from one),
|
|
35
|
+
`renamed` (the same test without the flag's words in its name, matched to
|
|
36
|
+
the new test), `excludedByConfig` (the test command or its files changed
|
|
37
|
+
since the baseline) and `unexplained`. Only `unexplained` tests warn; the
|
|
38
|
+
summary counts the others, and `--md` lists each group.
|
|
39
|
+
|
|
40
|
+
### Added
|
|
41
|
+
|
|
42
|
+
- `flagrm init` asks which AI coding tools to set up (Claude Code, GitHub
|
|
43
|
+
Copilot, Codex), pre-selecting the ones the repository already uses
|
|
44
|
+
(`.claude/`, `.github/copilot-instructions.md` or skills, `AGENTS.md`), and
|
|
45
|
+
installs only their files. `--tool claude-code,codex` chooses without
|
|
46
|
+
asking; without a terminal, the detected tools (all when none) are set up.
|
|
47
|
+
The choice is saved as `tools:` in `flagrm.config.yaml`, which a later
|
|
48
|
+
`init` and `update` follow; files of a tool dropped from it are left in
|
|
49
|
+
place and named. Copilot also gets `/flagrm-remove` and `/flagrm-verify`
|
|
50
|
+
prompt files in `.github/prompts/`. `doctor` checks only those tools.
|
|
51
|
+
- `flagrm scope`: for each .NET project, checks the machine (the SDK
|
|
52
|
+
`global.json` asks for, with `rollForward`; `cargo` where a project's build
|
|
53
|
+
runs it; Docker where a test project uses Testcontainers) and shows which
|
|
54
|
+
projects a solution filter would leave out: those and every project that
|
|
55
|
+
references them. `--write` creates `flagrm.slnf`, adds it to
|
|
56
|
+
`.git/info/exclude` and points the project's build and test at it, editing
|
|
57
|
+
`flagrm.config.yaml` in place. When the commands already name a solution
|
|
58
|
+
filter, `flagrm.slnf` keeps only its projects; a command that names a
|
|
59
|
+
project file is left alone. `doctor` (and so `init`) reports the same
|
|
60
|
+
problems: a missing SDK fails, a missing `cargo` or Docker warns.
|
|
61
|
+
- README: leave a locale-dependent test out with `--filter` rather than
|
|
62
|
+
forcing `LC_ALL` for the whole run.
|
|
63
|
+
- `verify` warns in `leftovers` about tests of the OFF path that never name
|
|
64
|
+
the flag: a test that still checks a string literal the removal deleted
|
|
65
|
+
from the code (and that no other code still has). When a test checked the
|
|
66
|
+
deleted text but none checks the text kept on the same line, it warns
|
|
67
|
+
that the ON path lost its test coverage.
|
|
68
|
+
- .NET discovery follows a flag's value: bool locals, fields and properties
|
|
69
|
+
assigned `IsEnabled(<flag>)`, methods that only return it (or a ternary on
|
|
70
|
+
it; static ones as `Class.Method`), and the bool parameters it is passed
|
|
71
|
+
to. `flagrm list` shows them as `flow`; `baseline` records as wrappers the
|
|
72
|
+
ones that clearly name the flag and lists the rest as `suggestedNames`. A
|
|
73
|
+
local, parameter or field (recorded with `file`) is only checked in its own
|
|
74
|
+
file; a method or property must contain the flag's whole name, or a flag
|
|
75
|
+
word with a digit. A parameter of one of several same-named methods, or a
|
|
76
|
+
method whose name another method shares, is only suggested. Test calls
|
|
77
|
+
passing `true`/`false` for such a parameter are listed as
|
|
78
|
+
`parameterizedTests`.
|
|
79
|
+
- `baseline --name X --file <path>` records `X` as a wrapper checked only in
|
|
80
|
+
that file.
|
|
81
|
+
- The baseline records its configuration (`config` in `baseline.json`): each
|
|
82
|
+
project's resolved build and test commands with a hash of the files they
|
|
83
|
+
name (`.slnf`, `.runsettings`, filter lists; not `.sln`/`.csproj`),
|
|
84
|
+
`testResults`, and the text of `flagrm.config.yaml`. `verify` warns when
|
|
85
|
+
they changed since: a command or named file in `build`/`tests`, any other
|
|
86
|
+
config change in `leftovers` with the changed lines.
|
|
87
|
+
- A failed build or test run whose log shows a machine setup problem gets
|
|
88
|
+
`failure: { kind: "environment", message }` in `baseline.json` and the
|
|
89
|
+
`verify`/`doctor` output: a .NET SDK that doesn't match `global.json`
|
|
90
|
+
(requested vs installed versions), a command a build step couldn't find
|
|
91
|
+
(and the project that runs it), or Docker not running for Testcontainers.
|
|
92
|
+
|
|
93
|
+
### Fixed
|
|
94
|
+
|
|
95
|
+
- Two projects whose `testResults` patterns overlap (`./**/TestResults/*.trx`)
|
|
96
|
+
no longer count each other's result files when their test runs follow each
|
|
97
|
+
other. Result files from earlier runs were already ignored.
|
|
98
|
+
|
|
99
|
+
## [0.1.1] - 2026-10-01
|
|
100
|
+
|
|
101
|
+
### Changed
|
|
102
|
+
|
|
103
|
+
- The license is now the Apache License 2.0, with attribution in `NOTICE`.
|
|
104
|
+
Version 0.1.0 was published under the MIT License and stays available under
|
|
105
|
+
it.
|
|
106
|
+
- The README no longer cites benchmark results, and its wording is tightened.
|
|
107
|
+
|
|
108
|
+
## [0.1.0] - 2026-10-01
|
|
9
109
|
|
|
10
110
|
Initial release.
|
|
11
111
|
|
|
@@ -35,4 +135,6 @@ removes the flag through the `flagrm-remove` skill, and flagrm checks the result
|
|
|
35
135
|
`doctor` warns about an incremental `dotnet build`, which hides existing
|
|
36
136
|
warnings from the dead-code comparison.
|
|
37
137
|
|
|
138
|
+
[0.2.0]: https://github.com/dino-cosic/flagrm/releases/tag/v0.2.0
|
|
139
|
+
[0.1.1]: https://github.com/dino-cosic/flagrm/releases/tag/v0.1.1
|
|
38
140
|
[0.1.0]: https://github.com/dino-cosic/flagrm/releases/tag/v0.1.0
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,22 +1,25 @@
|
|
|
1
1
|
# flagrm
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
result: a baseline taken before the edit, and a `verify` gate that fails while
|
|
6
|
-
the flag is still referenced, the build breaks, a test regresses, or the
|
|
7
|
-
removal left unused code behind.
|
|
3
|
+
[](https://github.com/dino-cosic/flagrm/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/flagrm)
|
|
8
5
|
|
|
9
|
-
|
|
10
|
-
wrappers, removing the OFF path, refactoring methods the flag was passed
|
|
11
|
-
into). flagrm decides when it's done.
|
|
6
|
+
Remove feature flags with your AI coding agent, safely.
|
|
12
7
|
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
flagrm gives Claude Code, GitHub Copilot and Codex a flag-removal skill and the
|
|
9
|
+
guardrails to check the result. It records a baseline before the edit, then
|
|
10
|
+
gates the removal with `flagrm verify`, which fails while the flag is still
|
|
11
|
+
referenced, the build breaks, a test regresses, or the removal leaves unused
|
|
12
|
+
code behind.
|
|
15
13
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
14
|
+
The agent does the reasoning and the edits: finding the flag, its aliases and
|
|
15
|
+
wrappers, removing the OFF path, and refactoring methods the flag was passed
|
|
16
|
+
into. flagrm decides when the work is done.
|
|
17
|
+
|
|
18
|
+
Angular and .NET projects work out of the box. Any other stack works through the
|
|
19
|
+
generic adapter.
|
|
20
|
+
|
|
21
|
+
> **Status:** flagrm is at version 0.1. Until 1.0, a minor release may contain
|
|
22
|
+
> breaking changes.
|
|
20
23
|
|
|
21
24
|
## Requirements
|
|
22
25
|
|
|
@@ -25,32 +28,33 @@ $1.50 per flag, with `flagrm verify` passing on an independent rerun.
|
|
|
25
28
|
- An AI coding agent that reads skills: Claude Code, GitHub Copilot or Codex
|
|
26
29
|
(the Stop hook is Claude Code only)
|
|
27
30
|
|
|
28
|
-
On Windows, the Stop hook runs in Git Bash, or in PowerShell when Git Bash
|
|
29
|
-
|
|
30
|
-
scripts (`Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`)
|
|
31
|
-
hook fails and
|
|
31
|
+
On Windows, the Stop hook runs in Git Bash, or in PowerShell when Git Bash is
|
|
32
|
+
not installed. In PowerShell, `npx` needs an execution policy that allows
|
|
33
|
+
scripts (`Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`). Otherwise the
|
|
34
|
+
hook fails and does not guard the removal. `flagrm verify` still works.
|
|
32
35
|
|
|
33
36
|
## Quick start
|
|
34
37
|
|
|
35
38
|
```sh
|
|
36
39
|
npm install -D flagrm # or run everything with npx flagrm
|
|
37
|
-
npx flagrm init # config, skills, Stop hook, .gitignore entry
|
|
40
|
+
npx flagrm init # asks which AI tools; config, skills, Stop hook, .gitignore entry
|
|
38
41
|
```
|
|
39
42
|
|
|
40
|
-
Fill in the project paths and build
|
|
41
|
-
the setup with `npx flagrm doctor`, then ask your
|
|
43
|
+
Fill in the project paths and the build and test commands in
|
|
44
|
+
`flagrm.config.yaml`, check the setup with `npx flagrm doctor`, then ask your
|
|
45
|
+
agent:
|
|
42
46
|
|
|
43
47
|
```
|
|
44
48
|
/flagrm-remove NewCheckout
|
|
45
49
|
```
|
|
46
50
|
|
|
47
|
-
When
|
|
51
|
+
When the agent reports back, review the result:
|
|
48
52
|
|
|
49
53
|
```
|
|
50
54
|
/flagrm-verify NewCheckout
|
|
51
55
|
```
|
|
52
56
|
|
|
53
|
-
You get a short overview (checks, changed files, tests
|
|
57
|
+
You get a short overview (checks, changed files, tests deleted or renamed) and
|
|
54
58
|
a proposed commit message. The agent never commits for you. The overview looks
|
|
55
59
|
like this (abridged):
|
|
56
60
|
|
|
@@ -62,65 +66,85 @@ like this (abridged):
|
|
|
62
66
|
| leftovers | ✅ pass | no recorded name left in code or config |
|
|
63
67
|
| dead-code | ✅ pass | no new unused-code diagnostics |
|
|
64
68
|
| build | ✅ pass | web, api built successfully |
|
|
65
|
-
| tests |
|
|
69
|
+
| tests | ✅ pass | tests passed (web 24 → 22: 2 deleted, 1 renamed; api 18 → 16: 2 deleted) |
|
|
66
70
|
|
|
67
71
|
**Files changed since baseline (26):** `backend/src/Shop.Api/Services/CheckoutService.cs`, ...
|
|
68
72
|
|
|
69
|
-
**Tests
|
|
73
|
+
**Tests deleted (4):** `LegacyPricingCalculatorTests.AppliesBulkDiscount`, ...
|
|
74
|
+
|
|
75
|
+
**Tests renamed (1):** `CheckoutComponent › places the order when NewCheckout is on` → `CheckoutComponent › places the order`
|
|
70
76
|
```
|
|
71
77
|
|
|
72
|
-
|
|
73
|
-
|
|
78
|
+
Tests that no longer run are sorted by why: deleted in the diff (the OFF
|
|
79
|
+
path's tests), renamed without the flag in the name, or left out by a test
|
|
80
|
+
command changed since the baseline. Only a test that no longer runs for none
|
|
81
|
+
of these reasons is a warning, for the agent to explain in its notes.
|
|
74
82
|
|
|
75
83
|
## How it works
|
|
76
84
|
|
|
77
|
-
1. **`flagrm init`**
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
85
|
+
1. **`flagrm init`** asks which AI coding tools to set up (Claude Code,
|
|
86
|
+
GitHub Copilot, Codex), with the ones the repository already uses
|
|
87
|
+
pre-selected; `--tool claude-code,codex` answers without asking, and
|
|
88
|
+
without a terminal it takes the detected tools (all three when none is).
|
|
89
|
+
It writes `flagrm.config.yaml` for the Angular and .NET projects it finds,
|
|
90
|
+
with the choice as `tools:`, and adds `.flagrm/` to `.gitignore`. Then per
|
|
91
|
+
tool: for Claude Code the `flagrm-remove` and `flagrm-verify` skills in
|
|
92
|
+
`.claude/skills/` and a Stop hook in `.claude/settings.json`; for Copilot
|
|
93
|
+
the skills in `.github/skills/` and `/flagrm-remove` and `/flagrm-verify`
|
|
94
|
+
prompt files in `.github/prompts/`; for Codex the skills in
|
|
95
|
+
`.agents/skills/` and a pointer in `AGENTS.md`.
|
|
96
|
+
2. **`/flagrm-remove <flag>`**: the agent checks that the tree is clean and runs
|
|
97
|
+
`flagrm baseline <flag>`, which records the git commit, the build and test
|
|
98
|
+
results, and the flag's names. It finds every usage with its own search,
|
|
99
|
+
records wrappers and aliases with `flagrm baseline <flag> --name`, removes
|
|
100
|
+
the flag, and repeats `flagrm verify <flag>` until it passes.
|
|
87
101
|
3. **The Stop hook** (Claude Code) keeps the agent from finishing while a
|
|
88
|
-
removal is in progress
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
102
|
+
removal is in progress and not verified. In progress means a file git
|
|
103
|
+
tracks changed on top of the baseline commit (changes to
|
|
104
|
+
`flagrm.config.yaml` and untracked files don't count, so a removal paused
|
|
105
|
+
on a question to the user doesn't block), or the last verify used `--skip`.
|
|
106
|
+
4. **`/flagrm-verify <flag>`** runs `flagrm verify <flag> --md` and adds notes
|
|
107
|
+
and a commit message.
|
|
92
108
|
|
|
93
109
|
## Commands
|
|
94
110
|
|
|
95
111
|
| Command | What it does | Exit codes |
|
|
96
112
|
|---|---|---|
|
|
97
|
-
| `init` | Set up the config,
|
|
98
|
-
| `doctor` | Check config, build
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
113
|
+
| `init` | Set up the config and `.gitignore` entry, and each chosen AI tool's files (asks, or `--tool claude-code,copilot,codex`; saved as `tools:`). Never overwrites or deletes | 0, 2 usage error |
|
|
114
|
+
| `doctor` | Check the config, build and test commands (`--run` runs them), the .NET SDK `global.json` asks for, `cargo` and Docker where projects need them, git, `.gitignore`, installed skills and hook, and abandoned baselines | 0 ok, 1 problems |
|
|
115
|
+
| `scope` | For each .NET project, show what the machine lacks and which projects a solution filter would leave out; `--write` creates `flagrm.slnf`, adds it to `.git/info/exclude` and points the project's build and test at it | 0 nothing missing, 1 something missing |
|
|
116
|
+
| `update` | Refresh the installed skills, prompt files, `AGENTS.md` block and hook from this flagrm version, for the config's `tools:` | 0 |
|
|
117
|
+
| `list` | List every feature flag in the project: definitions, configured state per environment, reference counts | 0 |
|
|
118
|
+
| `baseline <flag>` | Before any edit, record the git commit, build and test results and the flag's names in `.flagrm/<flag>/baseline.json`. In .NET code the names include the locals, fields, parameters and methods the flag's value travels through when they name the flag (a local, parameter or field is checked only in its own file); generic or ambiguous ones are listed as `suggestedNames`, with `parameterizedTests` that pass the value as a literal. `--file` limits `--name` entries to one file (and records them as wrappers). `--name X --kind alias\|wrapper` adds names to an existing baseline; `--json` prints a summary (test counts, at most 20 failed test names; the file keeps everything); `--force` starts over, but only while the code is unedited since the baseline commit (changes to `flagrm.config.yaml` and `testResults` files are fine); `--no-checks` skips build and tests | 0, 2 usage error |
|
|
119
|
+
| `verify <flag>` | Gate the removal with `leftovers`, `dead-code`, `build` and `tests`. Writes `.flagrm/<flag>/verify.json`. `--md` prints the overview, `--json` the full result, `--skip` skips checks, `--strict` fails on warnings | 0 pass, 1 fail, 2 usage error |
|
|
103
120
|
| `hook stop` | The Claude Code Stop hook installed by `init` | always 0 |
|
|
104
121
|
|
|
105
|
-
`list`, `baseline` and `verify`
|
|
106
|
-
`--include
|
|
122
|
+
`list`, `baseline` and `verify` accept `--json`, `--config <path>`, and
|
|
123
|
+
`--include` / `--exclude <glob>`.
|
|
107
124
|
|
|
108
|
-
## What verify checks
|
|
125
|
+
## What `verify` checks
|
|
109
126
|
|
|
110
127
|
| Check | Fails when |
|
|
111
128
|
|---|---|
|
|
112
|
-
| `leftovers` | A recorded name (the flag literal, its constants, wrappers the agent recorded) is still in code or config. A mention in a comment is a warning |
|
|
129
|
+
| `leftovers` | A recorded name (the flag literal, its constants, wrappers the agent recorded) is still in code or config. A mention in a comment is a warning, and so is a test that checks text the removal deleted from the code (a test of the OFF path that never names the flag), or deleted text whose replacement on the same line no test checks (lost ON coverage) |
|
|
113
130
|
| `dead-code` | The compiler reports new unused code (locals, imports, private members) in changed files |
|
|
114
131
|
| `build` | A project's build command fails |
|
|
115
|
-
| `tests` | A test that passed at the baseline fails.
|
|
132
|
+
| `tests` | A test that passed at the baseline fails. With `testResults`, tests that already failed at the baseline are known failures and only warn. A test that no longer runs though the diff neither deletes nor renames it and the test config is unchanged, and a changed test file none of whose tests ran, are warnings for the agent to account for |
|
|
116
133
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
134
|
+
The baseline also records the configuration it was taken with: each project's
|
|
135
|
+
resolved build and test commands, the files they name (a `.slnf`, a
|
|
136
|
+
`.runsettings`, a filter list) and the text of `flagrm.config.yaml`. When any
|
|
137
|
+
of it changed since, the check it affects warns and shows the difference: a
|
|
138
|
+
narrower test command makes "no new failures" mean less.
|
|
139
|
+
|
|
140
|
+
In typed code, deleting the flag's definition turns every missed reference into
|
|
141
|
+
a compile error, so the build does most of the work. `leftovers` covers what the
|
|
142
|
+
compiler cannot see: config files, templates, comments and wrappers.
|
|
120
143
|
|
|
121
144
|
## Configuration
|
|
122
145
|
|
|
123
146
|
```yaml
|
|
147
|
+
tools: [claude-code, codex] # the AI tools init and update set up
|
|
124
148
|
projects:
|
|
125
149
|
- name: web
|
|
126
150
|
adapter: angular
|
|
@@ -144,13 +168,34 @@ exclude: ['**/Migrations/**']
|
|
|
144
168
|
```
|
|
145
169
|
|
|
146
170
|
Paths are relative to the config file, and commands run inside each project's
|
|
147
|
-
path. Without `build
|
|
148
|
-
--no-incremental`, `npx ng build`,
|
|
149
|
-
`verify` compare individual tests against the baseline. `timeout`
|
|
150
|
-
fails a project's build or test command that runs longer,
|
|
151
|
-
runner left in watch mode.
|
|
152
|
-
|
|
153
|
-
|
|
171
|
+
path. Without `build` or `test`, the adapter's defaults are used (`dotnet build
|
|
172
|
+
--no-incremental`, `npx ng build`, and so on). `testResults` (JUnit XML or TRX)
|
|
173
|
+
lets `verify` compare individual tests against the baseline. Only files written during the run are read, so result files left by earlier runs don't count, and projects whose patterns overlap don't count each other's files. `timeout`
|
|
174
|
+
(seconds) fails a project's build or test command that runs longer, for example
|
|
175
|
+
a test runner left in watch mode. `tools` lists the AI coding tools whose files
|
|
176
|
+
`init` and `update` manage (`claude-code`, `copilot`, `codex`); dropping one
|
|
177
|
+
leaves its files in place, and `init` names them so you can delete them.
|
|
178
|
+
|
|
179
|
+
### When the machine can't build everything
|
|
180
|
+
|
|
181
|
+
`flagrm init` and `flagrm doctor` check that the .NET SDK `global.json` asks
|
|
182
|
+
for is installed (honoring `rollForward`), that `cargo` is on PATH when a
|
|
183
|
+
project's build runs it, and that Docker is running when a test project uses
|
|
184
|
+
Testcontainers. A missing SDK has to be installed. For `cargo` or Docker,
|
|
185
|
+
`flagrm scope` shows which projects a solution filter would leave out: those
|
|
186
|
+
projects and everything that references them. `flagrm scope --write` creates
|
|
187
|
+
`flagrm.slnf` next to the solution, keeps it out of git, and points the
|
|
188
|
+
project's `build` and `test` at it. The baseline and verify then run on what
|
|
189
|
+
the machine can build; edits to the left-out projects aren't checked by
|
|
190
|
+
build or tests, so mention them in the PR.
|
|
191
|
+
|
|
192
|
+
A test that fails only because of the machine's locale (a decimal comma, a
|
|
193
|
+
date format) is best left out by name, for example `dotnet test --filter
|
|
194
|
+
"FullyQualifiedName!=Ns.PriceTests.FormatsTotal"`, rather than by forcing
|
|
195
|
+
`LC_ALL=en_US.UTF-8` for the whole run: changing the locale for every test
|
|
196
|
+
can break others that pass today.
|
|
197
|
+
|
|
198
|
+
For .NET, keep `--no-incremental` in `build`. An incremental build skips
|
|
154
199
|
up-to-date projects and prints none of their warnings, so the dead-code check
|
|
155
200
|
would have no baseline warnings to compare against.
|
|
156
201
|
|
|
@@ -162,12 +207,12 @@ npm run ci # typecheck, lint, build, tests
|
|
|
162
207
|
npm run dev -- list --config test/fixtures/realistic/before/flagrm.config.yaml
|
|
163
208
|
```
|
|
164
209
|
|
|
165
|
-
`test/fixtures/realistic` holds a before
|
|
166
|
-
and .NET)
|
|
210
|
+
`test/fixtures/realistic` holds a before and after pair from a real removal
|
|
211
|
+
(Angular and .NET). The `verify` tests run against it.
|
|
167
212
|
|
|
168
213
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to report a bug or send a pull
|
|
169
214
|
request, and [CHANGELOG.md](CHANGELOG.md) for what changed between versions.
|
|
170
215
|
|
|
171
216
|
## License
|
|
172
217
|
|
|
173
|
-
[
|
|
218
|
+
Licensed under the [Apache License, Version 2.0](LICENSE). See [NOTICE](NOTICE) for attribution.
|