flagrm 0.4.1 → 0.5.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 +31 -0
- package/README.md +316 -102
- package/dist/cli.js +58 -3
- package/dist/core/change-filter.js +6 -3
- package/dist/core/config.js +94 -0
- package/dist/core/doctor.js +14 -1
- package/dist/core/install.js +70 -15
- package/dist/core/markdown.js +57 -0
- package/dist/core/report.js +30 -0
- package/dist/core/sources/launchdarkly.js +331 -0
- package/dist/core/sources/types.js +13 -0
- package/dist/core/stale.js +218 -0
- package/dist/core/types.js +2 -0
- package/package.json +1 -1
- package/skills/flagrm-remove/SKILL.md +2 -2
- package/skills/flagrm-remove/batch.md +1 -1
- package/skills/flagrm-review/SKILL.md +49 -0
- package/skills/flagrm-verify/SKILL.md +0 -54
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flagrm-verify
|
|
3
|
-
description: >
|
|
4
|
-
Use when a feature flag removal needs checking, when the user asks whether a
|
|
5
|
-
flag is fully removed or wants the summary or commit message for a flag
|
|
6
|
-
removal, or runs /flagrm-verify <flag>, in a repository with a flagrm.config.yaml.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Verify a flag removal
|
|
10
|
-
|
|
11
|
-
`flagrm verify` decides whether the removal passed. You show its overview, add what the CLI
|
|
12
|
-
can't know, and propose a commit message. Run it as `npx --no-install flagrm`.
|
|
13
|
-
|
|
14
|
-
## 1. Verify
|
|
15
|
-
|
|
16
|
-
`flagrm verify <flag> --md`
|
|
17
|
-
|
|
18
|
-
- Exit 0: go to step 2.
|
|
19
|
-
- Exit 1: show the failing checks. If you are in the middle of `/flagrm-remove`,
|
|
20
|
-
fix them with its rules and verify again; otherwise ask the user whether to fix them now.
|
|
21
|
-
- Exit 2: read the message. A missing baseline has to come from the code before
|
|
22
|
-
the removal. Never create one on the edited code: that compares the removal
|
|
23
|
-
with itself. Tell the user to start over with `/flagrm-remove` from the
|
|
24
|
-
pre-removal commit.
|
|
25
|
-
|
|
26
|
-
## 2. Hand back
|
|
27
|
-
|
|
28
|
-
Output, in this order:
|
|
29
|
-
|
|
30
|
-
1. The markdown from `flagrm verify` exactly as printed. Don't reword it, change
|
|
31
|
-
its numbers or drop rows.
|
|
32
|
-
2. **Notes** (skip when empty), with no counts of your own:
|
|
33
|
-
- why each remaining warning is acceptable;
|
|
34
|
-
- projects whose tests didn't run because the config has no `test` command;
|
|
35
|
-
- follow-ups outside the repo: archive the flag in the flag service
|
|
36
|
-
(LaunchDarkly, Azure App Configuration, ...), remove keys from deployment
|
|
37
|
-
settings and secret stores.
|
|
38
|
-
3. The commit message:
|
|
39
|
-
|
|
40
|
-
<!-- commit-message:start -->
|
|
41
|
-
**Proposed commit message**, in a code block:
|
|
42
|
-
|
|
43
|
-
```
|
|
44
|
-
chore: remove <flag> feature flag
|
|
45
|
-
|
|
46
|
-
<one or two sentences: which path stays and what was deleted>
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
- Follow the repository's convention instead when `git log --oneline -10` shows a different one.
|
|
50
|
-
- A ticket in the branch name (`feature/feat-24586`): add it the way the log does (`#24586`, `FEAT-24586`), else `(#24586)` after the subject.
|
|
51
|
-
- Wrap the body at 72 columns.
|
|
52
|
-
<!-- commit-message:end -->
|
|
53
|
-
|
|
54
|
-
Never commit, push or open a PR unless asked. Write a PR description only on request, from the same output.
|