zedbee 0.1.0-beta.3 → 0.1.0-beta.4
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 +8 -2
- package/SECURITY.md +7 -2
- package/THIRD_PARTY_NOTICES.md +194 -41
- package/dist/checks/adapter.d.ts +6 -0
- package/dist/checks/adapter.d.ts.map +1 -1
- package/dist/checks/applicability.d.ts.map +1 -1
- package/dist/checks/applicability.js +6 -3
- package/dist/checks/applicability.js.map +1 -1
- package/dist/checks/configuration-presentation.d.ts +1 -1
- package/dist/checks/configuration-presentation.d.ts.map +1 -1
- package/dist/checks/configuration-presentation.js +12 -4
- package/dist/checks/configuration-presentation.js.map +1 -1
- package/dist/checks/dependency-architecture/normalize-graph.d.ts.map +1 -1
- package/dist/checks/dependency-architecture/normalize-graph.js +4 -1
- package/dist/checks/dependency-architecture/normalize-graph.js.map +1 -1
- package/dist/checks/dependency-architecture/rules.d.ts +1 -0
- package/dist/checks/dependency-architecture/rules.d.ts.map +1 -1
- package/dist/checks/dependency-architecture/rules.js +2 -1
- package/dist/checks/dependency-architecture/rules.js.map +1 -1
- package/dist/checks/description.d.ts +8 -0
- package/dist/checks/description.d.ts.map +1 -1
- package/dist/checks/dispatcher.d.ts.map +1 -1
- package/dist/checks/dispatcher.js +23 -0
- package/dist/checks/dispatcher.js.map +1 -1
- package/dist/checks/policy-scheduling.d.ts.map +1 -1
- package/dist/checks/policy-scheduling.js +6 -4
- package/dist/checks/policy-scheduling.js.map +1 -1
- package/dist/checks/prettier/adapter.d.ts.map +1 -1
- package/dist/checks/prettier/adapter.js +301 -50
- package/dist/checks/prettier/adapter.js.map +1 -1
- package/dist/checks/prettier/editorconfig.d.ts +14 -0
- package/dist/checks/prettier/editorconfig.d.ts.map +1 -0
- package/dist/checks/prettier/editorconfig.js +75 -0
- package/dist/checks/prettier/editorconfig.js.map +1 -0
- package/dist/checks/prettier/project-engine.d.ts +35 -0
- package/dist/checks/prettier/project-engine.d.ts.map +1 -0
- package/dist/checks/prettier/project-engine.js +611 -0
- package/dist/checks/prettier/project-engine.js.map +1 -0
- package/dist/checks/prettier/project-inventory.d.ts +12 -0
- package/dist/checks/prettier/project-inventory.d.ts.map +1 -0
- package/dist/checks/prettier/project-inventory.js +46 -0
- package/dist/checks/prettier/project-inventory.js.map +1 -0
- package/dist/checks/prettier/project-process.d.ts +13 -0
- package/dist/checks/prettier/project-process.d.ts.map +1 -0
- package/dist/checks/prettier/project-process.js +38 -0
- package/dist/checks/prettier/project-process.js.map +1 -0
- package/dist/checks/prettier/project-protocol.d.ts +6 -0
- package/dist/checks/prettier/project-protocol.d.ts.map +1 -0
- package/dist/checks/prettier/project-protocol.js +271 -0
- package/dist/checks/prettier/project-protocol.js.map +1 -0
- package/dist/checks/prettier/project-trust.d.ts +32 -0
- package/dist/checks/prettier/project-trust.d.ts.map +1 -0
- package/dist/checks/prettier/project-trust.js +140 -0
- package/dist/checks/prettier/project-trust.js.map +1 -0
- package/dist/checks/prettier/project-types.d.ts +94 -0
- package/dist/checks/prettier/project-types.d.ts.map +1 -0
- package/dist/checks/prettier/project-types.js +2 -0
- package/dist/checks/prettier/project-types.js.map +1 -0
- package/dist/checks/prettier/project-worker.d.ts +2 -0
- package/dist/checks/prettier/project-worker.d.ts.map +1 -0
- package/dist/checks/prettier/project-worker.js +393 -0
- package/dist/checks/prettier/project-worker.js.map +1 -0
- package/dist/checks/prettier/project-workspace.d.ts +21 -0
- package/dist/checks/prettier/project-workspace.d.ts.map +1 -0
- package/dist/checks/prettier/project-workspace.js +197 -0
- package/dist/checks/prettier/project-workspace.js.map +1 -0
- package/dist/checks/prettier/settings.d.ts +2 -0
- package/dist/checks/prettier/settings.d.ts.map +1 -1
- package/dist/checks/prettier/settings.js +1 -0
- package/dist/checks/prettier/settings.js.map +1 -1
- package/dist/checks/prettier/supported-path.d.ts +3 -0
- package/dist/checks/prettier/supported-path.d.ts.map +1 -1
- package/dist/checks/prettier/supported-path.js +9 -0
- package/dist/checks/prettier/supported-path.js.map +1 -1
- package/dist/checks/sanitize-result.d.ts +4 -1
- package/dist/checks/sanitize-result.d.ts.map +1 -1
- package/dist/checks/sanitize-result.js +57 -0
- package/dist/checks/sanitize-result.js.map +1 -1
- package/dist/cli.d.ts +4 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +91 -1
- package/dist/cli.js.map +1 -1
- package/dist/commands/checks.d.ts +2 -0
- package/dist/commands/checks.d.ts.map +1 -1
- package/dist/commands/checks.js +65 -3
- package/dist/commands/checks.js.map +1 -1
- package/dist/commands/doctor.d.ts.map +1 -1
- package/dist/commands/doctor.js +4 -0
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/fix.d.ts +6 -0
- package/dist/commands/fix.d.ts.map +1 -1
- package/dist/commands/fix.js +21 -0
- package/dist/commands/fix.js.map +1 -1
- package/dist/commands/init.d.ts +10 -2
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +313 -5
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/scan.d.ts +4 -0
- package/dist/commands/scan.d.ts.map +1 -1
- package/dist/commands/scan.js +29 -0
- package/dist/commands/scan.js.map +1 -1
- package/dist/commands/telemetry.d.ts +6 -0
- package/dist/commands/telemetry.d.ts.map +1 -0
- package/dist/commands/telemetry.js +30 -0
- package/dist/commands/telemetry.js.map +1 -0
- package/dist/config/file-policy.d.ts.map +1 -1
- package/dist/config/file-policy.js +31 -8
- package/dist/config/file-policy.js.map +1 -1
- package/dist/config/load-config.js +1 -1
- package/dist/config/load-config.js.map +1 -1
- package/dist/config/profiles.d.ts.map +1 -1
- package/dist/config/profiles.js +55 -0
- package/dist/config/profiles.js.map +1 -1
- package/dist/config/schema.d.ts +52 -3
- package/dist/config/schema.d.ts.map +1 -1
- package/dist/config/schema.js +55 -3
- package/dist/config/schema.js.map +1 -1
- package/dist/config/settings-registry.js +2 -2
- package/dist/config/settings-registry.js.map +1 -1
- package/dist/config/summary.d.ts +9 -0
- package/dist/config/summary.d.ts.map +1 -0
- package/dist/config/summary.js +18 -0
- package/dist/config/summary.js.map +1 -0
- package/dist/config/target-policy.d.ts +8 -0
- package/dist/config/target-policy.d.ts.map +1 -1
- package/dist/config/target-policy.js +37 -4
- package/dist/config/target-policy.js.map +1 -1
- package/dist/core/types.d.ts +15 -0
- package/dist/core/types.d.ts.map +1 -1
- package/dist/doctor/diagnostics.d.ts +4 -1
- package/dist/doctor/diagnostics.d.ts.map +1 -1
- package/dist/doctor/diagnostics.js +82 -2
- package/dist/doctor/diagnostics.js.map +1 -1
- package/dist/fixes/apply-plan.d.ts +5 -0
- package/dist/fixes/apply-plan.d.ts.map +1 -1
- package/dist/fixes/apply-plan.js +84 -9
- package/dist/fixes/apply-plan.js.map +1 -1
- package/dist/fixes/build-plan.d.ts +2 -0
- package/dist/fixes/build-plan.d.ts.map +1 -1
- package/dist/fixes/build-plan.js +7 -0
- package/dist/fixes/build-plan.js.map +1 -1
- package/dist/fixes/prettier-provider.d.ts +4 -3
- package/dist/fixes/prettier-provider.d.ts.map +1 -1
- package/dist/fixes/prettier-provider.js +37 -20
- package/dist/fixes/prettier-provider.js.map +1 -1
- package/dist/fixes/sanitize.d.ts.map +1 -1
- package/dist/fixes/sanitize.js +38 -0
- package/dist/fixes/sanitize.js.map +1 -1
- package/dist/fixes/types.d.ts +3 -0
- package/dist/fixes/types.d.ts.map +1 -1
- package/dist/fixes/types.js.map +1 -1
- package/dist/hooks/detect.d.ts.map +1 -1
- package/dist/hooks/detect.js +3 -3
- package/dist/hooks/detect.js.map +1 -1
- package/dist/hooks/husky.js +1 -1
- package/dist/hooks/husky.js.map +1 -1
- package/dist/hooks/install.d.ts +2 -1
- package/dist/hooks/install.d.ts.map +1 -1
- package/dist/hooks/install.js +14 -4
- package/dist/hooks/install.js.map +1 -1
- package/dist/hooks/lefthook.js +1 -1
- package/dist/hooks/lefthook.js.map +1 -1
- package/dist/hooks/simple-git-hooks.js +1 -1
- package/dist/hooks/simple-git-hooks.js.map +1 -1
- package/dist/init/prettier-discovery.d.ts +26 -0
- package/dist/init/prettier-discovery.d.ts.map +1 -0
- package/dist/init/prettier-discovery.js +273 -0
- package/dist/init/prettier-discovery.js.map +1 -0
- package/dist/init/prettier-editorconfig.d.ts +12 -0
- package/dist/init/prettier-editorconfig.d.ts.map +1 -0
- package/dist/init/prettier-editorconfig.js +181 -0
- package/dist/init/prettier-editorconfig.js.map +1 -0
- package/dist/init/prettier-import.d.ts +20 -0
- package/dist/init/prettier-import.d.ts.map +1 -0
- package/dist/init/prettier-import.js +560 -0
- package/dist/init/prettier-import.js.map +1 -0
- package/dist/init/recommend.d.ts.map +1 -1
- package/dist/init/recommend.js +265 -3
- package/dist/init/recommend.js.map +1 -1
- package/dist/init/types.d.ts +49 -0
- package/dist/init/types.d.ts.map +1 -1
- package/dist/init/types.js.map +1 -1
- package/dist/init/write-config.d.ts.map +1 -1
- package/dist/init/write-config.js +49 -2
- package/dist/init/write-config.js.map +1 -1
- package/dist/renderers/json.d.ts.map +1 -1
- package/dist/renderers/json.js +17 -0
- package/dist/renderers/json.js.map +1 -1
- package/dist/scan/analysis-session.d.ts +2 -0
- package/dist/scan/analysis-session.d.ts.map +1 -1
- package/dist/scan/analysis-session.js +3 -0
- package/dist/scan/analysis-session.js.map +1 -1
- package/dist/scan/run-scan.d.ts +5 -0
- package/dist/scan/run-scan.d.ts.map +1 -1
- package/dist/scan/run-scan.js +7 -0
- package/dist/scan/run-scan.js.map +1 -1
- package/dist/scan/source-excerpts.d.ts.map +1 -1
- package/dist/scan/source-excerpts.js +12 -0
- package/dist/scan/source-excerpts.js.map +1 -1
- package/dist/telemetry/client.d.ts +25 -0
- package/dist/telemetry/client.d.ts.map +1 -0
- package/dist/telemetry/client.js +191 -0
- package/dist/telemetry/client.js.map +1 -0
- package/dist/telemetry/policy.d.ts +7 -0
- package/dist/telemetry/policy.d.ts.map +1 -0
- package/dist/telemetry/policy.js +22 -0
- package/dist/telemetry/policy.js.map +1 -0
- package/dist/telemetry/schema.d.ts +253 -0
- package/dist/telemetry/schema.d.ts.map +1 -0
- package/dist/telemetry/schema.js +151 -0
- package/dist/telemetry/schema.js.map +1 -0
- package/dist/telemetry/state.d.ts +148 -0
- package/dist/telemetry/state.d.ts.map +1 -0
- package/dist/telemetry/state.js +208 -0
- package/dist/telemetry/state.js.map +1 -0
- package/dist/telemetry/transport.d.ts +6 -0
- package/dist/telemetry/transport.d.ts.map +1 -0
- package/dist/telemetry/transport.js +22 -0
- package/dist/telemetry/transport.js.map +1 -0
- package/dist/telemetry/worker.d.ts +4 -0
- package/dist/telemetry/worker.d.ts.map +1 -0
- package/dist/telemetry/worker.js +45 -0
- package/dist/telemetry/worker.js.map +1 -0
- package/dist/ui/checks-dashboard.d.ts.map +1 -1
- package/dist/ui/checks-dashboard.js +4 -2
- package/dist/ui/checks-dashboard.js.map +1 -1
- package/dist/ui/init-app.d.ts +7 -4
- package/dist/ui/init-app.d.ts.map +1 -1
- package/dist/ui/init-app.js +126 -22
- package/dist/ui/init-app.js.map +1 -1
- package/docs/checks.md +54 -2
- package/docs/cli-reference.md +30 -5
- package/docs/managed-fixes.md +8 -0
- package/docs/privacy.md +118 -1
- package/docs/support.md +7 -1
- package/licenses/overrides/jscpd-5.3.2-LICENSE +21 -0
- package/licenses/overrides/napi-rs-wasm-runtime-1.2.3-LICENSE +43 -0
- package/licenses/production-inventory.json +607 -538
- package/licenses/reviewed-overrides.json +70 -0
- package/package.json +18 -14
- package/schema/zedbee.schema.json +192 -73
package/docs/privacy.md
CHANGED
|
@@ -1,5 +1,113 @@
|
|
|
1
1
|
# Privacy and Data Handling
|
|
2
2
|
|
|
3
|
+
## Usage telemetry
|
|
4
|
+
|
|
5
|
+
Zedbee CLI usage telemetry is **enabled by default**, including in CI. Interactive
|
|
6
|
+
`zedbee init` includes an **Enable usage tracking** checkbox near the end of setup:
|
|
7
|
+
“Share anonymous usage data to help us improve Zedbee Swarm.” It starts checked
|
|
8
|
+
unless you have already opted out. Applying setup saves the choice for this local
|
|
9
|
+
installation; cancelling leaves it unchanged. Setup sends no event before the
|
|
10
|
+
choice is saved. No standalone startup notice is printed.
|
|
11
|
+
|
|
12
|
+
Environment opt-outs override the checkbox. Noninteractive `init --yes` preserves
|
|
13
|
+
your existing preference. To disable collection before first use, set `ZEDBEE_TELEMETRY_DISABLED=1` or `DO_NOT_TRACK=1`. You can also
|
|
14
|
+
persist a local preference:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx zedbee telemetry disable
|
|
18
|
+
npx zedbee telemetry status
|
|
19
|
+
npx zedbee telemetry enable
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
These management commands are not tracked. `status --format json` provides the
|
|
23
|
+
effective setting, its reason, detected environment and any existing local ID.
|
|
24
|
+
Environment disable overrides win over a saved enable preference. `init --yes`,
|
|
25
|
+
package updates and reinstallations do not reset your saved opt-out. Removing
|
|
26
|
+
your user state directory removes the preference. Repository configuration
|
|
27
|
+
cannot enable telemetry for someone who disabled it.
|
|
28
|
+
|
|
29
|
+
Only explicit metadata is sent to `https://telemetry.zedbee.dev/v1/events`, a
|
|
30
|
+
Cloudflare collector forwarding approved events to hosted PostHog:
|
|
31
|
+
|
|
32
|
+
- command/event names, random event/run IDs, UTC timestamp and duration;
|
|
33
|
+
- Zedbee version, Node major version, OS family and CPU architecture;
|
|
34
|
+
- detected CI provider, generated-hook marker, staged/base scan mode and output format;
|
|
35
|
+
- scan outcome, whether input was empty, built-in profile/custom indicator,
|
|
36
|
+
configured enabled check IDs, executed check IDs and finding count;
|
|
37
|
+
- setup outcome/profile/hook type, or fix outcome and aggregate applied/skipped counts;
|
|
38
|
+
- a random user-local installation ID for local commands, or an ephemeral random
|
|
39
|
+
command ID for CI. No persistent local ID is sent by detected CI invocations.
|
|
40
|
+
|
|
41
|
+
Source code, paths, file hashes, reports, snippets, raw errors, secrets,
|
|
42
|
+
dependency names, repository URLs/names, branch names, Git identities, hostnames
|
|
43
|
+
and environment-variable contents are not collected. No npm-install script
|
|
44
|
+
sends telemetry. Help, internal service/hook-management commands and the
|
|
45
|
+
programmatic API do not initialize telemetry. `check_ids` describes executed,
|
|
46
|
+
non-skipped checks; `enabled_check_ids` describes checks enabled globally or by
|
|
47
|
+
any configured file override, even on empty input or when checks are skipped.
|
|
48
|
+
Scan profiles are `fast`, `recommended`, `thorough`, or `custom` when resolved
|
|
49
|
+
check settings differ from the selected built-in profile, or file overrides or
|
|
50
|
+
path exclusions customize the suite. Explicit settings matching built-in defaults
|
|
51
|
+
retain that profile. This summary uses the policy already resolved from the
|
|
52
|
+
Git index (staged scans) or target
|
|
53
|
+
commit (base scans); no settings or paths are sent. It is omitted if configuration
|
|
54
|
+
cannot be resolved. Setup profiles describe setup choices.
|
|
55
|
+
|
|
56
|
+
CI is detected from `CI`, `GITHUB_ACTIONS` and `GITLAB_CI`; custom runners can set
|
|
57
|
+
`ZEDBEE_TELEMETRY_CONTEXT=ci`. Detection is best-effort. No terminal or redirected
|
|
58
|
+
output alone does not imply CI. Set the disable override pipeline-wide when you
|
|
59
|
+
do not want disposable runners to collect usage. CI activity is reported
|
|
60
|
+
separately from local installation counts. Neither is an exact count of people.
|
|
61
|
+
|
|
62
|
+
Local settings and the bounded event outbox are stored under
|
|
63
|
+
`$XDG_STATE_HOME/zedbee/telemetry` when that variable is absolute, otherwise
|
|
64
|
+
`~/.local/state/zedbee/telemetry`. The outbox holds at most 100 events / 256 KiB
|
|
65
|
+
for up to seven days; expired events are discarded during subsequent activity
|
|
66
|
+
and are not sent. Files request owner-only POSIX permissions; Windows relies
|
|
67
|
+
on the user directory's access controls. Unreadable/corrupt preferences suppress
|
|
68
|
+
collection. Lock contention, offline requests and collection failures never
|
|
69
|
+
change command results. Local sending happens in a short-lived detached process;
|
|
70
|
+
CI uses memory only and waits at most one additional second on normal exit.
|
|
71
|
+
Interrupted commands do not wait for telemetry. JSON/SARIF stdout is unchanged.
|
|
72
|
+
|
|
73
|
+
The collector does not forward your source IP or user-agent to PostHog and
|
|
74
|
+
requests no geographic enrichment. Local usage creates a PostHog person profile
|
|
75
|
+
keyed by the random installation ID so its associated events can be deleted.
|
|
76
|
+
No name or email address is collected or added to that profile. CI events do not
|
|
77
|
+
create person profiles. Cloudflare necessarily
|
|
78
|
+
receives connection metadata and may use the IP briefly for abuse limiting.
|
|
79
|
+
Random persistent identifiers are pseudonymous, not a guarantee of anonymity.
|
|
80
|
+
The collector can discard events by metadata rules or quotas; it does not use
|
|
81
|
+
those controls to collect additional categories of information.
|
|
82
|
+
|
|
83
|
+
The initial deployment uses PostHog Free, which provides a one-year event-query
|
|
84
|
+
window. That window is not a guarantee of physical deletion after one year;
|
|
85
|
+
account retention and event-deletion procedures must be verified before the
|
|
86
|
+
telemetry-enabled release. Disabling clears queued local events but cannot
|
|
87
|
+
recall requests already in flight or delete data previously received. For a
|
|
88
|
+
request to remove local-ID-associated data, contact
|
|
89
|
+
[security@zedbee.dev](mailto:security@zedbee.dev) privately with only the local
|
|
90
|
+
telemetry ID shown by `zedbee telemetry status`.
|
|
91
|
+
|
|
92
|
+
Run these commands on the same computer and operating-system user account where
|
|
93
|
+
you used Zedbee:
|
|
94
|
+
|
|
95
|
+
```sh
|
|
96
|
+
npx zedbee telemetry disable
|
|
97
|
+
npx zedbee telemetry status
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Send only the value labeled **Local telemetry ID**. Disabling telemetry preserves
|
|
101
|
+
that ID and stops future collection; it does not delete previously received data.
|
|
102
|
+
Repeat this for each computer or user account you used. If you removed the saved
|
|
103
|
+
telemetry state, the old ID cannot be reconstructed. Do not send source,
|
|
104
|
+
credentials or reports. Ephemeral CI IDs cannot be associated with a person for a targeted
|
|
105
|
+
per-person deletion request. Provider backups follow the provider's deletion
|
|
106
|
+
policy.
|
|
107
|
+
|
|
108
|
+
Telemetry controls are separate from OSV vulnerability scanning and update
|
|
109
|
+
notifications; disabling telemetry does not disable either of those features.
|
|
110
|
+
|
|
3
111
|
## Local snapshot processing
|
|
4
112
|
|
|
5
113
|
Index mode materializes two temporary representations: committed `HEAD` and the exact staged Git index. It does not scan later unstaged working-tree edits. Source excerpts are read from that exact index snapshot, so an excerpt cannot be replaced by later working-tree content. An intent-to-add entry supplies no staged file content and is excluded as unstaged. Staged Git LFS pointers and submodule pointers cannot be inspected and make the scan incomplete. Binary assets remain allowed, but binary paths selected by enabled source, formatting, or vulnerability checks are incomplete rather than silently skipped. Every affected path is reported; intentional suppression is configurable with `pathExclusions`.
|
|
@@ -8,7 +116,7 @@ Explicit base mode (`scan --base <ref>`) instead materializes the unique merge-b
|
|
|
8
116
|
|
|
9
117
|
Snapshot paths are validated under a Zedbee-owned temporary directory, selected repository links may not escape it, and cleanup is attempted before the command returns once execution has stopped. Unproved execution cleanup retains snapshots and makes the scan incomplete. Cleanup failure may disclose one validated Zedbee temporary directory so the invoking human or agent can inspect exactly what remains; resolve the execution/cleanup problem before removing it. If Zedbee cannot safely validate the directory's identity, it reports no path and instead directs the operator to inspect the OS temporary directory for stale `zedbee-snapshot-*` directories. Correct permissions, locks, or filesystem problems before retrying: a persistent cause can make later cleanups fail and leave additional snapshots.
|
|
10
118
|
|
|
11
|
-
Local analyzers receive protected snapshot paths, selected checked source bytes, and managed inert configuration. Zedbee does not run package-manager lifecycle scripts, project commands, remediation
|
|
119
|
+
Local analyzers receive protected snapshot paths, selected checked source bytes, and managed inert configuration. Zedbee does not run package-manager lifecycle scripts, project commands, or remediation. The sole executable project-configuration exception is explicitly trusted project Prettier mode, described below.
|
|
12
120
|
|
|
13
121
|
TypeScript and typed lint can also capture supporting dependency inputs through constrained installed project `node_modules` and bundled TypeScript resolution boundaries. These are permitted local dependency reads outside the selected source snapshots. Captured content supports analysis in memory; only validated input fingerprints and normalized observations may enter the scan cache. Knip's captured inputs remain snapshot-only. Setup and diagnostics (`init` and `doctor`) may read working-copy configuration.
|
|
14
122
|
|
|
@@ -34,6 +142,15 @@ selected Prettier formatting intentionally processes the complete current
|
|
|
34
142
|
working file, so it can reformat unstaged work. Review the working-tree diff
|
|
35
143
|
before staging anything.
|
|
36
144
|
|
|
145
|
+
When a project's formatting engine is trusted, that project's Prettier,
|
|
146
|
+
configuration, and plugins run in a dedicated child process over a disposable
|
|
147
|
+
mirror of the selected snapshot. The mirror and worker are owned by the scan or
|
|
148
|
+
fix and are removed afterward; project-format results are not persisted in the
|
|
149
|
+
observation cache. Trusted plugin and configuration code can still read files or
|
|
150
|
+
use the network with the user's permissions, so consent is an ongoing decision.
|
|
151
|
+
Configured connection tokens and `NODE_OPTIONS`/`NODE_PATH` are not inherited by
|
|
152
|
+
the worker.
|
|
153
|
+
|
|
37
154
|
## Secrets
|
|
38
155
|
|
|
39
156
|
Secrets are always redacted, including when source excerpts are enabled by repository policy or CLI override. Zedbee passes changed snapshot text directly to Secretlint's in-process API with its own fixed preset; it never loads `.secretlintrc` or executable project configuration. Secretlint results are immediately reduced to rule and location metadata. Raw secret text, match text, upstream messages, author data, and source lines never cross into Zedbee findings, events, text, JSON, source excerpts, or stable IDs. To distinguish a different secret replacing existing debt at the same rule and location, Zedbee computes a per-scan HMAC over the exact source range with a random key. The digest and key are ephemeral and are not rendered, cached, or persisted.
|
package/docs/support.md
CHANGED
|
@@ -94,7 +94,13 @@ If the upgrading command is interrupted, existing sessions can still finish, but
|
|
|
94
94
|
|
|
95
95
|
Unix service sockets require a sufficiently short canonical OS temporary path and owner-only permissions; Windows uses owner-restricted local named pipes and native process jobs. An unsuitable temporary directory or unverifiable identity fails closed. Use `--no-service` when a service cannot operate in the current environment. Missing permissions, rejected native cleanup, a disconnected client or a socket closing are never treated as proof that analysis stopped: unproved cleanup retains snapshots and reports incomplete.
|
|
96
96
|
|
|
97
|
-
Zedbee does not load a project's native analyzer config. Prettier, ESLint, React, Hooks, and JSX accessibility behavior comes from Zedbee's managed settings and bundled rules; custom plugins and executable project configuration are outside the supported boundary. Rule options follow the analyzer and plugin versions pinned by the installed Zedbee release and can change when Zedbee upgrades its managed engines. `zedbee checks` displays effective settings and
|
|
97
|
+
Zedbee does not load a project's native analyzer config unless a project formatting engine is explicitly trusted (see [formatting engines](checks.md#formatting-engines)). Prettier, ESLint, React, Hooks, and JSX accessibility behavior comes from Zedbee's managed settings and bundled rules; custom plugins and executable project configuration are outside the supported boundary, except that trusted project mode runs the project's own Prettier, configuration, and plugins at the supported version boundary. Rule options follow the analyzer and plugin versions pinned by the installed Zedbee release and can change when Zedbee upgrades its managed engines. `zedbee checks` displays effective formatting settings and reports the detected project Prettier version whenever the root policy or a path override selects the project engine.
|
|
98
|
+
|
|
99
|
+
Trusted project formatting supports declared Prettier 3 installations resolved through ordinary npm or Yarn `node_modules` layouts and pnpm installations whose repository link points into the pnpm store. Yarn Plug'n'Play, custom Prettier wrapper commands, and CLI-only options such as a custom `--ignore-path` are not reproduced. Configuration files and relative helpers must be contained in the selected Git snapshot; a configuration resolved outside the disposable mirror is rejected before it is imported. Project mode uses the project's root `.prettierignore` and `.gitignore`. Copy mode imports project-root ignore files once as formatting-only exclusions; custom ignore paths are not imported, and later changes to the original ignore files are not synchronized.
|
|
100
|
+
|
|
101
|
+
Relative snapshot symlinks to contained regular files, including configuration files and link chains, are preserved in the disposable mirror. Absolute, escaping, broken, cyclic, and directory snapshot links make project formatting incomplete rather than silently dropping their configuration or reading live files.
|
|
102
|
+
|
|
103
|
+
The project formatter receives a reduced environment and a temporary `HOME`, but it is not an operating-system sandbox. Configuration and plugins still run with the invoking account's filesystem and network permissions, and their behavior can vary with Node.js, the operating system, environment variables, or external services. Only enable project formatting after reviewing the code selected by the scan. CI should grant `--trust-project-prettier` only in a trusted workflow and must not add it automatically for unreviewed pull-request code.
|
|
98
104
|
|
|
99
105
|
This boundary is an adoption tradeoff: teams with native configs may see different Zedbee results because those files are not loaded. Configure supported differences in `.zedbeerc.jsonc` and use the shipped schema for editor validation. `zedbee checks` shows the effective settings, profile or repository source, and ordered overrides without running analysis.
|
|
100
106
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2013-2024 Andrey Kucherenko
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020-present LongYinan
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
MIT License
|
|
24
|
+
|
|
25
|
+
Copyright (c) 2018 GitHub
|
|
26
|
+
|
|
27
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
28
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
29
|
+
in the Software without restriction, including without limitation the rights
|
|
30
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
31
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
32
|
+
furnished to do so, subject to the following conditions:
|
|
33
|
+
|
|
34
|
+
The above copyright notice and this permission notice shall be included in all
|
|
35
|
+
copies or substantial portions of the Software.
|
|
36
|
+
|
|
37
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
38
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
39
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
40
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
41
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
42
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
43
|
+
SOFTWARE.
|