@theholocron/cli 5.0.0-alpha.38 → 5.0.0-alpha.380
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 +526 -105
- package/dist/cli.mjs +21681 -6640
- package/dist/cli.mjs.map +1 -1
- package/dist/config-system-BF4CMxY8.d.mts +929 -0
- package/dist/config-system-BVYtgrmR.mjs +578 -0
- package/dist/index-u4KtcSYw.d.mts +2866 -0
- package/dist/index.d.mts +345 -599
- package/dist/index.mjs +353 -365
- package/dist/plugin/capabilities.d.mts +2 -807
- package/dist/plugin/capabilities.mjs +53 -4
- package/dist/presets.d.mts +221 -0
- package/dist/presets.mjs +439 -0
- package/package.json +42 -35
package/dist/index.d.mts
CHANGED
|
@@ -1,546 +1,270 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { $ as DnsRecord, $t as NotificationsOnboardingLayout, A as Cardinality, An as SyncResult, At as MonitoringAlertChannelInput, B as DeployFunctionConfig, Bn as WebhookDashboardInfo, Bt as MoveReport, C as BoardStatusCategory, Cn as SourceRepoInfo, Ct as IssueSelector, D as BoardView, Dn as StatusCategory, Dt as LifecycleSlot, E as BoardTemplateFile, En as SourceTeamMember, Et as LifecycleResult, F as CiRunStatus, Fn as TrackerDoctorReport, Ft as MonitoringAssertionComparison, G as DeploymentProject, Gn as Workers, Gt as NotificationsChannelLayout, H as DeployScriptConfig, Hn as WikiProvisionOpts, Ht as Notifications, I as ConnectionStringOptions, In as TrackerUser, It as MonitoringAssertionSource, J as DeploymentTarget, Jt as NotificationsForumTag, K as DeploymentProjectSettings, Kt as NotificationsDelivery, L as CreateAuthUserInput, Ln as TunnelRoute, Lt as MonitoringCheck, M as Ci, Mn as TeamPermission, Mt as MonitoringAlertChannelState, N as CiRun, Nn as Tooling, Nt as MonitoringAlertSettings, O as CapabilityImpls, On as Storage, Ot as Logs, P as CiRunFilter, Pn as ToolingDoctorReport, Pt as MonitoringAssertion, Q as Dns, Qt as NotificationsMonitoringFeed, R as Credentials, Rn as Tunnels, Rt as MonitoringCheckInput, S as BoardStatus, Sn as SourceFile, St as IssueSearchFilter, T as BoardTemplate, Tn as SourceSecurity, Tt as LabelDef, U as DeployScriptResult, Un as WikiProxyConfig, Ut as NotificationsAccess, V as DeployFunctionResult, Vn as Wiki, Vt as NormalizedAuthUser, W as Deployment, Wn as WorkerScriptState, Wt as NotificationsApplicationLayout, X as DiscussionPatch, Xt as NotificationsLinksLayout, Y as DeploymentTrigger, Yt as NotificationsLayout, Z as DiscussionPost, Zt as NotificationsMember, _ as BoardFieldType, _n as SecretScope, _t as InspectRelayInput, a as REQUIRED_CAPABILITIES, an as NotificationsSignedIn, at as EnsureReport, b as BoardRule, bn as Source, bt as IssuePriority, c as AddedItem, cn as ParseWebhookInput, ct as EnsuredDiscussion, d as AuthDescription, dn as PullRequest, dt as Environment, en as NotificationsPicture, et as DnsRecordRequest, f as AuthEvent, fn as RelayState, ft as EnvironmentReviewer, g as BoardField, gn as Ruleset, gt as ImportResult, h as AuthUser, hn as ResolvedCapability, ht as ImportOptions, i as ProviderApiError, in as NotificationsSignIn, it as EnsureRelayResult, j as CardinalityFor, jn as TeamEntry, jt as MonitoringAlertChannelResult, k as CapabilityKey, kn as StorageBranch, kt as Monitoring, l as Analytics, ln as Projects, lt as EnsuredResource, m as AuthIdentity, mn as RepoSettings, mt as Errors, n as ElevationRequiredError, nn as NotificationsPrsFeed, nt as EnsureDiscussionInput, o as WebhookVerificationError, on as NotificationsWelcomeLayout, ot as EnsureResult, p as AuthEventType, pn as RepoRef, pt as Environments, q as DeploymentRecord, qt as NotificationsEveryoneLayout, r as MissingTokenError, rn as NotificationsServerLayout, rt as EnsureRelayInput, s as isMulti, sn as PagesConfig, st as EnsureWebhookResult, t as CARDINALITY, tn as NotificationsPinnedLayout, tt as DnsRecordType, u as Auth, un as ProviderIdentity, ut as EnsuredTunnel, v as BoardItem, vn as Secrets, vt as Issue, w as BoardSummary, wn as SourceRulesetDetail, wt as Issues, x as BoardState, xn as SourceBranch, xt as IssueRecord, y as BoardItemInput, yn as ServerInspection, yt as IssueComment, z as CredentialsInspection, zn as Vault, zt as MonitoringHttpMethod } from "./index-u4KtcSYw.mjs";
|
|
2
|
+
import { A as RawProviderEntry, B as ResolvedHolocronConfig, C as EslintConfig, D as MultiEntry, E as LogConfig, F as RepoSecrets, G as StorybookDeployProject, H as ResolvedProvidersConfig, I as RepoSecretsSync, J as WorkflowWithConfig, K as TaskEntryConfig, L as RepoValidationConfig, M as RepoConfig, N as RepoProperties, O as OrgConfig, P as RepoProtection, R as RepoVariables, S as EnvConfig, T as HolocronConfig, U as ResolvedTuple, V as ResolvedProviderEntry, W as SingleEntry, _ as CredentialsConfig, a as LoadedConfig, b as DocsConfig, c as TaskEntry, d as resolveConfig, f as resolveEntry, g as ChromaticProjectConfig, h as CapabilityConfigPackage, i as loadConfig, j as RawProvidersConfig, k as ProviderOptions, l as ConfigError, m as AppConfig, n as compose, o as Capability, p as resolvePluginPackage, q as TelemetryConfig, r as defineConfig, s as ComposedPreset, t as ConfigFileError, u as credentialsEnvironment, v as DevConfig, w as GitHubAppConfig, x as DoctorConfig, y as DevServeConfig, z as RepoVariablesSync } from "./config-system-BF4CMxY8.mjs";
|
|
3
|
+
import { AuthError, ResolveTokenConfig as ResolveTokenConfig$1, ResolveTokenInput, ResolveTokenInput as ResolveTokenInput$1, resolveValue } from "@theholocron/kyber/secrets";
|
|
4
|
+
import { CheckRow } from "@theholocron/kyber/ui";
|
|
5
|
+
import { RequestOptions, RestClient, RestClientConfig, createRestClient } from "@theholocron/http-client";
|
|
6
|
+
import "@theholocron/kyber/plugins";
|
|
7
|
+
import { PackageJson } from "@theholocron/pkg-utils";
|
|
4
8
|
import { WorkspacePackage } from "@theholocron/astromech";
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
/**
|
|
9
|
+
import { ConnectionProbeInput as ConnectionProbeInput$1 } from "@theholocron/kyber/checks";
|
|
10
|
+
import "@theholocron/observability/core";
|
|
11
|
+
import { ConfigDirArea } from "@theholocron/datapad";
|
|
12
|
+
/** A plugin's `verifyToken` result when the provider accepted the token. */
|
|
13
|
+
interface VerifyTokenSuccess {
|
|
14
|
+
/** Always `true` for an accepted token. */
|
|
15
|
+
ok: true;
|
|
16
|
+
/** "workplace: acme" / "user: cnewton@x" — surfaced in success output. */
|
|
17
|
+
subject: string;
|
|
18
|
+
/** When the token stops working, ISO 8601 in UTC, for a provider that reports it. Absent when unknown or never. */
|
|
19
|
+
expiresAt?: string;
|
|
20
|
+
}
|
|
21
|
+
/** A plugin's `verifyToken` result when the provider rejected the token. */
|
|
22
|
+
interface VerifyTokenFailure {
|
|
23
|
+
/** Always `false` for a rejected token. */
|
|
24
|
+
ok: false;
|
|
25
|
+
/** Reason the token was rejected. Surfaces to the operator. */
|
|
26
|
+
message: string;
|
|
27
|
+
}
|
|
28
|
+
/** What a plugin's `verifyToken` returns: the token was accepted, or it was rejected with a reason. */
|
|
29
|
+
type VerifyTokenResult = VerifyTokenSuccess | VerifyTokenFailure;
|
|
30
|
+
/** One token a plugin takes, and where it is looked up. */
|
|
31
|
+
interface PluginToken {
|
|
32
|
+
/** The plugin's own environment variable, e.g. `HOLOCRON_ADMIN_TOKEN`. */
|
|
13
33
|
envName: string;
|
|
14
|
-
/**
|
|
34
|
+
/** The vendor's own environment variable, e.g. `CLOUDFLARE_API_TOKEN`; read after `envName` and before the keyring. */
|
|
35
|
+
vendorEnvName?: string;
|
|
36
|
+
/** The OS keyring entry, e.g. `github.admin`. */
|
|
15
37
|
keyringKey: string;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Build a strict, single-feature token resolver.
|
|
19
|
-
*
|
|
20
|
-
* Resolution chain: `--token flag → envName env var → keyring(keyringKey)`.
|
|
21
|
-
* No broad-token fallback — if the feature-specific token is absent the
|
|
22
|
-
* operation fails with a message naming the exact env var to set.
|
|
23
|
-
*/
|
|
24
|
-
declare function createFeatureResolver(config: FeatureResolverConfig): (input?: ResolveTokenInput) => string;
|
|
25
|
-
//#endregion
|
|
26
|
-
//#region src/auth/keyring.d.ts
|
|
27
|
-
/**
|
|
28
|
-
* Keyring-backed bootstrap credential store.
|
|
29
|
-
*
|
|
30
|
-
* Every holocron plugin's bootstrap token (the one it needs before it
|
|
31
|
-
* can talk to its vendor's API) can be stored in the OS keyring under
|
|
32
|
-
* a single reverse-DNS service scope. Managed via `holocron auth`
|
|
33
|
-
* subcommands; consulted at position 4 in every plugin's auth
|
|
34
|
-
* precedence chain (after --token / HOLOCRON_<X>_TOKEN / <native>_TOKEN).
|
|
35
|
-
*
|
|
36
|
-
* See `docs/wiki/specifications/tech-auth-bootstrap.spec.md` for the design rationale.
|
|
37
|
-
*
|
|
38
|
-
* Failure model: keyring access is best-effort. Platforms without a
|
|
39
|
-
* supported credential store (some Linux CI images, sandboxed
|
|
40
|
-
* environments) will throw from the underlying library. Every export
|
|
41
|
-
* here catches and returns a null/empty result rather than propagating
|
|
42
|
-
* — the plugin's precedence chain then falls through to
|
|
43
|
-
* env-var-only paths, which is exactly how CI is meant to work.
|
|
44
|
-
*/
|
|
45
|
-
/**
|
|
46
|
-
* Store or overwrite a bootstrap token for a provider. Returns true on
|
|
47
|
-
* success, false when the underlying keyring is unsupported or errored.
|
|
48
|
-
*/
|
|
49
|
-
declare function setToken(provider: string, token: string): boolean;
|
|
50
|
-
/**
|
|
51
|
-
* Read the bootstrap token for a provider. Returns `null` for both
|
|
52
|
-
* "not stored" and "keyring unavailable" — callers can treat them the
|
|
53
|
-
* same way (fall through to env-var precedence).
|
|
54
|
-
*/
|
|
55
|
-
declare function getToken(provider: string): string | null;
|
|
56
|
-
/**
|
|
57
|
-
* Delete a stored token. Returns true when a token was removed, false
|
|
58
|
-
* when there was nothing to delete or the keyring is unavailable.
|
|
59
|
-
* Distinguishing the two cases isn't worth the surface area — the
|
|
60
|
-
* command output makes the situation clear either way.
|
|
61
|
-
*/
|
|
62
|
-
declare function deleteToken(provider: string): boolean;
|
|
63
|
-
/**
|
|
64
|
-
* List provider slugs with a stored token in this service scope.
|
|
65
|
-
* Uses the library's `findCredentials(service)` — supported on all
|
|
66
|
-
* platforms the underlying credential store supports.
|
|
67
|
-
*/
|
|
68
|
-
declare function listStoredProviders(): string[];
|
|
69
|
-
//#endregion
|
|
70
|
-
//#region src/config/config.d.ts
|
|
71
|
-
/** Structured-logging config. The Axiom **token** never lives here — only in
|
|
72
|
-
* env vars or the OS keyring — but the non-secret dataset name may. */
|
|
73
|
-
interface LogConfig {
|
|
74
38
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
39
|
+
* `false` when the plugin's `verifyToken` does not apply to this token (it checks a different credential, such as
|
|
40
|
+
* a webhook URL), so `holocron doctor tokens` reports it as set without calling the plugin. Default `true`.
|
|
77
41
|
*/
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* Axiom log-shipping. Set `axiom.dataset` to opt local runs into Axiom
|
|
81
|
-
* without exporting `HOLOCRON_AXIOM_DATASET` — the CLI then pairs it with
|
|
82
|
-
* the token from `HOLOCRON_AXIOM_TOKEN` / `AXIOM_TOKEN` or the OS keyring
|
|
83
|
-
* (`holocron auth set axiom[.<org>] <TOKEN>`). Env vars still win. In CI,
|
|
84
|
-
* prefer the `HOLOCRON_AXIOM_DATASET` variable.
|
|
85
|
-
*/
|
|
86
|
-
axiom?: {
|
|
87
|
-
/** Target Axiom dataset, e.g. `"holocron-local"`. */
|
|
88
|
-
dataset?: string;
|
|
89
|
-
};
|
|
90
|
-
}
|
|
91
|
-
/**
|
|
92
|
-
* CLI self-telemetry config — the committed, reviewable override layer over the
|
|
93
|
-
* env-var + shipped-fallback activation (ADR-0007 / ADR-0008). No secret lives
|
|
94
|
-
* here; the Sentry DSN and PostHog key come from env vars or ship as fallbacks.
|
|
95
|
-
*
|
|
96
|
-
* Precedence: `HOLOCRON_TELEMETRY=false` (env) → `telemetry.enabled` (this) →
|
|
97
|
-
* default on. `enabled` never *re-enables* what the env var turned off.
|
|
98
|
-
*/
|
|
99
|
-
interface TelemetryConfig {
|
|
42
|
+
verifiable?: boolean;
|
|
100
43
|
/**
|
|
101
|
-
*
|
|
102
|
-
* `
|
|
44
|
+
* How to check this token when the plugin's one `verifyToken` is for a different credential (the Discord bot token,
|
|
45
|
+
* where `verifyToken` checks a webhook). Wins over the plugin's `verifyToken`.
|
|
103
46
|
*/
|
|
104
|
-
|
|
47
|
+
verify?: (token: string) => Promise<VerifyTokenResult>;
|
|
105
48
|
/**
|
|
106
|
-
*
|
|
107
|
-
*
|
|
49
|
+
* `true` when the plugin only falls back to this token: nothing needs it unless a call names no better source (the
|
|
50
|
+
* Discord webhook a post uses when it names no channel). The checks that expect every token a plugin lists, such as
|
|
51
|
+
* `holocron doctor credentials`, do not expect it, and `holocron auth export` marks it as optional when it has none.
|
|
52
|
+
* Default `false`.
|
|
108
53
|
*/
|
|
109
|
-
|
|
54
|
+
optional?: boolean;
|
|
55
|
+
}
|
|
56
|
+
/** Options for a token resolver, without the keyring lookup, which the CLI supplies itself. */
|
|
57
|
+
type ResolveTokenConfig = Omit<ResolveTokenConfig$1, "keyring" | "orgEnvName">;
|
|
58
|
+
/** Settings for a feature-specific token resolver: which env var and keyring entry it reads. */
|
|
59
|
+
interface FeatureResolverConfig {
|
|
60
|
+
/** Env var name for this feature, e.g. `"HOLOCRON_ISSUES_TOKEN"`. */
|
|
61
|
+
envName: string;
|
|
62
|
+
/** Keyring account key, e.g. `"github.issues"`. */
|
|
63
|
+
keyringKey: string;
|
|
64
|
+
/** The vendor named in the "no token" message. Default `GitHub`. */
|
|
65
|
+
vendor?: string;
|
|
110
66
|
}
|
|
111
|
-
|
|
67
|
+
/** A resolver from `createFeatureResolver`: call it for the token, or read `token` to see where it looks. */
|
|
68
|
+
type FeatureResolver = ((input?: ResolveTokenInput$1) => string) & {
|
|
69
|
+
/** The environment variable and keyring entry this resolver reads, for `holocron doctor tokens`. */
|
|
70
|
+
readonly token: PluginToken;
|
|
71
|
+
};
|
|
72
|
+
/** A resolver from `createResolveToken`: call it for the token, or read `token` to see where it looks. */
|
|
73
|
+
type TokenResolver = ((input?: ResolveTokenInput$1) => string) & {
|
|
74
|
+
/** The environment variables and keyring entry this resolver reads, for `holocron doctor tokens`. */
|
|
75
|
+
readonly token: PluginToken;
|
|
76
|
+
};
|
|
112
77
|
/**
|
|
113
|
-
* The
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* @example
|
|
118
|
-
* // @acme/holocron-vault/index.ts
|
|
119
|
-
* import type { CapabilityConfigPackage } from '@theholocron/cli'
|
|
120
|
-
* export default {
|
|
121
|
-
* provider: '1password',
|
|
122
|
-
* options: { vault: 'acme-app' },
|
|
123
|
-
* } satisfies CapabilityConfigPackage
|
|
78
|
+
* The holocron keyring: `get` answers `null` for "not stored" and for "keyring unavailable" alike, so callers fall
|
|
79
|
+
* through to env-var precedence, and remembers the answer for the process (`clearCache` forgets it); `set` and `delete`
|
|
80
|
+
* answer whether they did anything; `list` names the stored providers; `isAvailable` tells an outage from an empty keyring.
|
|
124
81
|
*/
|
|
125
|
-
|
|
126
|
-
provider: string;
|
|
127
|
-
options?: ProviderOptions;
|
|
128
|
-
}
|
|
129
|
-
type SingleEntry = string | [provider: string, options: ProviderOptions];
|
|
130
|
-
type MultiEntry = Array<string | [provider: string, options: ProviderOptions]>;
|
|
131
|
-
type RawProviderEntry = SingleEntry | MultiEntry;
|
|
132
|
-
type RawProvidersConfig = Partial<Record<CapabilityKey, RawProviderEntry>>;
|
|
133
|
-
type RepoProtection = "balanced" | "strict" | "none";
|
|
82
|
+
export declare const keyring: import("@theholocron/kyber/secrets").Keyring;
|
|
134
83
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
84
|
+
* Kyber's `createResolveToken` with the keyring, the `HOLOCRON_ORG` variable and the `token` description
|
|
85
|
+
* `holocron doctor tokens` reads filled in, so a plugin stays at a one-liner call site. The chain is the flag, the
|
|
86
|
+
* plugin's variable, the vendor's variable, the `credentials` providers' variables, the keyring.
|
|
138
87
|
*/
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
https?: boolean;
|
|
155
|
-
}
|
|
156
|
-
interface RepoProperties {
|
|
157
|
-
lifecycle?: "active" | "experimental" | "deprecated";
|
|
158
|
-
open_source?: boolean;
|
|
159
|
-
runtime_environment?: "node" | "browser" | "universal" | "none";
|
|
160
|
-
uses_external_packages?: boolean;
|
|
161
|
-
}
|
|
162
|
-
interface RepoConfig {
|
|
163
|
-
/** "owner/name" — the GitHub repository coordinate. Derived from the git remote when absent. */
|
|
164
|
-
name?: string;
|
|
165
|
-
/**
|
|
166
|
-
* Branch protection preset applied by `holocron setup`. When omitted,
|
|
167
|
-
* no protection is applied and no `branch_protection_level` property is set.
|
|
168
|
-
* Required-status-check contexts for `"strict"` are derived from the task
|
|
169
|
-
* manifest — `{ required: true }` tasks + top-level `extraRequiredChecks`
|
|
170
|
-
* (see `astromech.requiredChecks()`).
|
|
171
|
-
*/
|
|
172
|
-
protection?: RepoProtection;
|
|
173
|
-
/**
|
|
174
|
-
* GitHub teams granted repository access. Synced by `holocron setup`, which
|
|
175
|
-
* also writes `.github/CODEOWNERS` for teams with write-or-higher permission.
|
|
176
|
-
* String shorthand defaults to `push` (Write).
|
|
177
|
-
*/
|
|
178
|
-
teams?: TeamEntry[];
|
|
179
|
-
/** GitHub topics set on the repository. */
|
|
180
|
-
topics?: string[];
|
|
181
|
-
/** GitHub custom properties synced to the org dashboard. */
|
|
182
|
-
properties?: RepoProperties;
|
|
88
|
+
export declare function createResolveToken(config: ResolveTokenConfig): TokenResolver;
|
|
89
|
+
/**
|
|
90
|
+
* Kyber's `createFeatureResolver` for a strict, single-feature token: the flag, the feature's variable, the
|
|
91
|
+
* `credentials` providers' variable of that name, the keyring. No broad-token fallback; if the feature's token is absent
|
|
92
|
+
* the operation fails with a message naming the exact variable to set and `holocron auth set`.
|
|
93
|
+
*/
|
|
94
|
+
export declare function createFeatureResolver(config: FeatureResolverConfig): FeatureResolver;
|
|
95
|
+
/** One line a probe reports: `info` for a fact, `ok` / `fail` for a result, `heading` to title the rows that follow. */
|
|
96
|
+
interface ProbeRow {
|
|
97
|
+
/** `ok` or `fail` for a result, `info` for a fact, `heading` to title the rows that follow. */
|
|
98
|
+
status: "ok" | "fail" | "info" | "heading";
|
|
99
|
+
/** The row's short title. */
|
|
100
|
+
label: string;
|
|
101
|
+
/** Further detail, when there is some. */
|
|
102
|
+
detail?: string;
|
|
183
103
|
}
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
104
|
+
/** What a probe is handed. Everything it prints or changes goes through this, so the runner can enforce the rules. */
|
|
105
|
+
interface ProbeContext {
|
|
106
|
+
/** What the person typed after the probe name (`probe deps who vitest` hands `["vitest"]`). */
|
|
107
|
+
args?: readonly string[];
|
|
108
|
+
/**
|
|
109
|
+
* `--lcov <path>`: where a probe that measures coverage also writes an lcov report, on top of the rows it prints.
|
|
110
|
+
* Relative to the repo root. Unset when the flag was not given.
|
|
111
|
+
*/
|
|
112
|
+
lcov?: string;
|
|
113
|
+
/** `--dry-run`: `write` calls are announced and skipped. */
|
|
114
|
+
dryRun: boolean;
|
|
115
|
+
/** Report one line. The text is scrubbed of secrets before it is printed. */
|
|
116
|
+
say(row: ProbeRow): void;
|
|
117
|
+
/**
|
|
118
|
+
* Change something on the provider. The only way to: on `--dry-run` it prints `would <label>` and does not call `fn`,
|
|
119
|
+
* and a probe that did not declare `writes: true` cannot call it.
|
|
120
|
+
*/
|
|
121
|
+
write<T>(label: string, fn: () => Promise<T>): Promise<T | undefined>;
|
|
122
|
+
/** Register how to undo something this probe made. Runs in reverse order on success, failure and Ctrl-C. */
|
|
123
|
+
cleanup(label: string, fn: () => Promise<void>): void;
|
|
124
|
+
/** Mark a value (a token, a signing secret) as one that must never be printed. */
|
|
125
|
+
secret(value: string | undefined): void;
|
|
188
126
|
}
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
* vars, and produce documentation.
|
|
198
|
-
*
|
|
199
|
-
* @example
|
|
200
|
-
* // Project-only prefix
|
|
201
|
-
* namespaces: ["CLI_TEMPLATE"]
|
|
202
|
-
*
|
|
203
|
-
* // Org-wide defaults + project-specific overrides
|
|
204
|
-
* namespaces: ["HOLOCRON", "MY_CLI"]
|
|
205
|
-
*/
|
|
206
|
-
namespaces?: string[];
|
|
127
|
+
/** A named, on-demand poke at a live provider. */
|
|
128
|
+
interface Probe {
|
|
129
|
+
/** One sentence for `holocron probe`'s listing. */
|
|
130
|
+
summary: string;
|
|
131
|
+
/** Whether it creates or changes anything on the provider. Asked about first, and needs `--yes` without a terminal. */
|
|
132
|
+
writes: boolean;
|
|
133
|
+
/** Runs the probe, reporting and changing things only through `ctx`. */
|
|
134
|
+
run(ctx: ProbeContext): Promise<void>;
|
|
207
135
|
}
|
|
136
|
+
/** A plugin's probes by name (kebab-case), as returned from `createPlugin` next to `capabilities`. */
|
|
137
|
+
type PluginProbes = Record<string, Probe>;
|
|
208
138
|
/**
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* The `tokenName` maps to a repository secret named `CHROMATIC_PROJECT_TOKEN_<TOKENNAME>`.
|
|
213
|
-
* Additional fields correspond to chromaui/action inputs and are passed through directly.
|
|
214
|
-
*
|
|
215
|
-
* @see https://www.chromatic.com/docs/monorepos/
|
|
139
|
+
* One step of a provider's `setup` or `doctor`, in the shape the shared renderer prints (`printCheckRows`): an id, a
|
|
140
|
+
* title, `ok` / `fail` / `skip`, one line of detail and, for a failure, a line per problem.
|
|
216
141
|
*/
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
* Must be uppercase (e.g. `"WEB"`, `"UI"`).
|
|
221
|
-
*/
|
|
222
|
-
tokenName: string;
|
|
223
|
-
/**
|
|
224
|
-
* Path to run the Chromatic build from, relative to the repo root.
|
|
225
|
-
* Typically the package directory (e.g. `"apps/web"`, `"packages/ui"`).
|
|
226
|
-
*/
|
|
227
|
-
workingDir: string;
|
|
228
|
-
/**
|
|
229
|
-
* Script name to build Storybook. Defaults to `"build:storybook"`.
|
|
230
|
-
* Must accept `--output-dir` pass-through (use `turbo run … --` at root).
|
|
231
|
-
*/
|
|
232
|
-
buildScript?: string;
|
|
233
|
-
/**
|
|
234
|
-
* Path to the Storybook folder relative to `workingDir`, for TurboSnap.
|
|
235
|
-
* Tells Chromatic where to find `.storybook/` when the Storybook config
|
|
236
|
-
* is in a subdirectory. Corresponds to `--storybook-base-dir`.
|
|
237
|
-
*/
|
|
238
|
-
storybookBaseDir?: string;
|
|
239
|
-
/**
|
|
240
|
-
* Glob patterns of files/dirs that should NOT trigger a TurboSnap bailout
|
|
241
|
-
* when changed. Useful for ignoring non-UI changes in a monorepo
|
|
242
|
-
* (e.g. `"./packages/!(ui)/**"` to focus TurboSnap on the UI package).
|
|
243
|
-
* Corresponds to `--untraced`. Accepts a single glob string or array.
|
|
244
|
-
*/
|
|
245
|
-
untraced?: string | string[];
|
|
246
|
-
/**
|
|
247
|
-
* Glob patterns matching story files to snapshot. When set, only matching
|
|
248
|
-
* stories are captured. Corresponds to `--only-story-files`.
|
|
249
|
-
* Cannot be combined with `onlyStoryNames`.
|
|
250
|
-
*/
|
|
251
|
-
onlyStoryFiles?: string;
|
|
142
|
+
type ProviderRow = CheckRow;
|
|
143
|
+
/** What a provider's `setup` and `doctor` are handed. */
|
|
144
|
+
interface ProviderActionContext {
|
|
252
145
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
* Corresponds to `--exit-zero-on-changes`.
|
|
146
|
+
* `--dry-run`: `setup` reports what it would change as `ok` rows and changes nothing. `doctor` never changes
|
|
147
|
+
* anything, so it ignores this.
|
|
256
148
|
*/
|
|
257
|
-
|
|
149
|
+
dryRun: boolean;
|
|
258
150
|
}
|
|
259
151
|
/**
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* `
|
|
152
|
+
* Something only one provider has (a Linear team's automation, a Discord server's roles) and no provider-neutral
|
|
153
|
+
* command can express. It reports one row per step and does not stop at the first failure: a step that fails is a
|
|
154
|
+
* `fail` row and the next step still runs. It never prints a token.
|
|
263
155
|
*/
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
156
|
+
type ProviderAction = (ctx: ProviderActionContext) => Promise<ProviderRow[]>;
|
|
157
|
+
/** A provider's `setup` and `doctor`, as `holocron provider <name> setup|doctor` finds them. */
|
|
158
|
+
interface ProviderActions {
|
|
159
|
+
/** Makes what the provider's own config block declares. Optional. */
|
|
160
|
+
setup?: ProviderAction;
|
|
161
|
+
/** Compares what the provider's own config block declares with what exists, read-only. Optional. */
|
|
162
|
+
doctor?: ProviderAction;
|
|
267
163
|
}
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
* They also drive automatic `paths:` derivation so you never need to write
|
|
277
|
-
* `paths:` manually for deploy entries.
|
|
278
|
-
*/
|
|
279
|
-
type WorkflowWithConfig = Record<string, unknown> & {
|
|
280
|
-
"run-chromatic"?: boolean | {
|
|
281
|
-
projects: ChromaticProjectConfig[];
|
|
282
|
-
};
|
|
283
|
-
/**
|
|
284
|
-
* Docs deployment shorthand. `true` uses the org-standard `docs/` directory;
|
|
285
|
-
* `{ path: "custom" }` uses a custom directory. Both derive a `paths:` entry automatically.
|
|
286
|
-
*/
|
|
287
|
-
docs?: true | {
|
|
288
|
-
path: string;
|
|
289
|
-
};
|
|
290
|
-
/** Storybook apps to deploy alongside docs. Each entry's `path` is appended to `paths:`. */
|
|
291
|
-
storybook?: StorybookDeployProject[];
|
|
292
|
-
};
|
|
293
|
-
/**
|
|
294
|
-
* A `tasks` manifest entry in object form. A bare string entry is shorthand
|
|
295
|
-
* for `{ name, ci: true, local: true }`.
|
|
296
|
-
*/
|
|
297
|
-
interface TaskEntryConfig {
|
|
298
|
-
name: string;
|
|
299
|
-
with?: WorkflowWithConfig;
|
|
300
|
-
paths?: string[];
|
|
301
|
-
linters?: string[];
|
|
302
|
-
/** Emit a `.github/workflows/<name>.yml` thin caller + include in `holocron ci`. Default `true`. */
|
|
303
|
-
ci?: boolean;
|
|
304
|
-
/** Write a `package.json` script + let `holocron run <name>` resolve the task. Default `true`. */
|
|
305
|
-
local?: boolean;
|
|
306
|
-
/** The task's CI check context is a required status check + part of `holocron ci`'s default run. */
|
|
307
|
-
required?: boolean;
|
|
164
|
+
interface RoleSyncOutcome {
|
|
165
|
+
role: string;
|
|
166
|
+
team: string;
|
|
167
|
+
plan: RoleSyncPlan;
|
|
168
|
+
/** Members the role was given to (empty on a dry run). */
|
|
169
|
+
added: string[];
|
|
170
|
+
/** Members the role was taken from (empty on a dry run or with `keep`). */
|
|
171
|
+
removed: string[];
|
|
308
172
|
}
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
/**
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
|
|
317
|
-
* tries `<service>.<org>` before the unnamespaced `<service>` fallback, so
|
|
318
|
-
* a single machine can hold credentials for multiple GitHub orgs without
|
|
319
|
-
* collision. Overridden by `--org` CLI flag or `HOLOCRON_ORG` env var.
|
|
320
|
-
*/
|
|
321
|
-
org?: string;
|
|
322
|
-
/**
|
|
323
|
-
* Org canonical domain (e.g. `"theholocron.dev"`). Subdomains are derived
|
|
324
|
-
* from this — `preview: true` on a deploy workflow resolves the preview base
|
|
325
|
-
* domain as `preview.<domain>`, giving URLs like `<repo>-pr-<n>.<domain>`.
|
|
326
|
-
*/
|
|
327
|
-
domain?: string;
|
|
328
|
-
/**
|
|
329
|
-
* Repository identity and metadata. When set, `PluginLoader` injects
|
|
330
|
-
* `repo.name` into every plugin's `RuntimeContext.repo` so plugins that
|
|
331
|
-
* need a repo (github, etc.) don't require `--repo` on every invocation.
|
|
332
|
-
* `--repo` on the command line still overrides.
|
|
333
|
-
*/
|
|
334
|
-
repo?: RepoConfig;
|
|
335
|
-
/**
|
|
336
|
-
* The task manifest — what this repo runs. Each entry is a task name
|
|
337
|
-
* (backed by a reusable workflow in `theholocron/.github`), or the object
|
|
338
|
-
* form to pass `with:` inputs. `@theholocron/astromech` reads this as the
|
|
339
|
-
* single source for `holocron run` / `holocron ci` / the generated CI
|
|
340
|
-
* workflows / `package.json` scripts.
|
|
341
|
-
*
|
|
342
|
-
* Supported values (intent-facing vocabulary — epic #672, D3):
|
|
343
|
-
* "verification.unitTests" | "verification.typeSafety" | "verification.performance" |
|
|
344
|
-
* "sourceQuality.staticAnalysis" | "sourceQuality.formatting" |
|
|
345
|
-
* "sourceQuality.structuredDataValidation" | "sourceQuality.deadCodeAnalysis" |
|
|
346
|
-
* "security.secretDetection" | "security.codeScanning" |
|
|
347
|
-
* "delivery.build" | "delivery.publish" | "delivery.deploy" | "delivery.bundleSize" |
|
|
348
|
-
* "platform.repoSync" | "platform.commitStandards" | "platform.repoValidation" |
|
|
349
|
-
* "knowledge.wiki" | "knowledge.docs" | "knowledge.components" |
|
|
350
|
-
* "review" | "tag" | "stale" | "greetings" | "dependencies" | "bookkeeping"
|
|
351
|
-
*
|
|
352
|
-
* `holocron setup` writes `.github/workflows/<name>.yml` for each entry,
|
|
353
|
-
* calling the corresponding reusable workflow in `theholocron/.github`.
|
|
354
|
-
* Files are overwritten on each run — they are generated artifacts.
|
|
355
|
-
*
|
|
356
|
-
* ### delivery.deploy / knowledge.docs / knowledge.components
|
|
357
|
-
* `delivery.deploy` uses `docs` and/or `storybook` in `with:` — setup
|
|
358
|
-
* derives `paths:` automatically. `docs: true` uses the org-standard
|
|
359
|
-
* `docs/` directory; `docs: { path: "custom" }` overrides it.
|
|
360
|
-
* `knowledge.docs` / `knowledge.components` are the same underlying
|
|
361
|
-
* mechanism, each dedicated to exactly one type — they imply the
|
|
362
|
-
* corresponding shorthand, so a repo using them never has to spell out
|
|
363
|
-
* `docs: true` / `storybook: […]` itself.
|
|
364
|
-
*
|
|
365
|
-
* ```ts
|
|
366
|
-
* // Docs only (standard layout)
|
|
367
|
-
* { name: "delivery.deploy", with: { docs: true } }
|
|
368
|
-
* // …or equivalently, the dedicated task:
|
|
369
|
-
* "knowledge.docs"
|
|
370
|
-
*
|
|
371
|
-
* // Docs + monorepo storybooks
|
|
372
|
-
* {
|
|
373
|
-
* name: "delivery.deploy",
|
|
374
|
-
* with: {
|
|
375
|
-
* docs: true,
|
|
376
|
-
* storybook: [
|
|
377
|
-
* { name: "web", path: "apps/web" },
|
|
378
|
-
* { name: "ui", path: "packages/ui" },
|
|
379
|
-
* ],
|
|
380
|
-
* },
|
|
381
|
-
* }
|
|
382
|
-
*
|
|
383
|
-
* // Non-standard docs location
|
|
384
|
-
* { name: "delivery.deploy", with: { docs: { path: "packages/site" } } }
|
|
385
|
-
* ```
|
|
386
|
-
*
|
|
387
|
-
* ### run-chromatic
|
|
388
|
-
* For a single-project repo, use `"run-chromatic": true` with a
|
|
389
|
-
* `CHROMATIC_PROJECT_TOKEN` repository secret.
|
|
390
|
-
*
|
|
391
|
-
* For monorepos with multiple Storybooks, use the object form:
|
|
392
|
-
* ```ts
|
|
393
|
-
* "run-chromatic": {
|
|
394
|
-
* projects: [
|
|
395
|
-
* { tokenName: "WEB", workingDir: "apps/web" },
|
|
396
|
-
* { tokenName: "UI", workingDir: "packages/ui" },
|
|
397
|
-
* ]
|
|
398
|
-
* }
|
|
399
|
-
* ```
|
|
400
|
-
* Each `tokenName` maps to a repository secret named
|
|
401
|
-
* `CHROMATIC_PROJECT_TOKEN_<TOKENNAME>`. `holocron setup` expands this
|
|
402
|
-
* to the flat `run-chromatic: true` + `chromatic-projects: <json>` inputs
|
|
403
|
-
* that the reusable workflow accepts.
|
|
404
|
-
*
|
|
405
|
-
* @example
|
|
406
|
-
* ["sourceQuality.staticAnalysis", { "name": "delivery.publish", "with": { "run-build": false } }]
|
|
407
|
-
* { "name": "delivery.deploy", "with": { "docs": true } }
|
|
408
|
-
*/
|
|
409
|
-
tasks?: Array<string | TaskEntryConfig>;
|
|
410
|
-
/**
|
|
411
|
-
* Opt out of `holocron sync`'s `package.json` script writes. Default `true`.
|
|
412
|
-
*/
|
|
413
|
-
syncScripts?: boolean;
|
|
414
|
-
/**
|
|
415
|
-
* The command the synced `"holocron"` `package.json` script runs. Default
|
|
416
|
-
* `"holocron"` (the installed bin). This repo overrides it to run its own
|
|
417
|
-
* build (`"node packages/cli/dist/cli.mjs"`).
|
|
418
|
-
*/
|
|
419
|
-
holocronScript?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Required status-check contexts not backed by a `required` task (codecov
|
|
422
|
-
* gates, the bundle-build check, …). `holocron setup` appends these to the
|
|
423
|
-
* task-derived list from `astromech.requiredChecks()`.
|
|
424
|
-
*/
|
|
425
|
-
extraRequiredChecks?: string[];
|
|
426
|
-
/**
|
|
427
|
-
* Git hooks `holocron setup` installs. `true` / `{ prePush: true }` writes
|
|
428
|
-
* `.husky/pre-push` (runs `holocron ci` before every push); `false` /
|
|
429
|
-
* `{ prePush: false }` opts out. Omitted → on for `protection: "strict"`,
|
|
430
|
-
* off otherwise. `--hooks` / `--no-hooks` on `holocron setup` override.
|
|
431
|
-
*/
|
|
432
|
-
hooks?: boolean | {
|
|
433
|
-
prePush?: boolean;
|
|
434
|
-
};
|
|
435
|
-
providers: RawProvidersConfig;
|
|
436
|
-
apps?: AppConfig[];
|
|
437
|
-
doctor?: DoctorConfig;
|
|
438
|
-
/**
|
|
439
|
-
* Agent runtime that determines where skills are installed by `holocron setup`.
|
|
440
|
-
* Skills are installed to `.agents/skills/<name>/` (canonical) with a
|
|
441
|
-
* relative symlink at the agent-specific path:
|
|
442
|
-
* - `"claude"` → `.claude/skills/<name>` → `../../.agents/skills/<name>`
|
|
443
|
-
* - `"codex"` | `"gemini"` → logged as unsupported; skipped gracefully.
|
|
444
|
-
*/
|
|
445
|
-
agent?: "claude" | "codex" | "gemini";
|
|
446
|
-
/**
|
|
447
|
-
* Skill names from `@theholocron/skills` to install during `holocron setup`.
|
|
448
|
-
* Installed paths are gitignored and managed by setup — do not commit them.
|
|
449
|
-
*
|
|
450
|
-
* @example
|
|
451
|
-
* ["git-safety", "pr-workflow", "commit-standards"]
|
|
452
|
-
*/
|
|
453
|
-
skills?: string[];
|
|
454
|
-
/**
|
|
455
|
-
* GitHub Pages configuration. When present, `holocron setup` calls the
|
|
456
|
-
* Pages API using `HOLOCRON_DEPLOY_TOKEN` (requires `pages:write` + `repo` scope).
|
|
457
|
-
* When absent, Pages is left as-is.
|
|
458
|
-
*
|
|
459
|
-
* @example
|
|
460
|
-
* { build: "workflow", domain: "docs.theholocron.dev", https: true }
|
|
461
|
-
*/
|
|
462
|
-
docs?: DocsConfig;
|
|
463
|
-
/**
|
|
464
|
-
* Environment variable namespace configuration.
|
|
465
|
-
* Declares the prefix(es) this project uses for its env vars so that
|
|
466
|
-
* tooling can generate `.env.example`, validate required vars, and
|
|
467
|
-
* produce accurate documentation without hard-coding prefix strings.
|
|
468
|
-
*
|
|
469
|
-
* @example
|
|
470
|
-
* { namespaces: ["HOLOCRON", "MY_CLI"] }
|
|
471
|
-
*/
|
|
472
|
-
env?: EnvConfig;
|
|
473
|
-
/**
|
|
474
|
-
* Structured-logging config. Only the level belongs here — Axiom
|
|
475
|
-
* credentials come from env vars, never a committed file.
|
|
476
|
-
*
|
|
477
|
-
* @example
|
|
478
|
-
* { level: "debug" }
|
|
479
|
-
*/
|
|
480
|
-
log?: LogConfig;
|
|
481
|
-
/**
|
|
482
|
-
* CLI self-telemetry override layer. Env var (`HOLOCRON_TELEMETRY=false`)
|
|
483
|
-
* still wins; this is the committed way to opt a repo out or drop usage
|
|
484
|
-
* analytics while keeping error reporting.
|
|
485
|
-
*
|
|
486
|
-
* @example
|
|
487
|
-
* { enabled: false }
|
|
488
|
-
* { analytics: "none" }
|
|
489
|
-
*/
|
|
490
|
-
telemetry?: TelemetryConfig;
|
|
173
|
+
/** One person: their GitHub account and their member id on the notifications provider. */
|
|
174
|
+
interface MemberLink {
|
|
175
|
+
/** The GitHub user id, as a string. It survives a rename; the login does not. */
|
|
176
|
+
github: string;
|
|
177
|
+
/** The GitHub login when the link was made; for reports only. */
|
|
178
|
+
login: string;
|
|
179
|
+
/** The member's id on the notifications provider (for Discord, the user id). */
|
|
180
|
+
member: string;
|
|
491
181
|
}
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
/**
|
|
495
|
-
|
|
496
|
-
|
|
182
|
+
/** The file that says which server member is which GitHub account. */
|
|
183
|
+
interface LinksFile {
|
|
184
|
+
/** The file format version. */
|
|
185
|
+
version: 1;
|
|
186
|
+
/** One entry per linked person. */
|
|
187
|
+
links: MemberLink[];
|
|
497
188
|
}
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
189
|
+
interface RoleSyncPlan {
|
|
190
|
+
/** Team members who are linked and do not hold the role: give it to them. */
|
|
191
|
+
add: Array<{
|
|
192
|
+
member: string;
|
|
193
|
+
login: string;
|
|
194
|
+
}>;
|
|
195
|
+
/** Holders linked to a GitHub account that is no longer on the team: take it away. */
|
|
196
|
+
remove: Array<{
|
|
197
|
+
member: string;
|
|
198
|
+
login: string;
|
|
199
|
+
}>;
|
|
200
|
+
/** Team members with no link: the role cannot reach them until they link their account. */
|
|
201
|
+
unlinked: SourceTeamMember[];
|
|
202
|
+
/** Holders with no link at all. Left alone, because nothing says they should not have it. */
|
|
203
|
+
unknownHolders: Array<{
|
|
204
|
+
member: string;
|
|
205
|
+
name?: string;
|
|
206
|
+
}>;
|
|
207
|
+
/** Linked team members who already hold the role. */
|
|
208
|
+
inSync: number;
|
|
209
|
+
}
|
|
210
|
+
/** What {@link syncRoles} needs: the providers, the links, and the roles to keep equal to their teams. */
|
|
211
|
+
interface SyncRolesInput {
|
|
212
|
+
/** The provider that lists and changes who holds a role. */
|
|
213
|
+
notifications: Notifications;
|
|
214
|
+
/** The provider that lists a team's members. */
|
|
215
|
+
source: Source;
|
|
216
|
+
/** Who is which person, from the links file. */
|
|
217
|
+
links: LinksFile;
|
|
218
|
+
/** Each role and the team it follows. */
|
|
219
|
+
roles: ReadonlyArray<{
|
|
220
|
+
name: string;
|
|
221
|
+
team: string;
|
|
222
|
+
}>;
|
|
223
|
+
/** The organisation the teams are in; defaults to the source's own. */
|
|
510
224
|
org?: string;
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
hooks?: boolean | {
|
|
518
|
-
prePush?: boolean;
|
|
519
|
-
};
|
|
520
|
-
providers: ResolvedProvidersConfig;
|
|
521
|
-
apps: AppConfig[];
|
|
522
|
-
doctor: DoctorConfig;
|
|
523
|
-
agent?: "claude" | "codex" | "gemini";
|
|
524
|
-
skills?: string[];
|
|
525
|
-
/** Resolved Pages config. `build` is guaranteed present when this field exists. */
|
|
526
|
-
docs?: PagesConfig;
|
|
527
|
-
env?: EnvConfig;
|
|
528
|
-
log?: LogConfig;
|
|
529
|
-
telemetry?: TelemetryConfig;
|
|
225
|
+
/** Report what would change without changing anything. */
|
|
226
|
+
dryRun?: boolean;
|
|
227
|
+
/** Give the role to new team members but do not take it from people who left. */
|
|
228
|
+
keep?: boolean;
|
|
229
|
+
/** Where progress lines go; nowhere when left out. */
|
|
230
|
+
print?: (line: string) => void;
|
|
530
231
|
}
|
|
531
|
-
|
|
532
|
-
|
|
232
|
+
/** What {@link syncRoles} did. */
|
|
233
|
+
interface SyncRolesResult {
|
|
234
|
+
/** One entry per role whose plan could be made. */
|
|
235
|
+
roles: RoleSyncOutcome[];
|
|
236
|
+
/** Steps that failed; the run carried on past each. */
|
|
237
|
+
failures: Array<{
|
|
238
|
+
step: string;
|
|
239
|
+
message: string;
|
|
240
|
+
}>;
|
|
241
|
+
/** Roles given or taken. */
|
|
242
|
+
ok: number;
|
|
243
|
+
/** Already in sync, left alone, or only previewed. */
|
|
244
|
+
skipped: number;
|
|
533
245
|
}
|
|
246
|
+
/** What a source provider needs to be able to do to feed a role sync, or the reason it cannot. */
|
|
247
|
+
export declare function sourceProblem(source: Source | undefined): string | undefined;
|
|
248
|
+
/** Reads the links file; a file that does not exist yet is an empty one, a damaged one throws. */
|
|
249
|
+
export declare function readLinks(source: Source, layout: NotificationsLayout, org: string | undefined, provider: string): Promise<LinksFile>;
|
|
250
|
+
/**
|
|
251
|
+
* The first role the layout declares for two different teams, or undefined. Names compare ignoring case, as
|
|
252
|
+
* the server does; the role would be synced against one team and then the other, so the last would win.
|
|
253
|
+
*/
|
|
254
|
+
export declare function roleTeamProblem(layout: {
|
|
255
|
+
roles?: ReadonlyArray<{
|
|
256
|
+
name: string;
|
|
257
|
+
team?: string;
|
|
258
|
+
}>;
|
|
259
|
+
}): string | undefined;
|
|
534
260
|
/**
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
261
|
+
* Makes each role's holders equal its team, one role after another. This is the sync itself, with no setup in
|
|
262
|
+
* front of it: the caller has already picked the providers, read the links and checked the layout. `holocron
|
|
263
|
+
* notifications sync-roles` and Sentinel's role sync are two callers of it. A step that fails is recorded and the
|
|
264
|
+
* run goes on; nothing here throws for a provider error. Idempotent: a role that already matches changes nothing.
|
|
265
|
+
* Lines go to `input.print` when it is given, and nowhere otherwise.
|
|
538
266
|
*/
|
|
539
|
-
declare function
|
|
540
|
-
declare function resolveEntry(key: CapabilityKey, raw: RawProviderEntry): ResolvedProviderEntry;
|
|
541
|
-
declare function resolveConfig(raw: HolocronConfig): ResolvedHolocronConfig;
|
|
542
|
-
//#endregion
|
|
543
|
-
//#region src/commands/setup/derived-properties.d.ts
|
|
267
|
+
export declare function syncRoles(input: SyncRolesInput): Promise<SyncRolesResult>;
|
|
544
268
|
/**
|
|
545
269
|
* Derived custom-properties (#677). Unlike the existing 6 GitHub
|
|
546
270
|
* custom-properties fields (`lifecycle`, `open_source`, `runtime_environment`,
|
|
@@ -548,20 +272,19 @@ declare function resolveConfig(raw: HolocronConfig): ResolvedHolocronConfig;
|
|
|
548
272
|
* mirror what `holocron.config.ts` already states explicitly — these four are
|
|
549
273
|
* *derived*: signal that isn't an explicit config field today (framework
|
|
550
274
|
* choice, repo archetype, capability drift). See
|
|
551
|
-
*
|
|
275
|
+
* `docs/wiki/specifications/tech-holocron-platform.spec.md` → "Custom-properties sync — field
|
|
552
276
|
* definitions (#677)" for the full design.
|
|
553
277
|
*/
|
|
554
278
|
type HolocronProfile = "library" | "cli" | "plugin" | "template" | "app" | "docs" | "platform";
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
bin?: unknown;
|
|
559
|
-
dependencies?: Record<string, string>;
|
|
560
|
-
devDependencies?: Record<string, string>;
|
|
561
|
-
}
|
|
279
|
+
/** The `package.json` shape profile derivation reads — `@theholocron/pkg-utils`'s `PackageJson`, under the name Sentinel already imports. */
|
|
280
|
+
type PackageJsonLike = PackageJson;
|
|
281
|
+
/** What profile derivation reads to decide a repo's archetype. */
|
|
562
282
|
interface DeriveProfileInput {
|
|
283
|
+
/** The repo's root `package.json`, or `null` when it has none. */
|
|
563
284
|
rootPackageJson: PackageJsonLike | null;
|
|
285
|
+
/** The repository name, without the owner. */
|
|
564
286
|
repoName: string;
|
|
287
|
+
/** Whether the repo is a monorepo with several workspace packages. */
|
|
565
288
|
isMonorepo: boolean;
|
|
566
289
|
/** `packages/*` package.json contents, monorepo repos only — used to find the primary published artifact. */
|
|
567
290
|
workspacePackageJsons: PackageJsonLike[];
|
|
@@ -588,7 +311,7 @@ interface DeriveProfileInput {
|
|
|
588
311
|
* 6. Private, non-publishable, non-docs → `app`.
|
|
589
312
|
* 7. Otherwise, a single publishable package → `library`.
|
|
590
313
|
*/
|
|
591
|
-
declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
314
|
+
export declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
592
315
|
/**
|
|
593
316
|
* Detected build/framework tooling — the literal "does this repo need
|
|
594
317
|
* next/vite/tsdown" signal `holocron.config.ts` has no field for today
|
|
@@ -596,17 +319,18 @@ declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
|
596
319
|
* Curated table, not exhaustive by design — add to `KNOWN_STACK_DEPS` as new
|
|
597
320
|
* frameworks show up rather than trying to detect anything on npm.
|
|
598
321
|
*/
|
|
599
|
-
declare function deriveStack(pkg: PackageJsonLike | null): string[];
|
|
322
|
+
export declare function deriveStack(pkg: PackageJsonLike | null): string[];
|
|
600
323
|
/** The provider capability keys actually wired in `providers: {}` — zero heuristics. */
|
|
601
|
-
declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
|
|
602
|
-
|
|
324
|
+
export declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
|
|
325
|
+
/** Whether a repo's capabilities include the required baseline (`source` and `ci`); `non-compliant` means drift. */
|
|
326
|
+
export declare function deriveCompliance(capabilities: readonly string[]): "compliant" | "non-compliant";
|
|
603
327
|
/**
|
|
604
328
|
* The Phase B refinement `deriveCompliance()`'s own doc comment names —
|
|
605
329
|
* *why* a repo is non-compliant, not just that it is. `[]` when compliant.
|
|
606
330
|
* Same `REQUIRED_BASELINE` `deriveCompliance()` checks against — one
|
|
607
331
|
* table, not two independently-maintained baselines.
|
|
608
332
|
*/
|
|
609
|
-
declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
333
|
+
export declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
610
334
|
/**
|
|
611
335
|
* Reads each workspace package's actual `package.json` content (not just
|
|
612
336
|
* `readWorkspacePackages()`'s `{ slug, name, dir }` — `deriveProfile()`'s
|
|
@@ -614,84 +338,106 @@ declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
|
614
338
|
* Missing/invalid files are skipped, matching `readWorkspacePackages()`'s
|
|
615
339
|
* own soft-fail behavior.
|
|
616
340
|
*/
|
|
617
|
-
declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
}
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
341
|
+
export declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
|
|
342
|
+
/**
|
|
343
|
+
* The labels every repository gets from `repo setup`, with their GitHub colours (hex, no `#`) and descriptions. A
|
|
344
|
+
* plugin that makes labels of its own, such as Linear's setup, takes the colour of the one with the same name.
|
|
345
|
+
*/
|
|
346
|
+
export declare const CANONICAL_LABELS: readonly [{
|
|
347
|
+
readonly name: "bug";
|
|
348
|
+
readonly color: "d73a4a";
|
|
349
|
+
readonly description: "Something isn't working";
|
|
350
|
+
}, {
|
|
351
|
+
readonly name: "chore";
|
|
352
|
+
readonly color: "ededed";
|
|
353
|
+
readonly description: "Maintenance, no user-facing change";
|
|
354
|
+
}, {
|
|
355
|
+
readonly name: "ci";
|
|
356
|
+
readonly color: "0075ca";
|
|
357
|
+
readonly description: "CI/CD pipeline changes";
|
|
358
|
+
}, {
|
|
359
|
+
readonly name: "dependencies";
|
|
360
|
+
readonly color: "0366d6";
|
|
361
|
+
readonly description: "Dependency update";
|
|
362
|
+
}, {
|
|
363
|
+
readonly name: "documentation";
|
|
364
|
+
readonly color: "0075ca";
|
|
365
|
+
readonly description: "Documentation only";
|
|
366
|
+
}, {
|
|
367
|
+
readonly name: "duplicate";
|
|
368
|
+
readonly color: "cfd3d7";
|
|
369
|
+
readonly description: "Already reported";
|
|
370
|
+
}, {
|
|
371
|
+
readonly name: "enhancement";
|
|
372
|
+
readonly color: "a2eeef";
|
|
373
|
+
readonly description: "New feature or request";
|
|
374
|
+
}, {
|
|
375
|
+
readonly name: "good first issue";
|
|
376
|
+
readonly color: "7057ff";
|
|
377
|
+
readonly description: "Good for newcomers";
|
|
378
|
+
}, {
|
|
379
|
+
readonly name: "help wanted";
|
|
380
|
+
readonly color: "008672";
|
|
381
|
+
readonly description: "Extra attention needed";
|
|
382
|
+
}, {
|
|
383
|
+
readonly name: "invalid";
|
|
384
|
+
readonly color: "e4e669";
|
|
385
|
+
readonly description: "Doesn't seem right";
|
|
386
|
+
}, {
|
|
387
|
+
readonly name: "performance";
|
|
388
|
+
readonly color: "fbca04";
|
|
389
|
+
readonly description: "Performance improvement";
|
|
390
|
+
}, {
|
|
391
|
+
readonly name: "question";
|
|
392
|
+
readonly color: "d876e3";
|
|
393
|
+
readonly description: "Further information requested";
|
|
394
|
+
}, {
|
|
395
|
+
readonly name: "refactor";
|
|
396
|
+
readonly color: "cfd3d7";
|
|
397
|
+
readonly description: "Code restructuring";
|
|
398
|
+
}, {
|
|
399
|
+
readonly name: "released";
|
|
400
|
+
readonly color: "ededed";
|
|
401
|
+
readonly description: "Included in a release";
|
|
402
|
+
}, {
|
|
403
|
+
readonly name: "test";
|
|
404
|
+
readonly color: "bfd4f2";
|
|
405
|
+
readonly description: "Test-related changes";
|
|
406
|
+
}, {
|
|
407
|
+
readonly name: "triage";
|
|
408
|
+
readonly color: "e4e669";
|
|
409
|
+
readonly description: "Needs investigation";
|
|
410
|
+
}, {
|
|
411
|
+
readonly name: "wontfix";
|
|
412
|
+
readonly color: "ffffff";
|
|
413
|
+
readonly description: "Won't be addressed";
|
|
414
|
+
}];
|
|
415
|
+
/**
|
|
416
|
+
* The closed list of area files `loadConfig` reads from `.holocron/` (the directory is `.<config name>`, set by kyber):
|
|
417
|
+
* `.holocron/notifications.*` fills `providers.notifications`' `layout`, `.holocron/repo.*` fills keys of `repo`, and `.holocron/org.*` fills provider options (`teamId`, `accountId`) a config leaves out.
|
|
418
|
+
* A file not on this list is never read.
|
|
419
|
+
*/
|
|
420
|
+
export declare const HOLOCRON_AREAS: readonly ["notifications", "repo", "org"];
|
|
421
|
+
/**
|
|
422
|
+
* The areas a config in a subdirectory also reads from the repository root's `.holocron/` (SPEC-0069): only `org`,
|
|
423
|
+
* because its values are the organization's and every config needs them. `repo` and `notifications` describe the
|
|
424
|
+
* repository itself, so an app's config does not take them from the root.
|
|
425
|
+
*/
|
|
426
|
+
export declare const SHARED_AREAS: readonly ["org"];
|
|
658
427
|
/**
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
*
|
|
662
|
-
* - Accepts individual capabilities or nested arrays (for bundle presets).
|
|
663
|
-
* - Deduplicates by `id` — when the same ID appears more than once, the last
|
|
664
|
-
* occurrence wins. This lets callers override bundle defaults by listing an
|
|
665
|
-
* explicit capability after the bundle.
|
|
666
|
-
* - Validates all `requires` at call time and throws `ConfigError` if any are
|
|
667
|
-
* unmet, listing every missing dependency in a single message.
|
|
668
|
-
*
|
|
669
|
-
* @example
|
|
670
|
-
* // docs-only site — no typecheck
|
|
671
|
-
* const preset = compose(node(), docs());
|
|
672
|
-
*
|
|
673
|
-
* // library with docs
|
|
674
|
-
* const preset = compose(node(), typecheck(), docs());
|
|
675
|
-
*
|
|
676
|
-
* // nextjs() is a bundle that returns Capability[]
|
|
677
|
-
* const preset = compose(node(), nextjs());
|
|
428
|
+
* Put the area files of `.holocron/` into the config as loaded, before `deriveDefaults` runs: `notifications` becomes
|
|
429
|
+
* the `layout` of the notifications provider and `repo` supplies keys of `repo` and `org` fills the provider options a config leaves out. A value set both inline and in a file
|
|
430
|
+
* is a `ConfigError` naming both (no merge, no precedence). With no area files the config is returned as it was.
|
|
678
431
|
*/
|
|
679
|
-
declare function
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
//#region src/config/load-config.d.ts
|
|
685
|
-
interface LoadedConfig {
|
|
686
|
-
resolved: ResolvedHolocronConfig;
|
|
687
|
-
/** Absolute path to the file the config was read from. */
|
|
688
|
-
filepath: string;
|
|
432
|
+
export declare function placeAreas(areas: ConfigDirArea[], raw: HolocronConfig): HolocronConfig;
|
|
433
|
+
/** What a connection probe needs to check a provider's host and token: kyber's input, with the plugin's `verifyToken` as `verify`. */
|
|
434
|
+
export interface ConnectionProbeInput extends Omit<ConnectionProbeInput$1, "verify"> {
|
|
435
|
+
/** The plugin's `verifyToken`: asks the provider who the token belongs to. */
|
|
436
|
+
verify: (token: string) => Promise<VerifyTokenResult>;
|
|
689
437
|
}
|
|
690
438
|
/**
|
|
691
|
-
*
|
|
692
|
-
*
|
|
693
|
-
* be loaded, or `ConfigError` when the config is invalid.
|
|
439
|
+
* The `connection` probe every provider offers, for telling a network problem from a credential problem. The checks are
|
|
440
|
+
* kyber's `connectionProbe`; this types the result as the plugin system's {@link Probe} and `verify` as `VerifyTokenResult`.
|
|
694
441
|
*/
|
|
695
|
-
declare function
|
|
696
|
-
|
|
697
|
-
export { Analytics, AppConfig, Auth, AuthDescription, AuthError, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, Capability, CapabilityConfigPackage, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, ChromaticProjectConfig, Ci, CiRun, CiRunFilter, CiRunStatus, ComposedPreset, ConfigError, ConfigFileError, ConnectionStringOptions, CreateAuthUserInput, DeployFunctionConfig, DeployFunctionResult, DeployScriptConfig, DeployScriptResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, DeriveProfileInput, Dns, DnsRecord, DnsRecordRequest, DnsRecordType, DocsConfig, DoctorConfig, EnsureResult, EnvConfig, Environment, EnvironmentReviewer, Environments, Errors, FeatureResolverConfig, HolocronConfig, HolocronProfile, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, LoadedConfig, LogConfig, Logs, MultiEntry, NormalizedAuthUser, Notifications, PackageJsonLike, PagesConfig, ParseWebhookInput, ProviderApiError, ProviderIdentity, ProviderOptions, PullRequest, REQUIRED_CAPABILITIES, RawProviderEntry, RawProvidersConfig, RepoConfig, RepoProperties, RepoProtection, RepoRef, RepoSettings, type RequestOptions, ResolveTokenConfig, type ResolveTokenInput, ResolvedCapability, ResolvedHolocronConfig, ResolvedProviderEntry, ResolvedProvidersConfig, ResolvedTuple, type RestClient, type RestClientConfig, Ruleset, SecretScope, Secrets, SingleEntry, Source, StatusCategory, Storage, StorageBranch, StorybookDeployProject, TaskEntryConfig, TeamEntry, TeamPermission, TelemetryConfig, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, WebhookDashboardInfo, WebhookVerificationError, Wiki, WikiProvisionOpts, WikiProxyConfig, Workers, WorkflowWithConfig, compose, createFeatureResolver, createResolveToken, createRestClient, defineConfig, deleteToken, deriveCapabilities, deriveCompliance, deriveProfile, deriveStack, getToken, isMulti, listStoredProviders, loadConfig, missingCapabilities, readWorkspacePackageJsons, resolveConfig, resolveEntry, resolvePluginPackage, setToken };
|
|
442
|
+
export declare function connectionProbe(input: ConnectionProbeInput): Probe;
|
|
443
|
+
export { AddedItem, Analytics, type AppConfig, Auth, AuthDescription, AuthError, AuthEvent, AuthEventType, AuthIdentity, AuthUser, BoardField, BoardFieldType, BoardItem, BoardItemInput, BoardRule, BoardState, BoardStatus, BoardStatusCategory, BoardSummary, BoardTemplate, BoardTemplateFile, BoardView, CARDINALITY, type Capability, type CapabilityConfigPackage, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, type ChromaticProjectConfig, Ci, CiRun, CiRunFilter, CiRunStatus, type ComposedPreset, ConfigError, ConfigFileError, ConnectionStringOptions, CreateAuthUserInput, Credentials, type CredentialsConfig, CredentialsInspection, DeployFunctionConfig, DeployFunctionResult, DeployScriptConfig, DeployScriptResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, type DeriveProfileInput, type DevConfig, type DevServeConfig, DiscussionPatch, DiscussionPost, Dns, DnsRecord, DnsRecordRequest, DnsRecordType, type DocsConfig, type DoctorConfig, ElevationRequiredError, EnsureDiscussionInput, EnsureRelayInput, EnsureRelayResult, EnsureReport, EnsureResult, EnsureWebhookResult, EnsuredDiscussion, EnsuredResource, EnsuredTunnel, type EnvConfig, Environment, EnvironmentReviewer, Environments, Errors, type EslintConfig, type FeatureResolver, type FeatureResolverConfig, type GitHubAppConfig, type HolocronConfig, type HolocronProfile, ImportOptions, ImportResult, InspectRelayInput, Issue, IssueComment, IssuePriority, IssueRecord, IssueSearchFilter, IssueSelector, Issues, LabelDef, LifecycleResult, LifecycleSlot, type LinksFile, type LoadedConfig, type LogConfig, Logs, type MemberLink, MissingTokenError, Monitoring, MonitoringAlertChannelInput, MonitoringAlertChannelResult, MonitoringAlertChannelState, MonitoringAlertSettings, MonitoringAssertion, MonitoringAssertionComparison, MonitoringAssertionSource, MonitoringCheck, MonitoringCheckInput, MonitoringHttpMethod, MoveReport, type MultiEntry, NormalizedAuthUser, Notifications, NotificationsAccess, NotificationsApplicationLayout, NotificationsChannelLayout, NotificationsDelivery, NotificationsEveryoneLayout, NotificationsForumTag, NotificationsLayout, NotificationsLinksLayout, NotificationsMember, NotificationsMonitoringFeed, NotificationsOnboardingLayout, NotificationsPicture, NotificationsPinnedLayout, NotificationsPrsFeed, NotificationsServerLayout, NotificationsSignIn, NotificationsSignedIn, NotificationsWelcomeLayout, type OrgConfig, type PackageJsonLike, PagesConfig, ParseWebhookInput, type PluginProbes, type PluginToken, type Probe, type ProbeContext, type ProbeRow, Projects, type ProviderAction, type ProviderActionContext, type ProviderActions, ProviderApiError, ProviderIdentity, type ProviderOptions, type ProviderRow, PullRequest, REQUIRED_CAPABILITIES, type RawProviderEntry, type RawProvidersConfig, RelayState, type RepoConfig, type RepoProperties, type RepoProtection, RepoRef, type RepoSecrets, type RepoSecretsSync, RepoSettings, type RepoValidationConfig, type RepoVariables, type RepoVariablesSync, type RequestOptions, type ResolveTokenConfig, type ResolveTokenInput, ResolvedCapability, type ResolvedHolocronConfig, type ResolvedProviderEntry, type ResolvedProvidersConfig, type ResolvedTuple, type RestClient, type RestClientConfig, Ruleset, SecretScope, Secrets, ServerInspection, type SingleEntry, Source, SourceBranch, SourceFile, SourceRepoInfo, SourceRulesetDetail, SourceSecurity, SourceTeamMember, StatusCategory, Storage, StorageBranch, type StorybookDeployProject, SyncResult, type SyncRolesInput, type SyncRolesResult, type TaskEntry, type TaskEntryConfig, TeamEntry, TeamPermission, type TelemetryConfig, type TokenResolver, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, TunnelRoute, Tunnels, Vault, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, WebhookDashboardInfo, WebhookVerificationError, Wiki, WikiProvisionOpts, WikiProxyConfig, WorkerScriptState, Workers, type WorkflowWithConfig, compose, createRestClient, credentialsEnvironment, defineConfig, isMulti, loadConfig, resolveConfig, resolveEntry, resolvePluginPackage, resolveValue };
|