refactor: rename config.basePath to config.base

This change provides conformance with the vite setting.
blinkk · Dec 5, 2023 · b63a573 · b63a573
1 parent 624453f
commit b63a573
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/examples/basepath/root.config.ts b/examples/basepath/root.config.ts
@@ -5,7 +5,7 @@ import {defineConfig} from '@blinkk/root';
 const rootDir = new URL('.', import.meta.url).pathname;;
 
 export default defineConfig({
-  basePath: '/foo/',
+  base: '/foo/',
   i18n: {
     urlFormat: '/intl/[locale]/[base]/[path]',
     locales: ['en', 'de'],

diff --git a/packages/root-cms/core/app.tsx b/packages/root-cms/core/app.tsx
@@ -77,7 +77,7 @@ export async function renderApp(req: Request, res: Response, options: any) {
       projectId: cmsConfig.id || 'default',
       projectName: cmsConfig.name || cmsConfig.id || '',
       domain: rootConfig.domain || 'https://example.com',
-      basePath: rootConfig.basePath || '/',
+      base: rootConfig.base || '/',
       gci: gci,
       i18n: rootConfig.i18n,
     },

diff --git a/packages/root-cms/ui/ui.tsx b/packages/root-cms/ui/ui.tsx
@@ -34,7 +34,7 @@ declare global {
         projectId: string;
         projectName: string;
         domain: string;
-        basePath: string;
+        base: string;
         gci: string | boolean;
         i18n: {
           locales?: string[];

diff --git a/packages/root-cms/ui/utils/doc-urls.ts b/packages/root-cms/ui/utils/doc-urls.ts
@@ -19,7 +19,7 @@ export function getDocServingPath(options: DocUrlOptions) {
   }
 
   const rootConfig = window.__ROOT_CTX.rootConfig;
-  const basePath = rootConfig.basePath || '/';
+  const basePath = rootConfig.base || '/';
   let urlFormat = '/[base]/[path]';
   if (locale) {
     urlFormat = rootConfig.i18n.urlFormat || '/[locale]/[base]/[path]';
@@ -60,7 +60,7 @@ export function getDocPreviewPath(options: DocUrlOptions) {
   }
 
   const rootConfig = window.__ROOT_CTX.rootConfig;
-  const basePath = rootConfig.basePath || '/';
+  const basePath = rootConfig.base || '/';
   let urlFormat = '/[base]/[path]';
   if (locale) {
     urlFormat = rootConfig.i18n.urlFormat || '/[locale]/[base]/[path]';

diff --git a/packages/root/src/cli/commands/dev.ts b/packages/root/src/cli/commands/dev.ts
@@ -40,7 +40,7 @@ export async function dev(rootProjectDir?: string, options?: DevOptions) {
   const port = await findOpenPort(defaultPort, defaultPort + 10);
   const server = await createDevServer({rootDir, port});
   const rootConfig: RootConfig = server.get('rootConfig');
-  const basePath = rootConfig.basePath || '';
+  const basePath = rootConfig.base || '';
   console.log();
   console.log(`${dim('┃')} project:  ${rootDir}`);
   console.log(`${dim('┃')} server:   http://${host}:${port}${basePath}`);

diff --git a/packages/root/src/core/config.ts b/packages/root/src/core/config.ts
@@ -14,9 +14,9 @@ export interface RootUserConfig {
   domain?: string;
 
   /**
-   * The base url path that the site will serve on. Defaults to `/`;
+   * The base URL path that the site will serve on. Defaults to `/`;
    */
-  basePath?: string;
+  base?: string;
 
   /**
    * Config for auto-injecting custom element dependencies.

diff --git a/packages/root/src/render/router.ts b/packages/root/src/render/router.ts
@@ -7,7 +7,7 @@ import {RouteTrie} from './route-trie';
 
 export function getRoutes(rootConfig: RootConfig) {
   const locales = rootConfig.i18n?.locales || [];
-  const basePath = rootConfig.basePath || '/';
+  const basePath = rootConfig.base || '/';
 
   const defaultLocale = rootConfig.i18n?.defaultLocale || 'en';