@brad-frost-web/eddie-reporter 0.65.0 → 0.67.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/README.md +11 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/templates/eddie-report.yml +5 -1
package/README.md
CHANGED
|
@@ -102,6 +102,17 @@ eddie-report --event ci --ignore css/styles.css --ignore css/styles.tmp.css
|
|
|
102
102
|
|
|
103
103
|
The same option exists on the API as `ignorePaths` (paths relative to the scanned directory; a directory skips its subtree). Matching is case-sensitive; an absolute path inside the scanned directory is accepted, one outside it never matches. A missing or flag-shaped value (`--ignore --dry-run`) is a usage error and exits 2.
|
|
104
104
|
|
|
105
|
+
### bfw-process rulebooks
|
|
106
|
+
|
|
107
|
+
A bfw-process product carries a rulebook that quotes Eddie markup and token names as *examples of the rules*. Counted as usage, it credits a recipe or token to a product that only mentions it (#1861).
|
|
108
|
+
|
|
109
|
+
- `.bfw-process/` and `.microagents/` are never scanned: the scanner skips every dot-directory.
|
|
110
|
+
- `AGENTS.md`, `CLAUDE.md` and `SPEC.md` are not, because root markdown on a docs site can be real usage. Opt them out explicitly, as the workflow template does:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
eddie-report --event ci --ignore AGENTS.md --ignore CLAUDE.md --ignore SPEC.md
|
|
114
|
+
```
|
|
115
|
+
|
|
105
116
|
## Programmatic API
|
|
106
117
|
|
|
107
118
|
```ts
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brad-frost-web/eddie-reporter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.67.0",
|
|
4
4
|
"description": "The Eddie-reporter \u2014 a zero-dependency usage reporter installed on downstream Eddie products. It statically scans a product for Eddie asset usage (components, recipes, pages, tokens) and reports the activity back to Eddie's Brain, so adoption and activity of the design system can be tracked as a living feedback loop.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -28,4 +28,8 @@ jobs:
|
|
|
28
28
|
env:
|
|
29
29
|
EDDIE_REPORT_ENDPOINT: ${{ secrets.EDDIE_REPORT_ENDPOINT }}
|
|
30
30
|
EDDIE_REPORT_TOKEN: ${{ secrets.EDDIE_REPORT_TOKEN }}
|
|
31
|
-
|
|
31
|
+
# bfw-process rules files quote Eddie markup as examples of the rules, not
|
|
32
|
+
# as UI. .bfw-process/ and .microagents/ are dot-directories the scanner
|
|
33
|
+
# never enters; these root files are opted out here instead, because a docs site's root
|
|
34
|
+
# markdown can be real usage (#1861). Drop any a product does not have.
|
|
35
|
+
run: npx --yes @brad-frost-web/eddie-reporter --event ci --ignore AGENTS.md --ignore CLAUDE.md --ignore SPEC.md
|