Use wrap instead

withastro · Aug 8, 2023 · 92f0f0c · 92f0f0c
1 parent 50b58fb
commit 92f0f0c
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 17 deletions.
diff --git a/packages/astro/index.d.ts b/packages/astro/index.d.ts
@@ -1,2 +1,2 @@
-export * from './dist/@types/astro.js'
-export * from './dist/core/index.js'
+export type * from './dist/@types/astro.js';
+export * from './dist/core/index.js';
diff --git a/packages/astro/src/core/build/index.ts b/packages/astro/src/core/build/index.ts
@@ -48,20 +48,19 @@ export interface BuildOptions {
  * Builds your site for deployment. By default, this will generate static files and place them in a dist/ directory.
  * If SSR is enabled, this will generate the necessary server files to serve your site.
  */
-export default async function build(inlineConfig: AstroInlineConfig): Promise<void> {
+export default async function build(
+	inlineConfig: AstroInlineConfig,
+	options?: BuildOptions
+): Promise<void> {
 	applyPolyfill();
 	const logging = createNodeLogging(inlineConfig);
 	const { userConfig, astroConfig } = await resolveConfig(inlineConfig, 'build');
 	telemetry.record(eventCliSession('build', userConfig));
 
 	const settings = createSettings(astroConfig, fileURLToPath(astroConfig.root));
 
-	// Use this hack to prevent the build options being public API
-	// eslint-disable-next-line prefer-rest-params
-	const internalOptions = arguments[1] as BuildOptions | undefined;
-
 	const builder = new AstroBuilder(settings, {
-		...internalOptions,
+		...options,
 		logging,
 		mode: inlineConfig.mode,
 	});

diff --git a/packages/astro/src/core/index.ts b/packages/astro/src/core/index.ts
@@ -1,6 +1,22 @@
 // This is the main entrypoint when importing the `astro` package.
 
-export { default as build } from './build/index.js';
+import type { AstroInlineConfig } from '../@types/astro.js';
+import { default as _build } from './build/index.js';
+import { default as _sync } from './sync/index.js';
+
 export { default as dev } from './dev/index.js';
 export { default as preview } from './preview/index.js';
-export { default as sync } from './sync/index.js';
+
+/**
+ * Builds your site for deployment. By default, this will generate static files and place them in a dist/ directory.
+ * If SSR is enabled, this will generate the necessary server files to serve your site.
+ */
+// Wrap `_build` to prevent exposing the second internal options parameter
+export const build = (inlineConfig: AstroInlineConfig) => _build(inlineConfig);
+
+/**
+ * Generates TypeScript types for all Astro modules. This sets up a `src/env.d.ts` file for type inferencing,
+ * and defines the `astro:content` module for the Content Collections API.
+ */
+// Wrap `_sync` to prevent exposing the second internal options parameter
+export const sync = (inlineConfig: AstroInlineConfig) => _sync(inlineConfig);
diff --git a/packages/astro/src/core/sync/index.ts b/packages/astro/src/core/sync/index.ts
@@ -35,7 +35,10 @@ export type SyncInternalOptions = SyncOptions & {
  * Generates TypeScript types for all Astro modules. This sets up a `src/env.d.ts` file for type inferencing,
  * and defines the `astro:content` module for the Content Collections API.
  */
-export default async function sync(inlineConfig: AstroInlineConfig): Promise<ProcessExit> {
+export default async function sync(
+	inlineConfig: AstroInlineConfig,
+	options?: SyncOptions
+): Promise<ProcessExit> {
 	const logging = createNodeLogging(inlineConfig);
 	const { userConfig, astroConfig } = await resolveConfig(inlineConfig ?? {}, 'sync');
 	telemetry.record(eventCliSession('sync', userConfig));
@@ -48,11 +51,7 @@ export default async function sync(inlineConfig: AstroInlineConfig): Promise<Pro
 		command: 'build',
 	});
 
-	// Use this hack to prevent the sync options being public API
-	// eslint-disable-next-line prefer-rest-params
-	const internalOptions = arguments[1] as SyncOptions | undefined;
-
-	return await syncInternal(settings, { ...internalOptions, logging });
+	return await syncInternal(settings, { ...options, logging });
 }
 
 /**

diff --git a/packages/astro/test/test-utils.js b/packages/astro/test/test-utils.js
@@ -6,7 +6,9 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import stripAnsi from 'strip-ansi';
 import { check } from '../dist/cli/check/index.js';
-import { dev, build, preview, sync } from '../dist/core/index.js';
+import { dev, preview } from '../dist/core/index.js';
+import build from '../dist/core/build/index.js';
+import sync from '../dist/core/sync/index.js';
 import { RESOLVED_SPLIT_MODULE_ID } from '../dist/core/build/plugins/plugin-ssr.js';
 import { getVirtualModulePageNameFromPath } from '../dist/core/build/plugins/util.js';
 import { makeSplitEntryPointFileName } from '../dist/core/build/static-build.js';