@levino/shipyard-base 0.4.1 → 0.5.0

package/astro/components/Footer.astro

@@ -1,17 +1,17 @@
 ---
 interface FooterProps {
   links: {
-    label: string;
-    href: string;
-  }[];
+    label: string
+    href: string
+  }[]
   copyright: {
-    label: string;
-    href: string;
-    year: number;
-  };
+    label: string
+    href: string
+    year: number
+  }
 }
 
-const { links, copyright } = Astro.props as FooterProps;
+const { links, copyright } = Astro.props as FooterProps
 ---
 
 <footer class="flex w-full items-center justify-between px-6 py-4 text-sm font-medium">

package/astro/components/GlobalDesktopNavigation.astro

@@ -1,10 +1,10 @@
 ---
-import type { Config } from "../../src/schemas/config";
-import { cn } from "../../src/tools/cn";
+import type { Config } from '../../src/schemas/config'
+import { cn } from '../../src/tools/cn'
 
-type Props = Pick<Config, "brand" | "navigation"> & { showBrand: boolean };
+type Props = Pick<Config, 'brand' | 'navigation'> & { showBrand: boolean }
 
-const { brand, navigation, showBrand = false } = Astro.props as Props;
+const { brand, navigation, showBrand = false } = Astro.props as Props
 ---
 
 <div class="navbar z-10 bg-base-100">

package/astro/components/LocalNavigation.astro

@@ -1,12 +1,12 @@
 ---
-import SidebarElement from "./SidebarElement.astro";
-import type { Entry } from "./types";
+import SidebarElement from './SidebarElement.astro'
+import type { Entry } from './types'
 
 interface SidebarProps {
-  entry: Entry;
+  entry: Entry
 }
 
-const { entry } = Astro.props as SidebarProps;
+const { entry } = Astro.props as SidebarProps
 ---
 
 <SidebarElement entry={entry} />

package/astro/components/SidebarElement.astro

@@ -1,12 +1,11 @@
 ---
-import type { Entry } from './types';
-
+import type { Entry } from './types'
 
 interface Props {
-  entry: Entry;
+  entry: Entry
 }
 
-const { entry } = Astro.props;
+const { entry } = Astro.props
 ---
 
 {Object.entries(entry).map(([key, entry]) => {

package/astro/components/SidebarNavigation.astro

@@ -1,20 +1,23 @@
 ---
-import { cn } from "../../src/tools/cn";
-import SidebarElement from "./SidebarElement.astro";
-import type { Entry } from "./types";
+import { cn } from '../../src/tools/cn'
+import SidebarElement from './SidebarElement.astro'
+import type { Entry } from './types'
 
 interface Props {
-  local: Entry | undefined;
-  global: Entry;
-  brand: string;
+  local: Entry | undefined
+  global: Entry
+  brand: string
 }
 
-const { local, global, brand } = Astro.props;
+const { local, global, brand } = Astro.props
+
+const withLocale = (path: string) =>
+  Astro.currentLocale ? `/${Astro.currentLocale}${path}` : path
 ---
 
 <ul class={cn("menu min-h-screen w-56 bg-base-100", { "md:hidden": !local })}>
   <div>
-    <a href="/" class="btn btn-ghost mb-2 text-xl">
+    <a href={withLocale("/")} class="btn btn-ghost mb-2 text-xl">
       {brand}
     </a>
   </div>

package/astro/components/TableOfContents.astro

@@ -1,15 +1,15 @@
 ---
 interface Link {
-  depth: number;
-  text: string;
-  slug: string;
+  depth: number
+  text: string
+  slug: string
 }
 
 interface TableOfContentsProps {
-  links: Link[];
+  links: Link[]
 }
 
-const { links } = Astro.props as TableOfContentsProps;
+const { links } = Astro.props as TableOfContentsProps
 ---
 
 <div class="fixed right-0 h-full lg:h-auto lg:overflow-y-visible">

package/astro/layouts/Footer.astro

@@ -1,11 +1,11 @@
 ---
-import { Footer as FooterComponent } from "../components";
-import config from "virtual:shipyard/config";
+import config from 'virtual:shipyard/config'
+import { Footer as FooterComponent } from '../components'
 
-const locale = Astro.currentLocale || config.defaultLocale;
+const locale = Astro.currentLocale || config.defaultLocale
 
 const withLocale = (path: string) =>
-  locale === config.defaultLocale ? path : `/${locale}${path}`;
+  locale === config.defaultLocale ? path : `/${locale}${path}`
 ---
 
 <FooterComponent

package/astro/layouts/Page.astro

@@ -1,30 +1,28 @@
 ---
-import Footer from "./Footer.astro";
-import "../../src/globals.css";
-import config from "virtual:shipyard/config";
-import { GlobalDesktopNavigation, SidebarNavigation } from "../components";
-import type { NavigationTree, NavigationEntry } from "../../src/schemas/config";
-import { mapObjIndexed } from "ramda";
-import { getTitle } from "../../src/tools/title";
+import Footer from './Footer.astro'
+import '../../src/globals.css'
+import config from 'virtual:shipyard/config'
+import { mapObjIndexed } from 'ramda'
+import type { NavigationEntry, NavigationTree } from '../../src/schemas/config'
+import { getTitle } from '../../src/tools/title'
+import { GlobalDesktopNavigation, SidebarNavigation } from '../components'
 
 type Props = {
   frontmatter?: {
-    title?: string;
-    description?: string;
-    sidebarNavigation?: NavigationTree;
-  };
+    title?: string
+    description?: string
+    sidebarNavigation?: NavigationTree
+  }
 } & {
-  title?: string;
-  description?: string;
-  sidebarNavigation?: NavigationTree;
-};
+  title?: string
+  description?: string
+  sidebarNavigation?: NavigationTree
+}
 
-const currentLocale = Astro.currentLocale || config.defaultLocale;
-const currentPath = Astro.url.pathname;
-const props = Astro.props.frontmatter || Astro.props;
+const currentPath = Astro.url.pathname
+const props = Astro.props.frontmatter || Astro.props
 
-const withLocale = (path: string) =>
-  currentLocale === config.defaultLocale ? path : `/${currentLocale}${path}`;
+const withLocale = (path: string) => `/${Astro.currentLocale}${path}`
 const applyLocaleAndSetActive: (navigation: NavigationTree) => NavigationTree =
   mapObjIndexed((entry: NavigationEntry) => ({
     ...entry,
@@ -33,10 +31,10 @@ const applyLocaleAndSetActive: (navigation: NavigationTree) => NavigationTree =
     ...(entry.subEntry
       ? { subEntry: applyLocaleAndSetActive(entry.subEntry) }
       : {}),
-  }));
+  }))
 
-const navigation = applyLocaleAndSetActive(config.navigation);
-const title = getTitle(config.title, props.title);
+const navigation = applyLocaleAndSetActive(config.navigation)
+const title = getTitle(config.title, props.title)
 ---
 
 <html>

package/astro/layouts/Splash.astro

@@ -1,13 +1,13 @@
 ---
-import type { NavigationTree } from '../../src/schemas/config';
+import type { NavigationTree } from '../../src/schemas/config'
 import Base from './Page.astro'
 
 type Props = {
   frontmatter?: {
-    title?: string;
-    description?: string;
-    sidebarNavigation?: NavigationTree;
-  };
+    title?: string
+    description?: string
+    sidebarNavigation?: NavigationTree
+  }
 }
 
 const props = Astro.props

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@levino/shipyard-base",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "type": "module",
   "main": "src/index.ts",
   "exports": {

package/src/globals.css

@@ -1,3 +1,5 @@
+/* biome-ignore-all lint/suspicious/noUnknownAtRules: bug https://github.com/biomejs/biome/issues/7223 */
+
 @tailwind base;
 @tailwind components;
 @tailwind utilities;

package/src/index.ts

@@ -1,16 +1,18 @@
 import type { AstroIntegration } from 'astro'
-import type { Config } from './schemas/config'
+import type { Config, FinalConfig } from './schemas/config'
+
 export type { Entry } from '../astro/components/types'
-export * from './types'
 export type * from './schemas/config'
 export { getTitle } from './tools/title'
+export * from './types'
+
 const shipyardConfigId = 'virtual:shipyard/config'
 
 const resolveId: Record<string, string | undefined> = {
   [shipyardConfigId]: `${shipyardConfigId}`,
 }
 
-const load = (config: Config) =>
+const load = (config: FinalConfig) =>
   ({
     [shipyardConfigId]: `export default ${JSON.stringify(config)}`,
   }) as Record<string, string | undefined>
@@ -18,14 +20,19 @@ const load = (config: Config) =>
 export default (config: Config): AstroIntegration => ({
   name: 'shipyard',
   hooks: {
-    'astro:config:setup': ({ updateConfig }) => {
+    'astro:config:setup': ({ updateConfig, config: { i18n } }) => {
+      if (!i18n) {
+        throw new Error(
+          'Shipyard cannot be used without i18n. Please set at least one locale.',
+        )
+      }
       updateConfig({
         vite: {
           plugins: [
             {
               name: 'shipyard',
               resolveId: (id: string) => resolveId[id],
-              load: (id: string) => load(config)[id],
+              load: (id: string) => load({ i18n, ...config })[id],
             },
           ],
         },

package/src/schemas/config.ts

@@ -1,3 +1,5 @@
+import type { AstroConfig } from 'astro'
+
 export interface NavigationEntry {
   label?: string
   href?: string
@@ -7,11 +9,13 @@ export interface NavigationEntry {
 
 export type NavigationTree = Record<string, NavigationEntry>
 
-export type Config = {
+export interface Config {
   brand: string
   navigation: NavigationTree
   title: string
   tagline: string
-  locales: string[]
-  defaultLocale: string
+}
+
+export interface FinalConfig extends Config {
+  i18n: NonNullable<AstroConfig['i18n']>
 }