@purview-dev/astroc4 1.0.0-prerelease.5 → 1.0.0-prerelease.7

package/dist/index.d.ts

@@ -2,78 +2,41 @@ import type { StarlightPlugin } from '@astrojs/starlight/types';
 import type { AstroIntegration } from 'astro';
 import { missingOptimizedDependencies } from './integration.js';
 import type { LikeC4IntegrationOptions } from './integration.js';
-/**
- * Re-exported for the Starlight entry point's callers and tests: the merge that
- * keeps `react/compiler-runtime` in the site's optimized dependencies is part of
- * both entry points' behaviour, and both are asserted against this function.
- */
 export { missingOptimizedDependencies };
-/**
- * LikeC4 syntax highlighting, derived from the Langium grammar in
- * `likec4/likec4` and registered with the site's Expressive Code.
- */
 export interface LikeC4HighlightingOptions {
-    /**
-     * Branch, tag or commit SHA to read `like-c4.langium` from.
-     * Defaults to `main`; pin a tag (`v1.59.4`) or a SHA for reproducible CI.
-     * Also read from `ASTROC4_REF`.
-     */
+    /** Branch, tag or commit SHA of `likec4/likec4`. Defaults to `main`; also `ASTROC4_REF`. */
     ref?: string;
-    /** Repository to read from. Defaults to `likec4/likec4`. */
+    /** Defaults to `likec4/likec4`. */
     repo?: string;
     /** Use the bundled snapshot and never touch the network. Also `ASTROC4_OFFLINE=1`. */
     offline?: boolean;
-    /**
-     * What to do when the grammar cannot be fetched. Defaults to `fail`, so
-     * `astro build` and `astro check` fail like any other build error.
-     * A `ref` that does not exist always fails.
-     */
+    /** When the grammar cannot be fetched. Defaults to `fail`; a `ref` that does not exist always fails. */
     onError?: 'fail' | 'warn' | 'silent';
-    /** Seconds a cached fetch stays fresh. Defaults to an hour. */
+    /** Seconds a cached fetch stays fresh. Defaults to 3600. */
     cacheTtl?: number;
     /** Ignore the cache and refetch. */
     refresh?: boolean;
-    /** Where to cache. Defaults to `node_modules/.cache/astroc4`. */
+    /** Defaults to `node_modules/.cache/astroc4`. */
     cacheDir?: string;
-    /** Raw host to read from, for mirrors. Defaults to raw.githubusercontent.com. */
+    /** Raw host to read from. Defaults to `https://raw.githubusercontent.com`. */
     baseUrl?: string;
     /** Request timeout in milliseconds. Defaults to 15000. */
     timeout?: number;
 }
-/**
- * The Starlight plugin's options: the integration's, plus the Starlight-only
- * highlighting injection.
- */
 export interface StarlightLikeC4Options extends LikeC4IntegrationOptions {
-    /**
-     * Highlight ```c4 / ```likec4 source. Defaults to `true`; `false` leaves
-     * Expressive Code entirely to the site.
-     */
+    /** Highlight ```c4 / ```likec4 source. Defaults to `true`; `false` leaves Expressive Code to the site. */
     highlighting?: boolean | LikeC4HighlightingOptions;
 }
 /**
- * The Starlight plugin **and** the Astro integration: one object, two hook sets.
- *
- * Starlight calls `config:setup` and `i18n:setup` on a plugin; Astro calls only
- * `astro:*` hooks on something in `integrations`. Since the sets are disjoint,
- * carrying both is safe — and it is what makes `astro add`'s automatic wiring
- * (`integrations: [astroc4()]`, from the `astro-integration` keyword and the
- * default export) produce a working site.
+ * A Starlight plugin and an Astro integration in one object. The hook sets are
+ * disjoint, so `astro add`'s `integrations: [astroc4()]` works too.
  */
 export type LikeC4StarlightPlugin = StarlightPlugin & Pick<AstroIntegration, 'hooks'>;
 export default function starlightLikeC4(options?: StarlightLikeC4Options): LikeC4StarlightPlugin;
 /**
- * Add the LikeC4 language to a site's Expressive Code options without
- * disturbing anything already set.
- *
- * Replacing an existing entry rather than appending matters: a site that
- * pinned `likec4Language` from `@purview-dev/astroc4/expressive-code` should get the
- * grammar for the ref it configured here, not two grammars for the same scope.
- * Expressive Code concatenates `shiki.langs` when it merges these options with
- * an `ec.config.mjs`, so a site's own languages survive either way.
- *
- * @param expressiveCode The site's `expressiveCode` option.
- * @param registration Shiki language registration.
+ * The site's Expressive Code options plus the LikeC4 language. Starlight's
+ * `updateConfig` merges shallowly, so existing options are carried over; an
+ * existing LikeC4 entry is replaced so the configured ref wins.
  */
 export declare function withLikeC4Language(expressiveCode: unknown, registration: Record<string, unknown>): Record<string, unknown> & {
     shiki: {