starlight-theme-nova 0.3.0 → 0.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-theme-nova",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",

package/src/components/CodeFile.astro

@@ -0,0 +1,64 @@
+---
+import type { ComponentProps } from 'astro/types'
+import { existsSync } from 'node:fs'
+import fs from 'node:fs/promises'
+import { basename } from 'node:path'
+import Code from './Code.astro'
+import config from 'virtual:starlight-theme-nova/user-config'
+import { fileURLToPath } from 'node:url'
+
+type CodeProps = ComponentProps<typeof Code>
+
+interface Props extends Omit<CodeProps, 'code' | 'lang'> {
+  /**
+   * The file path relative to the project root.
+   */
+  path: string
+
+  /**
+   * The title of the file. If not provided, the file name will be used.
+   */
+  title?: string
+
+  /**
+   * The language of the file. If not provided, the file extension will be used.
+   */
+  lang?: CodeProps['lang']
+}
+
+const { path, title, lang, meta, ...rest } = Astro.props
+
+if (!path) {
+  throw new Error('path is required for <CodeFile> component')
+}
+
+const root = new URL(config.rootHref)
+const url = new URL(path, root)
+const absolutePath = fileURLToPath(url)
+if (!existsSync(absolutePath)) {
+  throw new Error(`Unable to find file ${absolutePath}`)
+}
+
+let code: string
+try {
+  code = await fs.readFile(absolutePath, 'utf-8')
+} catch (error) {
+  throw new Error(`Unable to read file ${absolutePath}: ${error}`, {
+    cause: error,
+  })
+}
+
+let fileName = basename(path)
+let defaultLang = (fileName.split('.').pop() || 'plaintext') as 'plaintext'
+let defaultTitle = fileName
+let titleMeta = `title="${title || defaultTitle}"`
+
+const codeProps: CodeProps = {
+  ...rest,
+  lang: lang ?? defaultLang,
+  meta: meta ? `${meta} ${titleMeta}` : titleMeta,
+  code,
+}
+---
+
+<Code {...codeProps} />

package/src/components/index.ts

@@ -1,6 +1,7 @@
 export { default as Code } from './Code.astro'
+export { default as CodeFile } from './CodeFile.astro'
 export { default as CodePackageManagers } from './CodePackageManagers.astro'
-export { default as CodeTabs } from './CodeTabs.astro'
 export { default as CodeTabItem } from './CodeTabItem.astro'
+export { default as CodeTabs } from './CodeTabs.astro'
 export { default as LinkButton } from './LinkButton.astro'
 export { default as LinkCard } from './LinkCard.astro'

package/src/index.ts

@@ -32,7 +32,7 @@ export default function starlightThemeNova(
   return {
     name: 'starlight-theme-nova',
     hooks: {
-      setup({ config, updateConfig, addIntegration }) {
+      setup({ config, updateConfig, addIntegration, astroConfig }) {
         const newConfig = {
           customCss: [
             // Including any user CSS *after* our own.
@@ -58,7 +58,12 @@ export default function starlightThemeNova(
                   shikiConfig: createShikiConfig({ twoslash: true }),
                 },
                 vite: {
-                  plugins: [vitePluginUserConfig(options)],
+                  plugins: [
+                    vitePluginUserConfig({
+                      nav: options.nav,
+                      rootHref: astroConfig.root.toString(),
+                    }),
+                  ],
                 },
               })
             },

package/src/user-options.ts

@@ -6,3 +6,11 @@ export interface NavItem {
 export interface ThemeNovaOptions {
   nav?: NavItem[]
 }
+
+/**
+ * @internal
+ */
+export interface ConfigSerialized {
+  nav?: NavItem[]
+  rootHref: string
+}

package/src/virtual-internal.d.ts

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/consistent-type-imports */
 
 declare module 'virtual:starlight-theme-nova/user-config' {
-  const options: import('./user-options').ThemeNovaOptions
-  export default options
+  const config: import('./user-options').ConfigSerialized
+  export default config
 }
 declare module 'virtual:starlight/components/Search' {
   const Search: typeof import('./components/Search.astro').default

package/src/virtual-user-config.ts

@@ -1,6 +1,6 @@
 import { type ViteUserConfig } from 'astro'
 
-import type { ThemeNovaOptions } from './user-options'
+import type { ConfigSerialized } from './user-options'
 
 function resolveVirtualModuleId<T extends string>(id: T): `\0${T}` {
   return `\0${id}`
@@ -8,11 +8,11 @@ function resolveVirtualModuleId<T extends string>(id: T): `\0${T}` {
 
 /** Vite plugin that exposes user config via virtual modules. */
 export function vitePluginUserConfig(
-  options: ThemeNovaOptions,
+  config: ConfigSerialized,
 ): NonNullable<ViteUserConfig['plugins']>[number] {
   /** Map of virtual module names to their code contents as strings. */
   const modules = {
-    'virtual:starlight-theme-nova/user-config': `export default ${JSON.stringify(options)}`,
+    'virtual:starlight-theme-nova/user-config': `export default ${JSON.stringify(config)}`,
   } satisfies Record<string, string>
 
   /** Mapping names prefixed with `\0` to their original form. */