briff-scan 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/README.md +16 -4
- package/dist/cli.mjs +7529 -601
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -10,7 +10,10 @@ For each repo: `{ name, version, direct }` per installed package and
|
|
|
10
10
|
`{ runtime, version, file }` per declared runtime, plus the repo name. Nothing else.
|
|
11
11
|
|
|
12
12
|
- Lockfiles: `package-lock.json` / `npm-shrinkwrap.json` (v1–v3), `pnpm-lock.yaml` (v5–v9),
|
|
13
|
-
`yarn.lock` (v1 and Berry).
|
|
13
|
+
`yarn.lock` (v1 and Berry), `composer.lock` (PHP), `poetry.lock`, `uv.lock`, `Pipfile.lock`,
|
|
14
|
+
`requirements*.txt` (Python), `go.mod` (Go). Installed versions come from the lockfile, never
|
|
15
|
+
from ranges; a
|
|
16
|
+
requirements line without an exact `==` pin is sent as `unresolved` with the requirement.
|
|
14
17
|
- Runtimes: `.nvmrc`, `.node-version`, `package.json` engines/volta, `composer.json` /
|
|
15
18
|
`composer.lock`, `.python-version`, `pyproject.toml`, `runtime.txt`, `Pipfile`, `go.mod`,
|
|
16
19
|
`.ruby-version`, `Gemfile.lock`, `pom.xml`, Gradle files, `.sdkmanrc`, `global.json`,
|
|
@@ -35,9 +38,12 @@ jobs:
|
|
|
35
38
|
scan:
|
|
36
39
|
runs-on: ubuntu-latest
|
|
37
40
|
steps:
|
|
38
|
-
- uses: actions/checkout@
|
|
39
|
-
- uses: actions/setup-node@
|
|
40
|
-
with:
|
|
41
|
+
- uses: actions/checkout@v5
|
|
42
|
+
- uses: actions/setup-node@v5
|
|
43
|
+
with:
|
|
44
|
+
node-version: 22
|
|
45
|
+
check-latest: true # newest 22.x, not the runner's cached one
|
|
46
|
+
package-manager-cache: false
|
|
41
47
|
- run: npx briff-scan@0
|
|
42
48
|
env:
|
|
43
49
|
BRIFF_API_URL: https://app.briff.dev
|
|
@@ -66,11 +72,17 @@ BRIFF_TOKEN=brf_... npx briff-scan@0 --all-repos --root ~/code # every git rep
|
|
|
66
72
|
| `--repo-name <name>` | | `GITHUB_REPOSITORY` in Actions, else the folder name |
|
|
67
73
|
| `--all-repos` | | off: the root is one repo |
|
|
68
74
|
| `--include-worktrees` | | off (with `--all-repos`) |
|
|
75
|
+
| `--exclude <name>` | | none; repeatable or comma-separated |
|
|
69
76
|
| `--max-depth <n>` | | 6 |
|
|
70
77
|
| `--chunk <n>` | | 10 repos per upload (with `--all-repos`) |
|
|
71
78
|
| `--dry-run` | | off |
|
|
72
79
|
| `--json` | | off: machine-readable output |
|
|
73
80
|
|
|
81
|
+
`--exclude` skips a repo by the exact name Briff would get: its path under `--root` with
|
|
82
|
+
`--all-repos` (`--exclude work/site,old-app`), else the `--repo-name` / folder name. Use it on a
|
|
83
|
+
machine that scans a folder of repos when one of them already runs the GitHub Action, so it is
|
|
84
|
+
not uploaded twice.
|
|
85
|
+
|
|
74
86
|
Exit codes: 0 done, 1 the scan or upload failed, 2 bad options.
|
|
75
87
|
|
|
76
88
|
## Licence
|