@theholocron/cli 5.0.0-alpha.36 → 5.0.0-alpha.361
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 +509 -105
- package/dist/cli.mjs +20398 -6705
- package/dist/cli.mjs.map +1 -1
- package/dist/config-system-BLKX9ztT.d.mts +929 -0
- package/dist/config-system-BVYtgrmR.mjs +578 -0
- package/dist/index-oC-J5CCm.d.mts +2716 -0
- package/dist/index.d.mts +247 -606
- package/dist/index.mjs +264 -368
- 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 +420 -0
- package/package.json +41 -34
package/dist/index.d.mts
CHANGED
|
@@ -1,546 +1,238 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { $ as DnsRecordType, $t as PagesConfig, A as Ci, An as Vault, At as MonitoringCheckInput, B as DeployScriptConfig, Bt as NotificationsForumTag, C as BoardTemplate, Cn as TeamPermission, Ct as MonitoringAlertChannelResult, D as CapabilityKey, Dn as TrackerUser, Dt as MonitoringAssertionComparison, E as CapabilityImpls, En as TrackerDoctorReport, Et as MonitoringAssertion, F as CreateAuthUserInput, Fn as WorkerScriptState, Ft as NotificationsAccess, G as DeploymentRecord, Gt as NotificationsOnboardingLayout, H as Deployment, Ht as NotificationsLinksLayout, I as Credentials, In as Workers, It as NotificationsApplicationLayout, J as DiscussionPatch, Jt as NotificationsPrsFeed, K as DeploymentTarget, Kt as NotificationsPicture, L as CredentialsInspection, Lt as NotificationsChannelLayout, M as CiRunFilter, Mn as Wiki, Mt as MoveReport, N as CiRunStatus, Nn as WikiProvisionOpts, Nt as NormalizedAuthUser, O as Cardinality, On as TunnelRoute, Ot as MonitoringAssertionSource, P as ConnectionStringOptions, Pn as WikiProxyConfig, Pt as Notifications, Q as DnsRecordRequest, Qt as NotificationsWelcomeLayout, R as DeployFunctionConfig, Rt as NotificationsDelivery, S as BoardSummary, Sn as TeamEntry, St as MonitoringAlertChannelInput, T as BoardView, Tn as ToolingDoctorReport, Tt as MonitoringAlertSettings, U as DeploymentProject, Ut as NotificationsMember, V as DeployScriptResult, Vt as NotificationsLayout, W as DeploymentProjectSettings, Wt as NotificationsMonitoringFeed, X as Dns, Xt as NotificationsSignIn, Y as DiscussionPost, Yt as NotificationsServerLayout, Z as DnsRecord, Zt as NotificationsSignedIn, _ as BoardItem, _n as SourceSecurity, _t as LabelDef, a as REQUIRED_CAPABILITIES, an as RepoRef, at as EnsureWebhookResult, b as BoardStatus, bn as Storage, bt as Logs, c as Analytics, cn as Ruleset, ct as EnsuredTunnel, d as AuthEvent, dn as ServerInspection, dt as Environments, en as ParseWebhookInput, et as EnsureDiscussionInput, f as AuthEventType, fn as Source, ft as Errors, g as BoardFieldType, gn as SourceRulesetDetail, gt as Issues, h as BoardField, hn as SourceRepoInfo, ht as IssueSearchFilter, i as ProviderApiError, in as RelayState, it as EnsureResult, j as CiRun, jn as WebhookDashboardInfo, jt as MonitoringHttpMethod, k as CardinalityFor, kn as Tunnels, kt as MonitoringCheck, l as Auth, ln as SecretScope, lt as Environment, m as AuthUser, mn as SourceFile, mt as Issue, n as ElevationRequiredError, nn as ProviderIdentity, nt as EnsureRelayResult, o as WebhookVerificationError, on as RepoSettings, ot as EnsuredDiscussion, p as AuthIdentity, pn as SourceBranch, pt as InspectRelayInput, q as DeploymentTrigger, qt as NotificationsPinnedLayout, r as MissingTokenError, rn as PullRequest, rt as EnsureReport, s as isMulti, sn as ResolvedCapability, st as EnsuredResource, t as CARDINALITY, tn as Projects, tt as EnsureRelayInput, u as AuthDescription, un as Secrets, ut as EnvironmentReviewer, v as BoardRule, vn as SourceTeamMember, vt as LifecycleResult, w as BoardTemplateFile, wn as Tooling, wt as MonitoringAlertChannelState, x as BoardStatusCategory, xn as StorageBranch, xt as Monitoring, y as BoardState, yn as StatusCategory, yt as LifecycleSlot, z as DeployFunctionResult, zt as NotificationsEveryoneLayout } from "./index-oC-J5CCm.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-BLKX9ztT.mjs";
|
|
3
|
+
import { AuthError, ResolveTokenConfig as ResolveTokenConfig$1, ResolveTokenInput, ResolveTokenInput as ResolveTokenInput$1, resolveValue } from "@theholocron/kyber/secrets";
|
|
4
|
+
import { RequestOptions, RestClient, RestClientConfig, createRestClient } from "@theholocron/http-client";
|
|
5
|
+
import "@theholocron/kyber/plugins";
|
|
6
|
+
import { PackageJson } from "@theholocron/pkg-utils";
|
|
4
7
|
import { WorkspacePackage } from "@theholocron/astromech";
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
/**
|
|
8
|
+
import { ConnectionProbeInput as ConnectionProbeInput$1 } from "@theholocron/kyber/checks";
|
|
9
|
+
import "@theholocron/observability/core";
|
|
10
|
+
import { ConfigDirArea } from "@theholocron/datapad";
|
|
11
|
+
/** A plugin's `verifyToken` result when the provider accepted the token. */
|
|
12
|
+
interface VerifyTokenSuccess {
|
|
13
|
+
/** Always `true` for an accepted token. */
|
|
14
|
+
ok: true;
|
|
15
|
+
/** "workplace: acme" / "user: cnewton@x" — surfaced in success output. */
|
|
16
|
+
subject: string;
|
|
17
|
+
/** When the token stops working, ISO 8601 in UTC, for a provider that reports it. Absent when unknown or never. */
|
|
18
|
+
expiresAt?: string;
|
|
19
|
+
}
|
|
20
|
+
/** A plugin's `verifyToken` result when the provider rejected the token. */
|
|
21
|
+
interface VerifyTokenFailure {
|
|
22
|
+
/** Always `false` for a rejected token. */
|
|
23
|
+
ok: false;
|
|
24
|
+
/** Reason the token was rejected. Surfaces to the operator. */
|
|
25
|
+
message: string;
|
|
26
|
+
}
|
|
27
|
+
/** What a plugin's `verifyToken` returns: the token was accepted, or it was rejected with a reason. */
|
|
28
|
+
type VerifyTokenResult = VerifyTokenSuccess | VerifyTokenFailure;
|
|
29
|
+
/** One token a plugin takes, and where it is looked up. */
|
|
30
|
+
interface PluginToken {
|
|
31
|
+
/** The plugin's own environment variable, e.g. `HOLOCRON_ADMIN_TOKEN`. */
|
|
13
32
|
envName: string;
|
|
14
|
-
/**
|
|
33
|
+
/** The vendor's own environment variable, e.g. `CLOUDFLARE_API_TOKEN`; read after `envName` and before the keyring. */
|
|
34
|
+
vendorEnvName?: string;
|
|
35
|
+
/** The OS keyring entry, e.g. `github.admin`. */
|
|
15
36
|
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
37
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
38
|
+
* `false` when the plugin's `verifyToken` does not apply to this token (it checks a different credential, such as
|
|
39
|
+
* a webhook URL), so `holocron doctor tokens` reports it as set without calling the plugin. Default `true`.
|
|
77
40
|
*/
|
|
78
|
-
|
|
41
|
+
verifiable?: boolean;
|
|
79
42
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
* prefer the `HOLOCRON_AXIOM_DATASET` variable.
|
|
43
|
+
* `true` when the plugin only falls back to this token: nothing needs it unless a call names no better source (the
|
|
44
|
+
* Discord webhook a post uses when it names no channel). The checks that expect every token a plugin lists, such as
|
|
45
|
+
* `holocron doctor credentials`, do not expect it, and `holocron auth export` marks it as optional when it has none.
|
|
46
|
+
* Default `false`.
|
|
85
47
|
*/
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
48
|
+
optional?: boolean;
|
|
49
|
+
}
|
|
50
|
+
/** Options for a token resolver, without the keyring lookup, which the CLI supplies itself. */
|
|
51
|
+
type ResolveTokenConfig = Omit<ResolveTokenConfig$1, "keyring" | "orgEnvName">;
|
|
52
|
+
/** Settings for a feature-specific token resolver: which env var and keyring entry it reads. */
|
|
53
|
+
interface FeatureResolverConfig {
|
|
54
|
+
/** Env var name for this feature, e.g. `"HOLOCRON_ISSUES_TOKEN"`. */
|
|
55
|
+
envName: string;
|
|
56
|
+
/** Keyring account key, e.g. `"github.issues"`. */
|
|
57
|
+
keyringKey: string;
|
|
58
|
+
/** The vendor named in the "no token" message. Default `GitHub`. */
|
|
59
|
+
vendor?: string;
|
|
90
60
|
}
|
|
61
|
+
/** A resolver from `createFeatureResolver`: call it for the token, or read `token` to see where it looks. */
|
|
62
|
+
type FeatureResolver = ((input?: ResolveTokenInput$1) => string) & {
|
|
63
|
+
/** The environment variable and keyring entry this resolver reads, for `holocron doctor tokens`. */
|
|
64
|
+
readonly token: PluginToken;
|
|
65
|
+
};
|
|
66
|
+
/** A resolver from `createResolveToken`: call it for the token, or read `token` to see where it looks. */
|
|
67
|
+
type TokenResolver = ((input?: ResolveTokenInput$1) => string) & {
|
|
68
|
+
/** The environment variables and keyring entry this resolver reads, for `holocron doctor tokens`. */
|
|
69
|
+
readonly token: PluginToken;
|
|
70
|
+
};
|
|
91
71
|
/**
|
|
92
|
-
*
|
|
93
|
-
* env-var
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
* Precedence: `HOLOCRON_TELEMETRY=false` (env) → `telemetry.enabled` (this) →
|
|
97
|
-
* default on. `enabled` never *re-enables* what the env var turned off.
|
|
72
|
+
* The holocron keyring: `get` answers `null` for "not stored" and for "keyring unavailable" alike, so callers fall
|
|
73
|
+
* through to env-var precedence, and remembers the answer for the process (`clearCache` forgets it); `set` and `delete`
|
|
74
|
+
* answer whether they did anything; `list` names the stored providers; `isAvailable` tells an outage from an empty keyring.
|
|
98
75
|
*/
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Repo-level opt-out — the committed peer of `HOLOCRON_TELEMETRY=false`.
|
|
102
|
-
* `false` installs the no-op sinks for the whole run. Default on.
|
|
103
|
-
*/
|
|
104
|
-
enabled?: boolean;
|
|
105
|
-
/**
|
|
106
|
-
* Usage-analytics provider. `"none"` disables PostHog usage analytics while
|
|
107
|
-
* leaving error reporting (Sentry) untouched. Default `"posthog"`.
|
|
108
|
-
*/
|
|
109
|
-
analytics?: "posthog" | "none";
|
|
110
|
-
}
|
|
111
|
-
type ProviderOptions = Record<string, unknown>;
|
|
76
|
+
export declare const keyring: import("@theholocron/kyber/secrets").Keyring;
|
|
112
77
|
/**
|
|
113
|
-
*
|
|
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
|
+
* Kyber's `createResolveToken` with the keyring, the `HOLOCRON_ORG` variable and the `token` description
|
|
79
|
+
* `holocron doctor tokens` reads filled in, so a plugin stays at a one-liner call site. The chain is the flag, the
|
|
80
|
+
* plugin's variable, the vendor's variable, the `credentials` providers' variables, the 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 function createResolveToken(config: ResolveTokenConfig): TokenResolver;
|
|
134
83
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
84
|
+
* Kyber's `createFeatureResolver` for a strict, single-feature token: the flag, the feature's variable, the
|
|
85
|
+
* `credentials` providers' variable of that name, the keyring. No broad-token fallback; if the feature's token is absent
|
|
86
|
+
* the operation fails with a message naming the exact variable to set and `holocron auth set`.
|
|
138
87
|
*/
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
* Custom domain / CNAME (e.g. "docs.theholocron.dev").
|
|
149
|
-
* When set and `homepage` is not explicitly provided, setup derives
|
|
150
|
-
* `homepage` as `https://{domain}/` for package.json and the repo website field.
|
|
151
|
-
*/
|
|
152
|
-
domain?: string;
|
|
153
|
-
/** Enforce HTTPS. Only effective once the custom domain is DNS-verified. */
|
|
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;
|
|
183
|
-
}
|
|
184
|
-
interface AppConfig {
|
|
185
|
-
name: string;
|
|
186
|
-
path: string;
|
|
187
|
-
kind?: string;
|
|
88
|
+
export declare function createFeatureResolver(config: FeatureResolverConfig): FeatureResolver;
|
|
89
|
+
/** One line a probe reports: `info` for a fact, `ok` / `fail` for a result, `heading` to title the rows that follow. */
|
|
90
|
+
interface ProbeRow {
|
|
91
|
+
/** `ok` or `fail` for a result, `info` for a fact, `heading` to title the rows that follow. */
|
|
92
|
+
status: "ok" | "fail" | "info" | "heading";
|
|
93
|
+
/** The row's short title. */
|
|
94
|
+
label: string;
|
|
95
|
+
/** Further detail, when there is some. */
|
|
96
|
+
detail?: string;
|
|
188
97
|
}
|
|
189
|
-
|
|
190
|
-
|
|
98
|
+
/** What a probe is handed. Everything it prints or changes goes through this, so the runner can enforce the rules. */
|
|
99
|
+
interface ProbeContext {
|
|
100
|
+
/** What the person typed after the probe name (`probe deps who vitest` hands `["vitest"]`). */
|
|
101
|
+
args?: readonly string[];
|
|
102
|
+
/**
|
|
103
|
+
* `--lcov <path>`: where a probe that measures coverage also writes an lcov report, on top of the rows it prints.
|
|
104
|
+
* Relative to the repo root. Unset when the flag was not given.
|
|
105
|
+
*/
|
|
106
|
+
lcov?: string;
|
|
107
|
+
/** `--dry-run`: `write` calls are announced and skipped. */
|
|
108
|
+
dryRun: boolean;
|
|
109
|
+
/** Report one line. The text is scrubbed of secrets before it is printed. */
|
|
110
|
+
say(row: ProbeRow): void;
|
|
111
|
+
/**
|
|
112
|
+
* Change something on the provider. The only way to: on `--dry-run` it prints `would <label>` and does not call `fn`,
|
|
113
|
+
* and a probe that did not declare `writes: true` cannot call it.
|
|
114
|
+
*/
|
|
115
|
+
write<T>(label: string, fn: () => Promise<T>): Promise<T | undefined>;
|
|
116
|
+
/** Register how to undo something this probe made. Runs in reverse order on success, failure and Ctrl-C. */
|
|
117
|
+
cleanup(label: string, fn: () => Promise<void>): void;
|
|
118
|
+
/** Mark a value (a token, a signing secret) as one that must never be printed. */
|
|
119
|
+
secret(value: string | undefined): void;
|
|
191
120
|
}
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
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[];
|
|
207
|
-
}
|
|
208
|
-
/**
|
|
209
|
-
* A single Chromatic project entry in a monorepo `run-chromatic` config.
|
|
210
|
-
* Each entry produces one matrix job in CI, publishing to a separate Chromatic project.
|
|
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/
|
|
216
|
-
*/
|
|
217
|
-
interface ChromaticProjectConfig {
|
|
218
|
-
/**
|
|
219
|
-
* Secret suffix. The CI job reads `CHROMATIC_PROJECT_TOKEN_<tokenName>`.
|
|
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;
|
|
252
|
-
/**
|
|
253
|
-
* Exit with code 0 even when visual changes are detected.
|
|
254
|
-
* Useful during initial setup before baselines are approved.
|
|
255
|
-
* Corresponds to `--exit-zero-on-changes`.
|
|
256
|
-
*/
|
|
257
|
-
exitZeroOnChanges?: boolean;
|
|
121
|
+
/** A named, on-demand poke at a live provider. */
|
|
122
|
+
interface Probe {
|
|
123
|
+
/** One sentence for `holocron probe`'s listing. */
|
|
124
|
+
summary: string;
|
|
125
|
+
/** Whether it creates or changes anything on the provider. Asked about first, and needs `--yes` without a terminal. */
|
|
126
|
+
writes: boolean;
|
|
127
|
+
/** Runs the probe, reporting and changing things only through `ctx`. */
|
|
128
|
+
run(ctx: ProbeContext): Promise<void>;
|
|
258
129
|
}
|
|
259
|
-
/**
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
130
|
+
/** A plugin's probes by name (kebab-case), as returned from `createPlugin` next to `capabilities`. */
|
|
131
|
+
type PluginProbes = Record<string, Probe>;
|
|
132
|
+
interface RoleSyncOutcome {
|
|
133
|
+
role: string;
|
|
134
|
+
team: string;
|
|
135
|
+
plan: RoleSyncPlan;
|
|
136
|
+
/** Members the role was given to (empty on a dry run). */
|
|
137
|
+
added: string[];
|
|
138
|
+
/** Members the role was taken from (empty on a dry run or with `keep`). */
|
|
139
|
+
removed: string[];
|
|
267
140
|
}
|
|
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;
|
|
141
|
+
/** One person: their GitHub account and their member id on the notifications provider. */
|
|
142
|
+
interface MemberLink {
|
|
143
|
+
/** The GitHub user id, as a string. It survives a rename; the login does not. */
|
|
144
|
+
github: string;
|
|
145
|
+
/** The GitHub login when the link was made; for reports only. */
|
|
146
|
+
login: string;
|
|
147
|
+
/** The member's id on the notifications provider (for Discord, the user id). */
|
|
148
|
+
member: string;
|
|
308
149
|
}
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
/**
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
* Active org name for namespaced keyring lookup. When set, token resolution
|
|
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;
|
|
150
|
+
/** The file that says which server member is which GitHub account. */
|
|
151
|
+
interface LinksFile {
|
|
152
|
+
/** The file format version. */
|
|
153
|
+
version: 1;
|
|
154
|
+
/** One entry per linked person. */
|
|
155
|
+
links: MemberLink[];
|
|
491
156
|
}
|
|
492
|
-
interface
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
157
|
+
interface RoleSyncPlan {
|
|
158
|
+
/** Team members who are linked and do not hold the role: give it to them. */
|
|
159
|
+
add: Array<{
|
|
160
|
+
member: string;
|
|
161
|
+
login: string;
|
|
162
|
+
}>;
|
|
163
|
+
/** Holders linked to a GitHub account that is no longer on the team: take it away. */
|
|
164
|
+
remove: Array<{
|
|
165
|
+
member: string;
|
|
166
|
+
login: string;
|
|
167
|
+
}>;
|
|
168
|
+
/** Team members with no link: the role cannot reach them until they link their account. */
|
|
169
|
+
unlinked: SourceTeamMember[];
|
|
170
|
+
/** Holders with no link at all. Left alone, because nothing says they should not have it. */
|
|
171
|
+
unknownHolders: Array<{
|
|
172
|
+
member: string;
|
|
173
|
+
name?: string;
|
|
174
|
+
}>;
|
|
175
|
+
/** Linked team members who already hold the role. */
|
|
176
|
+
inSync: number;
|
|
497
177
|
}
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
178
|
+
/** What {@link syncRoles} needs: the providers, the links, and the roles to keep equal to their teams. */
|
|
179
|
+
interface SyncRolesInput {
|
|
180
|
+
/** The provider that lists and changes who holds a role. */
|
|
181
|
+
notifications: Notifications;
|
|
182
|
+
/** The provider that lists a team's members. */
|
|
183
|
+
source: Source;
|
|
184
|
+
/** Who is which person, from the links file. */
|
|
185
|
+
links: LinksFile;
|
|
186
|
+
/** Each role and the team it follows. */
|
|
187
|
+
roles: ReadonlyArray<{
|
|
188
|
+
name: string;
|
|
189
|
+
team: string;
|
|
190
|
+
}>;
|
|
191
|
+
/** The organisation the teams are in; defaults to the source's own. */
|
|
510
192
|
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;
|
|
193
|
+
/** Report what would change without changing anything. */
|
|
194
|
+
dryRun?: boolean;
|
|
195
|
+
/** Give the role to new team members but do not take it from people who left. */
|
|
196
|
+
keep?: boolean;
|
|
197
|
+
/** Where progress lines go; nowhere when left out. */
|
|
198
|
+
print?: (line: string) => void;
|
|
530
199
|
}
|
|
531
|
-
|
|
532
|
-
|
|
200
|
+
/** What {@link syncRoles} did. */
|
|
201
|
+
interface SyncRolesResult {
|
|
202
|
+
/** One entry per role whose plan could be made. */
|
|
203
|
+
roles: RoleSyncOutcome[];
|
|
204
|
+
/** Steps that failed; the run carried on past each. */
|
|
205
|
+
failures: Array<{
|
|
206
|
+
step: string;
|
|
207
|
+
message: string;
|
|
208
|
+
}>;
|
|
209
|
+
/** Roles given or taken. */
|
|
210
|
+
ok: number;
|
|
211
|
+
/** Already in sync, left alone, or only previewed. */
|
|
212
|
+
skipped: number;
|
|
533
213
|
}
|
|
214
|
+
/** What a source provider needs to be able to do to feed a role sync, or the reason it cannot. */
|
|
215
|
+
export declare function sourceProblem(source: Source | undefined): string | undefined;
|
|
216
|
+
/** Reads the links file; a file that does not exist yet is an empty one, a damaged one throws. */
|
|
217
|
+
export declare function readLinks(source: Source, layout: NotificationsLayout, org: string | undefined, provider: string): Promise<LinksFile>;
|
|
218
|
+
/**
|
|
219
|
+
* The first role the layout declares for two different teams, or undefined. Names compare ignoring case, as
|
|
220
|
+
* the server does; the role would be synced against one team and then the other, so the last would win.
|
|
221
|
+
*/
|
|
222
|
+
export declare function roleTeamProblem(layout: {
|
|
223
|
+
roles?: ReadonlyArray<{
|
|
224
|
+
name: string;
|
|
225
|
+
team?: string;
|
|
226
|
+
}>;
|
|
227
|
+
}): string | undefined;
|
|
534
228
|
/**
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
229
|
+
* Makes each role's holders equal its team, one role after another. This is the sync itself, with no setup in
|
|
230
|
+
* front of it: the caller has already picked the providers, read the links and checked the layout. `holocron
|
|
231
|
+
* notifications sync-roles` and Sentinel's role sync are two callers of it. A step that fails is recorded and the
|
|
232
|
+
* run goes on; nothing here throws for a provider error. Idempotent: a role that already matches changes nothing.
|
|
233
|
+
* Lines go to `input.print` when it is given, and nowhere otherwise.
|
|
538
234
|
*/
|
|
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
|
|
235
|
+
export declare function syncRoles(input: SyncRolesInput): Promise<SyncRolesResult>;
|
|
544
236
|
/**
|
|
545
237
|
* Derived custom-properties (#677). Unlike the existing 6 GitHub
|
|
546
238
|
* custom-properties fields (`lifecycle`, `open_source`, `runtime_environment`,
|
|
@@ -548,20 +240,19 @@ declare function resolveConfig(raw: HolocronConfig): ResolvedHolocronConfig;
|
|
|
548
240
|
* mirror what `holocron.config.ts` already states explicitly — these four are
|
|
549
241
|
* *derived*: signal that isn't an explicit config field today (framework
|
|
550
242
|
* choice, repo archetype, capability drift). See
|
|
551
|
-
*
|
|
243
|
+
* `docs/wiki/specifications/tech-holocron-platform.spec.md` → "Custom-properties sync — field
|
|
552
244
|
* definitions (#677)" for the full design.
|
|
553
245
|
*/
|
|
554
246
|
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
|
-
}
|
|
247
|
+
/** The `package.json` shape profile derivation reads — `@theholocron/pkg-utils`'s `PackageJson`, under the name Sentinel already imports. */
|
|
248
|
+
type PackageJsonLike = PackageJson;
|
|
249
|
+
/** What profile derivation reads to decide a repo's archetype. */
|
|
562
250
|
interface DeriveProfileInput {
|
|
251
|
+
/** The repo's root `package.json`, or `null` when it has none. */
|
|
563
252
|
rootPackageJson: PackageJsonLike | null;
|
|
253
|
+
/** The repository name, without the owner. */
|
|
564
254
|
repoName: string;
|
|
255
|
+
/** Whether the repo is a monorepo with several workspace packages. */
|
|
565
256
|
isMonorepo: boolean;
|
|
566
257
|
/** `packages/*` package.json contents, monorepo repos only — used to find the primary published artifact. */
|
|
567
258
|
workspacePackageJsons: PackageJsonLike[];
|
|
@@ -588,7 +279,7 @@ interface DeriveProfileInput {
|
|
|
588
279
|
* 6. Private, non-publishable, non-docs → `app`.
|
|
589
280
|
* 7. Otherwise, a single publishable package → `library`.
|
|
590
281
|
*/
|
|
591
|
-
declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
282
|
+
export declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
592
283
|
/**
|
|
593
284
|
* Detected build/framework tooling — the literal "does this repo need
|
|
594
285
|
* next/vite/tsdown" signal `holocron.config.ts` has no field for today
|
|
@@ -596,17 +287,18 @@ declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
|
|
|
596
287
|
* Curated table, not exhaustive by design — add to `KNOWN_STACK_DEPS` as new
|
|
597
288
|
* frameworks show up rather than trying to detect anything on npm.
|
|
598
289
|
*/
|
|
599
|
-
declare function deriveStack(pkg: PackageJsonLike | null): string[];
|
|
290
|
+
export declare function deriveStack(pkg: PackageJsonLike | null): string[];
|
|
600
291
|
/** The provider capability keys actually wired in `providers: {}` — zero heuristics. */
|
|
601
|
-
declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
|
|
602
|
-
|
|
292
|
+
export declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
|
|
293
|
+
/** Whether a repo's capabilities include the required baseline (`source` and `ci`); `non-compliant` means drift. */
|
|
294
|
+
export declare function deriveCompliance(capabilities: readonly string[]): "compliant" | "non-compliant";
|
|
603
295
|
/**
|
|
604
296
|
* The Phase B refinement `deriveCompliance()`'s own doc comment names —
|
|
605
297
|
* *why* a repo is non-compliant, not just that it is. `[]` when compliant.
|
|
606
298
|
* Same `REQUIRED_BASELINE` `deriveCompliance()` checks against — one
|
|
607
299
|
* table, not two independently-maintained baselines.
|
|
608
300
|
*/
|
|
609
|
-
declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
301
|
+
export declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
610
302
|
/**
|
|
611
303
|
* Reads each workspace package's actual `package.json` content (not just
|
|
612
304
|
* `readWorkspacePackages()`'s `{ slug, name, dir }` — `deriveProfile()`'s
|
|
@@ -614,84 +306,33 @@ declare function missingCapabilities(capabilities: readonly string[]): string[];
|
|
|
614
306
|
* Missing/invalid files are skipped, matching `readWorkspacePackages()`'s
|
|
615
307
|
* own soft-fail behavior.
|
|
616
308
|
*/
|
|
617
|
-
declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
providers?: RawProvidersConfig;
|
|
631
|
-
/**
|
|
632
|
-
* Required status-check contexts **not** backed by a `required` task
|
|
633
|
-
* (codecov gates, `Storybook Publish`, …). Unioned across all capabilities
|
|
634
|
-
* onto the top-level `extraRequiredChecks`. Task-backed checks come from
|
|
635
|
-
* `{ required: true }` task entries via `astromech.requiredChecks()`.
|
|
636
|
-
*/
|
|
637
|
-
extraRequiredChecks?: string[];
|
|
638
|
-
/** Repo config fragment. Scalar fields: last writer wins. properties/topics/teams: merged. */
|
|
639
|
-
repo?: Partial<Omit<RepoConfig, "name">>;
|
|
640
|
-
/** Org name. Last writer wins. */
|
|
641
|
-
org?: string;
|
|
642
|
-
/** Org canonical domain. Last writer wins. */
|
|
643
|
-
domain?: string;
|
|
644
|
-
/** Docs site config. Last writer wins. */
|
|
645
|
-
docs?: DocsConfig;
|
|
646
|
-
}
|
|
647
|
-
/** The merged result of a compose() call. Spreads into defineConfig(). */
|
|
648
|
-
interface ComposedPreset {
|
|
649
|
-
tasks: TaskEntry[];
|
|
650
|
-
providers: RawProvidersConfig;
|
|
651
|
-
repo: Partial<Omit<RepoConfig, "name">>;
|
|
652
|
-
/** Non-task required-check contexts, unioned across capabilities. */
|
|
653
|
-
extraRequiredChecks: string[];
|
|
654
|
-
org?: string;
|
|
655
|
-
domain?: string;
|
|
656
|
-
docs?: DocsConfig;
|
|
657
|
-
}
|
|
309
|
+
export declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
|
|
310
|
+
/**
|
|
311
|
+
* The closed list of area files `loadConfig` reads from `.holocron/` (the directory is `.<config name>`, set by kyber):
|
|
312
|
+
* `.holocron/notifications.*` fills `providers.notifications`' `layout`, `.holocron/repo.*` fills keys of `repo`, and `.holocron/org.*` fills provider options (`teamId`, `accountId`) a config leaves out.
|
|
313
|
+
* A file not on this list is never read.
|
|
314
|
+
*/
|
|
315
|
+
export declare const HOLOCRON_AREAS: readonly ["notifications", "repo", "org"];
|
|
316
|
+
/**
|
|
317
|
+
* The areas a config in a subdirectory also reads from the repository root's `.holocron/` (SPEC-0069): only `org`,
|
|
318
|
+
* because its values are the organization's and every config needs them. `repo` and `notifications` describe the
|
|
319
|
+
* repository itself, so an app's config does not take them from the root.
|
|
320
|
+
*/
|
|
321
|
+
export declare const SHARED_AREAS: readonly ["org"];
|
|
658
322
|
/**
|
|
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());
|
|
323
|
+
* Put the area files of `.holocron/` into the config as loaded, before `deriveDefaults` runs: `notifications` becomes
|
|
324
|
+
* 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
|
|
325
|
+
* is a `ConfigError` naming both (no merge, no precedence). With no area files the config is returned as it was.
|
|
678
326
|
*/
|
|
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;
|
|
327
|
+
export declare function placeAreas(areas: ConfigDirArea[], raw: HolocronConfig): HolocronConfig;
|
|
328
|
+
/** What a connection probe needs to check a provider's host and token: kyber's input, with the plugin's `verifyToken` as `verify`. */
|
|
329
|
+
export interface ConnectionProbeInput extends Omit<ConnectionProbeInput$1, "verify"> {
|
|
330
|
+
/** The plugin's `verifyToken`: asks the provider who the token belongs to. */
|
|
331
|
+
verify: (token: string) => Promise<VerifyTokenResult>;
|
|
689
332
|
}
|
|
690
333
|
/**
|
|
691
|
-
*
|
|
692
|
-
*
|
|
693
|
-
* be loaded, or `ConfigError` when the config is invalid.
|
|
334
|
+
* The `connection` probe every provider offers, for telling a network problem from a credential problem. The checks are
|
|
335
|
+
* kyber's `connectionProbe`; this types the result as the plugin system's {@link Probe} and `verify` as `VerifyTokenResult`.
|
|
694
336
|
*/
|
|
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 };
|
|
337
|
+
export declare function connectionProbe(input: ConnectionProbeInput): Probe;
|
|
338
|
+
export { Analytics, type AppConfig, Auth, AuthDescription, AuthError, AuthEvent, AuthEventType, AuthIdentity, AuthUser, BoardField, BoardFieldType, BoardItem, 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, InspectRelayInput, Issue, IssueSearchFilter, 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, ProviderApiError, ProviderIdentity, type ProviderOptions, 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, 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 };
|