@umami/shiso 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to `@umami/shiso` are documented here. This project follows
 [Semantic Versioning](https://semver.org/).
 
+## 2.0.0 - 2026-08-21
+
+### Breaking
+
+- Move project settings (`docsPrefix`, `contentDir`, `siteUrl`, `locale`) from
+  the `$shiso` key in docs.json to a new optional `shiso.config.ts` file at the
+  project root. `shiso check` now rejects docs.json files that still contain
+  `$shiso` with a migration message.
+
+### Added
+
+- New `@umami/shiso/config` export providing `defineConfig` and the
+  `ShisoConfig` type for shiso.config.ts.
+- `shiso.config.ts`, `shiso.config.mjs`, and `shiso.config.js` are supported;
+  the file is optional and defaults apply when absent. Config edits (and
+  creating the file) hot-reload during development.
+
 ## 1.1.11 - 2026-08-19
 
 ### Changed

package/bin/shiso.mjs

@@ -5,6 +5,7 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 import process from 'node:process';
 import { fileURLToPath } from 'node:url';
+import { loadShisoConfig } from '../scripts/load-shiso-config.mjs';
 import { validateProject } from '../scripts/validate-config.mjs';
 
 const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
@@ -22,7 +23,7 @@ Commands:
   dev       Start the development server
   build     Validate and build the static site
   preview   Preview the production build
-  check     Validate docs.json
+  check     Validate docs.json and shiso.config
 
 Options after dev, build, or preview are passed to Vite.
 `;
@@ -55,6 +56,13 @@ async function check(projectRoot) {
   }
 
   console.log('docs.json is valid.');
+
+  // Fails fast on a broken shiso.config.* before any Vite build starts.
+  const shiso = await loadShisoConfig({ root: projectRoot });
+
+  if (shiso.sourcePath) {
+    console.log(`${path.basename(shiso.sourcePath)} loaded.`);
+  }
 }
 
 async function main() {
@@ -116,6 +124,7 @@ async function main() {
       projectRoot,
     );
     run(process.execPath, [path.join(PACKAGE_ROOT, 'scripts/prerender.mjs')], projectRoot);
+    run(process.execPath, [path.join(PACKAGE_ROOT, 'scripts/pagefind-index.mjs')], projectRoot);
     return;
   }
 

package/config.js

@@ -0,0 +1,8 @@
+/**
+ * Identity helper that gives shiso.config.ts typing today and room for future
+ * config forms (functions, plugins) without another migration. Ships as plain
+ * JS so it resolves under Node and jiti with no build step or dependencies.
+ */
+export function defineConfig(config) {
+  return config;
+}