refactor: buildOptions.site -> site

withastro · FredKSchott · Apr 2, 2022 · Mar 30, 2022 · Apr 1, 2022 · Apr 1, 2022
commit df642c6f514aaeec43cbf9b125b343d2387f96da
diff --git a/examples/blog-multiple-authors/src/pages/posts/[...page].astro b/examples/blog-multiple-authors/src/pages/posts/[...page].astro
@@ -10,7 +10,7 @@ export async function getStaticPaths({ paginate, rss }) {
  const sortedPosts = allPosts.sort((a, b) => new Date(b.frontmatter.date).valueOf() - new Date(a.frontmatter.date).valueOf());
 
  // Generate an RSS feed from this collection of posts.
- // NOTE: This is disabled by default, since it requires `buildOptions.site` to be set in your "astro.config.mjs" file.
+ // NOTE: This is disabled by default, since it requires `site` to be set in your "astro.config.mjs" file.
  // rss({
  // title: 'Don’s Blog',
  // description: 'An example blog on Astro',

diff --git a/examples/blog/astro.config.mjs b/examples/blog/astro.config.mjs
@@ -4,7 +4,5 @@ import preact from '@astrojs/preact';
 // https://astro.build/config
 export default defineConfig({
  integrations: [preact()],
- buildOptions: {
- site: 'https://example.com/',
- },
+ site: 'https://example.com/',
 });
diff --git a/examples/subpath/astro.config.mjs b/examples/subpath/astro.config.mjs
@@ -4,7 +4,5 @@ import react from '@astrojs/react';
 // https://astro.build/config
 export default defineConfig({
  integrations: [react()],
- buildOptions: {
- site: 'http:https://example.com/blog',
- },
+ site: 'http:https://example.com/blog',
 });
diff --git a/packages/astro/src/core/build/generate.ts b/packages/astro/src/core/build/generate.ts
@@ -151,7 +151,7 @@ async function generatePath(pathname: string, opts: StaticBuildOptions, gopts: G
 
  debug('build', `Generating: ${pathname}`);
 
- const site = astroConfig.buildOptions.site;
+ const site = astroConfig.site;
  const links = createLinkStylesheetElementSet(linkIds.reverse(), site);
  const scripts = createModuleScriptElementWithSrcSet(hoistedId ? [hoistedId] : [], site);
 
@@ -196,7 +196,7 @@ async function generatePath(pathname: string, opts: StaticBuildOptions, gopts: G
  request: createRequest({ url, headers: new Headers(), logging }),
  route: pageData.route,
  routeCache,
- site: astroConfig.buildOptions.site,
+ site: astroConfig.site,
  ssr: isBuildingToSSR(opts.astroConfig),
  };
 

diff --git a/packages/astro/src/core/build/index.ts b/packages/astro/src/core/build/index.ts
@@ -42,7 +42,7 @@ class AstroBuilder {
  private timer: Record<string, number>;
 
  constructor(config: AstroConfig, options: BuildOptions) {
- if (!config.buildOptions.site && config.buildOptions.sitemap !== false) {
+ if (!config.site && config.buildOptions.sitemap !== false) {
  warn(options.logging, 'config', `Set "buildOptions.site" to generate correct canonical URLs and sitemap`);
  }
  if (options.mode) {
@@ -52,7 +52,7 @@ class AstroBuilder {
  const port = config.devOptions.port; // no need to save this (don’t rely on port in builder)
  this.logging = options.logging;
  this.routeCache = new RouteCache(this.logging);
- this.origin = config.buildOptions.site ? new URL(config.buildOptions.site).origin : `http:https://localhost:${port}`;
+ this.origin = config.site ? new URL(config.site).origin : `http:https://localhost:${port}`;
  this.manifest = createRouteManifest({ config }, this.logging);
  this.timer = {};
  }
@@ -164,11 +164,11 @@ class AstroBuilder {
  debug('build', timerMessage('Additional assets copied', this.timer.assetsStart));
 
  // Build your final sitemap.
- if (this.config.buildOptions.sitemap && this.config.buildOptions.site) {
+ if (this.config.buildOptions.sitemap && this.config.site) {
  this.timer.sitemapStart = performance.now();
  const sitemapFilter = this.config.buildOptions.sitemapFilter ? (this.config.buildOptions.sitemapFilter as (page: string) => boolean) : undefined;
  const sitemap = generateSitemap(
- pageNames.map((pageName) => new URL(pageName, this.config.buildOptions.site).href),
+ pageNames.map((pageName) => new URL(pageName, this.config.site).href),
  sitemapFilter
  );
  const sitemapPath = new URL('./sitemap.xml', this.config.dist);

diff --git a/packages/astro/src/core/build/page-data.ts b/packages/astro/src/core/build/page-data.ts
@@ -100,7 +100,7 @@ export async function collectPagesData(opts: CollectPagesDataOptions): Promise<C
  debug('build', `├── ${colors.bold(colors.red('✗'))} ${route.component}`);
  throw err;
  });
- const rssFn = generateRssFunction(astroConfig.buildOptions.site, route);
+ const rssFn = generateRssFunction(astroConfig.site, route);
  for (const rssCallArg of result.rss) {
  const rssResult = rssFn(rssCallArg);
  if (rssResult.xml) {

diff --git a/packages/astro/src/core/build/scan-based-build.ts b/packages/astro/src/core/build/scan-based-build.ts
@@ -84,6 +84,6 @@ export async function build(opts: ScanBasedBuildOptions): Promise<RollupOutput |
  root: viteConfig.root,
  envPrefix: 'PUBLIC_',
  server: viteConfig.server,
- base: astroConfig.buildOptions.site ? new URL(astroConfig.buildOptions.site).pathname : '/',
+ base: astroConfig.site ? new URL(astroConfig.site).pathname : '/',
  });
 }
diff --git a/packages/astro/src/core/build/static-build.ts b/packages/astro/src/core/build/static-build.ts
@@ -155,7 +155,7 @@ async function ssrBuild(opts: StaticBuildOptions, internals: BuildInternals, inp
  root: viteConfig.root,
  envPrefix: 'PUBLIC_',
  server: viteConfig.server,
- base: astroConfig.buildOptions.site ? new URL(astroConfig.buildOptions.site).pathname : '/',
+ base: astroConfig.site ? new URL(astroConfig.site).pathname : '/',
  ssr: viteConfig.ssr,
  resolve: viteConfig.resolve,
  } as ViteConfigWithSSR;
@@ -218,7 +218,7 @@ async function clientBuild(opts: StaticBuildOptions, internals: BuildInternals,
  root: viteConfig.root,
  envPrefix: 'PUBLIC_',
  server: viteConfig.server,
- base: appendForwardSlash(astroConfig.buildOptions.site ? new URL(astroConfig.buildOptions.site).pathname : '/'),
+ base: astroConfig.base,
  } as ViteConfigWithSSR;
 
  await runHookBuildSetup({ config: astroConfig, vite: viteBuildConfig, target: 'client' });

diff --git a/packages/astro/src/core/build/vite-plugin-ssr.ts b/packages/astro/src/core/build/vite-plugin-ssr.ts
@@ -95,7 +95,7 @@ function buildManifest(opts: StaticBuildOptions, internals: BuildInternals): Ser
 
  const ssrManifest: SerializedSSRManifest = {
  routes,
- site: astroConfig.buildOptions.site,
+ site: astroConfig.site,
  markdown: {
  render: astroConfig.markdownOptions.render,
  },

diff --git a/packages/astro/src/core/dev/index.ts b/packages/astro/src/core/dev/index.ts
@@ -39,7 +39,7 @@ export default async function dev(config: AstroConfig, options: DevOptions = { l
  await viteServer.listen(config.devOptions.port);
 
  const devServerAddressInfo = viteServer.httpServer!.address() as AddressInfo;
- const site = config.buildOptions.site ? new URL(config.buildOptions.site) : undefined;
+ const site = config.site ? new URL(config.site) : undefined;
  info(options.logging, null, msg.devStart({ startupTime: performance.now() - devStart, config, devServerAddressInfo, site, https: !!viteConfig.server?.https }));
 
  const currentVersion = process.env.PACKAGE_VERSION ?? '0.0.0';

diff --git a/packages/astro/src/core/preview/index.ts b/packages/astro/src/core/preview/index.ts
@@ -29,7 +29,7 @@ export default async function preview(config: AstroConfig, { logging }: PreviewO
  const defaultOrigin = 'http:https://localhost';
  const trailingSlash = config.devOptions.trailingSlash;
  /** Base request URL. */
- let baseURL = new URL(config.buildOptions.site || '/', defaultOrigin);
+ let baseURL = new URL(config.site || '/', defaultOrigin);
  const staticFileServer = sirv(fileURLToPath(config.dist), {
  dev: true,
  etag: true,

diff --git a/packages/astro/src/core/render/dev/index.ts b/packages/astro/src/core/render/dev/index.ts
@@ -147,7 +147,7 @@ export async function render(renderers: SSRLoadedRenderer[], mod: ComponentInsta
  request,
  route,
  routeCache,
- site: astroConfig.buildOptions.site,
+ site: astroConfig.site,
  ssr: isBuildingToSSR(astroConfig),
  });
 

diff --git a/packages/astro/src/core/render/rss.ts b/packages/astro/src/core/render/rss.ts
@@ -87,7 +87,7 @@ export function generateRSSStylesheet() {
 export function generateRssFunction(site: string | undefined, route: RouteData): RSSFunction {
  return function rssUtility(args: RSS): RSSResult {
  if (!site) {
- throw new Error(`[${route.component}] rss() tried to generate RSS but "buildOptions.site" missing in astro.config.mjs`);
+ throw new Error(`[${route.component}] rss() tried to generate RSS but "site" missing in astro.config.mjs`);
  }
  let result: RSSResult = {} as any;
  const { dest, ...rssData } = args;

diff --git a/packages/astro/src/core/util.ts b/packages/astro/src/core/util.ts
@@ -157,7 +157,7 @@ export function isBuildingToSSR(config: AstroConfig): boolean {
  if (!adapter) return false;
 
  if (typeof adapter.serverEntrypoint === 'string') {
- if (!adapter.name.startsWith('@astrojs/') && !config.buildOptions.experimentalSsr) {
+ if (!adapter.name.startsWith('@astrojs/') && !config.experimental.ssr) {
  throw new Error(
  [
  `Server-side rendering (SSR) is still experimental.`,

diff --git a/packages/astro/src/template/4xx.ts b/packages/astro/src/template/4xx.ts
@@ -64,7 +64,7 @@ export function subpathNotUsedTemplate(base: string, pathname: string) {
  statusCode: 404,
  title: 'Not found',
  tabTitle: '404: Not Found',
- body: `<p>In your <code>buildOptions.site</code> you have your base path set to <a href="${base}">${base}</a>. Do you want to go there instead?</p>
+ body: `<p>In your <code>site</code> you have your base path set to <a href="${base}">${base}</a>. Do you want to go there instead?</p>
 <p>Come to our <a href="https://astro.build/chat">Discord</a> if you need help.</p>`,
  });
 }

diff --git a/packages/astro/src/vite-plugin-astro-server/index.ts b/packages/astro/src/vite-plugin-astro-server/index.ts
@@ -74,7 +74,7 @@ async function writeSSRResult(result: RenderResponse, res: http.ServerResponse,
 }
 
 async function handle404Response(origin: string, config: AstroConfig, req: http.IncomingMessage, res: http.ServerResponse) {
- const site = config.buildOptions.site ? new URL(config.buildOptions.site) : undefined;
+ const site = config.site ? new URL(config.site) : undefined;
  const devRoot = site ? site.pathname : '/';
  const pathname = decodeURI(new URL(origin + req.url).pathname);
  let html = '';
@@ -120,7 +120,7 @@ async function handleRequest(
  res: http.ServerResponse
 ) {
  const reqStart = performance.now();
- const site = config.buildOptions.site ? new URL(config.buildOptions.site) : undefined;
+ const site = config.site ? new URL(config.site) : undefined;
  const devRoot = site ? site.pathname : '/';
  const origin = `${viteServer.config.server.https ? 'https' : 'http'}:https://${req.headers.host}`;
  const buildingToSSR = isBuildingToSSR(config);

diff --git a/packages/astro/src/vite-plugin-astro/compile.ts b/packages/astro/src/vite-plugin-astro/compile.ts
@@ -48,7 +48,7 @@ async function compile(config: AstroConfig, filename: string, source: string, vi
  const transformResult = await transform(source, {
  pathname,
  projectRoot: config.root.toString(),
- site: config.buildOptions.site,
+ site: config.site,
  sourcefile: filename,
  sourcemap: 'both',
  internalURL: `/@fs${prependForwardSlash(viteID(new URL('../runtime/server/index.js', import.meta.url)))}`,

diff --git a/packages/astro/src/vite-plugin-markdown/index.ts b/packages/astro/src/vite-plugin-markdown/index.ts
@@ -79,7 +79,7 @@ export default function markdown({ config }: AstroPluginOptions): Plugin {
  // Return the file's JS representation, including all Markdown
  // frontmatter and a deferred `import() of the compiled markdown content.
  if (id.startsWith(VIRTUAL_MODULE_ID)) {
- const sitePathname = config.buildOptions.site ? new URL(config.buildOptions.site).pathname : '/';
+ const sitePathname = config.site ? new URL(config.site).pathname : '/';
  const fileId = id.substring(VIRTUAL_MODULE_ID.length);
  const fileUrl = fileId.includes('/pages/') ? fileId.replace(/^.*\/pages\//, sitePathname).replace(/(\/index)?\.md$/, '') : undefined;
  const source = await fs.promises.readFile(fileId, 'utf8');
@@ -153,7 +153,7 @@ ${setup}`.trim();
  let { code: tsResult } = await transform(astroResult, {
  pathname: fileUrl.pathname.substr(config.root.pathname.length - 1),
  projectRoot: config.root.toString(),
- site: config.buildOptions.site,
+ site: config.site,
  sourcefile: id,
  sourcemap: 'inline',
  internalURL: `/@fs${new URL('../runtime/server/index.js', import.meta.url).pathname}`,

diff --git a/packages/astro/test/dev-routing.test.js b/packages/astro/test/dev-routing.test.js
@@ -52,11 +52,9 @@ describe('Development Routing', () => {
 
  before(async () => {
  fixture = await loadFixture({
- projectRoot: './fixtures/with-subpath-no-trailing-slash/',
+ root: './fixtures/with-subpath-no-trailing-slash/',
  dist: './dist-4007',
- buildOptions: {
- site: 'http:https://example.com/',
- },
+ site: 'http:https://example.com/',
  });
  devServer = await fixture.startDevServer();
  });
@@ -94,11 +92,9 @@ describe('Development Routing', () => {
 
  before(async () => {
  fixture = await loadFixture({
- projectRoot: './fixtures/with-subpath-no-trailing-slash/',
+ root: './fixtures/with-subpath-no-trailing-slash/',
  dist: './dist-4008',
- buildOptions: {
- site: 'http:https://example.com/blog/',
- },
+ site: 'http:https://example.com/blog/',
  });
  devServer = await fixture.startDevServer();
  });
@@ -195,10 +191,8 @@ describe('Development Routing', () => {
 
  before(async () => {
  fixture = await loadFixture({
- projectRoot: './fixtures/with-endpoint-routes/',
- buildOptions: {
- site: 'http:https://example.com/',
- },
+ root: './fixtures/with-endpoint-routes/',
+ site: 'http:https://example.com/',
  });
  devServer = await fixture.startDevServer();
  });

diff --git a/packages/astro/test/fixtures/static build/astro.config.mjs b/packages/astro/test/fixtures/static build/astro.config.mjs
@@ -4,10 +4,8 @@ import preact from '@astrojs/preact';
 // https://astro.build/config
 export default defineConfig({
  integrations: [preact()],
- buildOptions: {
- site: 'http:https://example.com/subpath/',
- },
+ site: 'http:https://example.com/subpath/',
  ssr: {
  noExternal: ['@test/static-build-pkg'],
  },
-});
+});
diff --git a/packages/astro/test/fixtures/static-build-page-url-format/astro.config.mjs b/packages/astro/test/fixtures/static-build-page-url-format/astro.config.mjs
@@ -2,8 +2,8 @@ import { defineConfig } from 'astro/config';
 
 // https://astro.build/config
 export default defineConfig({
- buildOptions: {
-  site: 'http:https://example.com/subpath/',
- pageUrlFormat: 'file',
+ site: 'http:https://example.com/subpath/',
+ build: {
+ format: 'file',
  },
-});
+});
diff --git a/packages/astro/test/fixtures/with-subpath-no-trailing-slash/astro.config.mjs b/packages/astro/test/fixtures/with-subpath-no-trailing-slash/astro.config.mjs
@@ -1,6 +1,4 @@
 
 export default {
- buildOptions: {
- site: 'http:https://example.com/blog'
- }
+ site: 'http:https://example.com/blog',
 }
diff --git a/packages/integrations/netlify/src/index.ts b/packages/integrations/netlify/src/index.ts
@@ -28,7 +28,7 @@ function netlifyFunctions({ dist }: NetlifyFunctionsOptions = {}): AstroIntegrat
  }
  },
  'astro:config:done': ({ config, setAdapter }) => {
- setAdapter(getAdapter(config.buildOptions.site));
+ setAdapter(getAdapter(config.site));
  _config = config;
  },
  'astro:build:start': async ({ buildConfig }) => {

diff --git a/packages/integrations/sitemap/README.md b/packages/integrations/sitemap/README.md
@@ -50,7 +50,7 @@ export default {
 
 ## Getting started
 
-`@astrojs/sitemap` requires a deployment / site URL for generation. Add your site's URL under your `astro.config.*` using the `buildOptions.site` property:
+`@astrojs/sitemap` requires a deployment / site URL for generation. Add your site's URL under your `astro.config.*` using the `site` property:
 
 __astro.config.mjs__
 
@@ -59,9 +59,7 @@ import sitemap from '@astrojs/sitemap';
 
 export default {
  // ...
- buildOptions: {
- site: 'https://stargazers.club',
- },
+ site: 'https://stargazers.club',
  integrations: [sitemap()],
 }
 ```

diff --git a/packages/integrations/sitemap/src/index.ts b/packages/integrations/sitemap/src/index.ts
@@ -25,7 +25,7 @@ export default function createPlugin(): AstroIntegration {
  config = _config;
  },
  'astro:build:done': async ({ pages, dir }) => {
- const finalSiteUrl = config.buildOptions.site;
+ const finalSiteUrl = config.site;
  if (!finalSiteUrl) {
  return;
  }