@theholocron/cli 3.5.3 → 3.6.0

package/README.md

@@ -9,7 +9,7 @@ spinning up and operating software projects.
 
 <!-- prettier-ignore -->
 ```bash
-npm i -g @theholocron/cli@alpha
+pnpm add -g @theholocron/cli@alpha
 holocron --help
 
 ```

package/dist/capabilities/index.d.mts

@@ -157,6 +157,26 @@ interface Source extends ProviderIdentity {
    * Optional — providers that don't support setting a homepage omit this.
    */
   syncHomepage?(homepage: string): Promise<string>;
+  /**
+   * Enable or update GitHub Pages for the repository.
+   * Idempotent: POST to create, PUT to update existing settings.
+   * Requires HOLOCRON_DEPLOY_TOKEN (pages:write + repo scope) — passed
+   * explicitly because it is a different PAT from the main admin token.
+   * Optional — providers without a Pages concept omit this.
+   */
+  configurePages?(config: PagesConfig, token: string): Promise<void>;
+}
+interface PagesConfig {
+  /** GitHub Pages build source. */
+  build: "workflow" | "branch";
+  /**
+   * Custom domain / CNAME (e.g. "docs.theholocron.dev").
+   * When set and `homepage` is absent in holocron.config, setup derives
+   * homepage as `https://{domain}/`.
+   */
+  domain?: string;
+  /** Enforce HTTPS. Only effective once the custom domain is DNS-verified. */
+  https?: boolean;
 }
 type CiRunStatus = "queued" | "in_progress" | "completed" | "cancelled" | "failure" | "success" | "skipped";
 interface CiRun {
@@ -571,4 +591,4 @@ type CardinalityFor<K extends CapabilityKey> = (typeof CARDINALITY)[K];
 type ResolvedCapability<K extends CapabilityKey> = CardinalityFor<K> extends "many" ? CapabilityImpls[K][] : CapabilityImpls[K];
 declare function isMulti<K extends CapabilityKey>(key: K): CardinalityFor<K> extends "many" ? true : false;
 //#endregion
-export { Analytics, Auth, AuthDescription, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, Ci, CiRun, CiRunFilter, CiRunStatus, ConnectionStringOptions, CreateAuthUserInput, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, Dns, DnsRecord, DnsRecordType, EnsureResult, Environment, EnvironmentReviewer, Environments, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, NormalizedAuthUser, Notifications, Observability, ParseWebhookInput, ProviderApiError, ProviderIdentity, REQUIRED_CAPABILITIES, RepoRef, RepoSettings, ResolvedCapability, Ruleset, SecretScope, Secrets, Source, StatusCategory, Storage, StorageBranch, TeamEntry, TeamPermission, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, WebhookDashboardInfo, WebhookVerificationError, isMulti };
+export { Analytics, Auth, AuthDescription, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, Ci, CiRun, CiRunFilter, CiRunStatus, ConnectionStringOptions, CreateAuthUserInput, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, Dns, DnsRecord, DnsRecordType, EnsureResult, Environment, EnvironmentReviewer, Environments, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, NormalizedAuthUser, Notifications, Observability, PagesConfig, ParseWebhookInput, ProviderApiError, ProviderIdentity, REQUIRED_CAPABILITIES, RepoRef, RepoSettings, ResolvedCapability, Ruleset, SecretScope, Secrets, Source, StatusCategory, Storage, StorageBranch, TeamEntry, TeamPermission, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, WebhookDashboardInfo, WebhookVerificationError, isMulti };

package/dist/cli.mjs

@@ -248,17 +248,24 @@ function resolveConfig(raw) {
 		providers[key] = resolveEntry(key, entry);
 	}
 	for (const required of REQUIRED_CAPABILITIES) if (!providers[required]) throw new ConfigError(`required capability \`${required}\` is missing from providers`);
+	let docs;
+	if (raw.docs !== void 0) {
+		if (!raw.docs.build) throw new ConfigError("`docs.build` is required when `docs` is set");
+		docs = raw.docs;
+	}
+	const homepage = raw.homepage ?? (docs?.domain ? `https://${docs.domain}/` : void 0);
 	return {
 		name: raw.name,
 		description: raw.description,
-		homepage: raw.homepage,
+		homepage,
 		repo: raw.repo,
 		workflows: raw.workflows,
 		providers,
 		apps: raw.apps ?? [],
 		doctor: raw.doctor ?? {},
 		agent: raw.agent,
-		skills: raw.skills
+		skills: raw.skills,
+		docs
 	};
 }
 //#endregion
@@ -2629,7 +2636,7 @@ function editorconfigContent() {
 		`indent_style = space`,
 		`indent_size = 2`,
 		``,
-		`[*.md]`,
+		`[*.{md,mdx}]`,
 		`trim_trailing_whitespace = false`,
 		`indent_style = space`,
 		`indent_size = 2`,
@@ -2713,7 +2720,11 @@ const EDITORCONFIG_CHECKER_CONFIG = JSON.stringify({
 	IgnoreDefaults: false,
 	SpacesAfterTabs: false,
 	NoColor: false,
-	Exclude: ["(^|.+/)LICENSE$", "^public/.*"],
+	Exclude: [
+		"(^|.+/)LICENSE$",
+		"^public/.*",
+		"\\.mdx$"
+	],
 	AllowedContentTypes: [],
 	PassedFiles: [],
 	Disable: {
@@ -3169,6 +3180,29 @@ async function runSetup(input) {
 			print(formatStep(steps[steps.length - 1]));
 		}
 	}
+	if (loader.has("source") && config.docs) {
+		const source = loader.get("source");
+		const deployToken = process.env.HOLOCRON_DEPLOY_TOKEN;
+		print(style.step("docs"));
+		if (!deployToken) {
+			steps.push({
+				capability: "source",
+				step: "configure GitHub Pages",
+				status: "skip",
+				message: "HOLOCRON_DEPLOY_TOKEN not set — skipping Pages setup"
+			});
+			print(formatStep(steps[steps.length - 1]));
+		} else if (source.configurePages) {
+			steps.push(await runStep("source", "configure GitHub Pages", dryRun, async () => {
+				await source.configurePages(config.docs, deployToken);
+				const parts = [config.docs.build];
+				if (config.docs.domain) parts.push(`domain: ${config.docs.domain}`);
+				if (config.docs.https) parts.push("https: enforced");
+				return parts.join(", ");
+			}));
+			print(formatStep(steps[steps.length - 1]));
+		}
+	}
 	if (loader.has("deployment")) {
 		const deploy = loader.get("deployment");
 		print(style.step("deployment"));