feat(bundler): define BundlerConfig public API by killagu · Pull Request #5882 · eggjs/egg

killagu · 2026-04-21T15:19:56Z

Exports BundlerConfig type and bundle() function from src/index.ts. bundle() currently throws 'Not yet implemented' — wired in C8 (Bundler orchestrator). Adds test/index.test.ts smoke test.

Part of #5863 split. Tracking: #5871.

🤖 Generated with Claude Code

Introduce the BundlerConfig type surface that subsequent commits (Bundler orchestration + egg-bin CLI wrapper) will consume. bundle() still throws until the orchestration lands. Also re-export ExternalsResolver and ManifestLoader from the package entry so consumers can reach them directly from '@eggjs/egg-bundler'. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-04-21T15:20:04Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5541f2ea-48f4-45cf-b70b-e8a123a34cd6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch split/11-bundler-config-api

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

gemini-code-assist

Code Review

This pull request initializes the @eggjs/egg-bundler package by defining its core configuration interfaces and a placeholder bundle function. Feedback includes correcting import and export file extensions to .js for ESM compatibility and fixing a potential typo in the documentation comments regarding the @eggjs/pack dependency.

gemini-code-assist · 2026-04-21T15:22:30Z

+export { ExternalsResolver, type ExternalsConfig, type ExternalsResolverOptions } from './lib/ExternalsResolver.ts';
+export { ManifestLoader, type ManifestLoaderOptions } from './lib/ManifestLoader.ts';


In TypeScript ESM, import and export paths should use the .js extension (or the extension that will exist at runtime) rather than .ts. Using .ts extensions in import paths is non-standard and will cause errors in Node.js and most TypeScript configurations unless specific flags like allowImportingTsExtensions are used. For standard ESM compatibility, it is recommended to use .js extensions in the source code.

Suggested change

export { ExternalsResolver, type ExternalsConfig, type ExternalsResolverOptions } from './lib/ExternalsResolver.ts';

export { ManifestLoader, type ManifestLoaderOptions } from './lib/ManifestLoader.ts';

export { ExternalsResolver, type ExternalsConfig, type ExternalsResolverOptions } from './lib/ExternalsResolver.js';

export { ManifestLoader, type ManifestLoaderOptions } from './lib/ManifestLoader.js';

gemini-code-assist · 2026-04-21T15:22:31Z

+  readonly mode?: 'production' | 'development';
+  /** External package overrides. */
+  readonly externals?: BundlerExternalsConfig;
+  /** @utoo/pack tuning. */


The reference to @utoo/pack appears to be a typo for @eggjs/pack. Using the consistent @eggjs organization prefix is recommended for clarity and correctness, unless @utoo/pack is a specific internal dependency intended for this configuration.

Suggested change

/** @utoo/pack tuning. */

/** @eggjs/pack tuning. */

gemini-code-assist · 2026-04-21T15:22:31Z

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest';
+
+import { bundle } from '../src/index.ts';


For consistency with ESM standards, it is recommended to use the .js extension in import paths, even when referencing .ts files. While Vitest handles .ts extensions, using .js is the standard approach for TypeScript ESM to ensure compatibility across different environments.

Suggested change

import { bundle } from '../src/index.ts';

import { bundle } from '../src/index.js';

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Defines the initial public API surface for @eggjs/egg-bundler by exporting configuration/result types and a bundle() entrypoint (currently a placeholder), plus a smoke test asserting the placeholder behavior.

Changes:

Export BundlerConfig/related config types and BundleResult from src/index.ts
Add bundle() public function that currently throws a “not implemented” error
Add a Vitest smoke test validating the placeholder rejection

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
tools/egg-bundler/src/index.ts	Introduces the public API exports (types + placeholder `bundle()` entrypoint).
tools/egg-bundler/test/index.test.ts	Adds a smoke test that asserts `bundle()` currently rejects with a “not implemented” error.

Copilot · 2026-04-21T15:27:00Z

+import { describe, expect, it } from 'vitest';
+
+import { bundle } from '../src/index.ts';
+
+describe('@eggjs/egg-bundler', () => {
+  it('bundle() is a placeholder that throws until implemented', async () => {
+    await expect(bundle({ baseDir: '/tmp', outputDir: '/tmp/out' })).rejects.toThrow(/not implemented/);


The test hard-codes /tmp paths, which is not cross-platform (fails on Windows) and may also cause collisions across parallel test runs. Use os.tmpdir() + fs.mkdtemp() (or a test temp-dir helper) to create a unique temporary directory, and build baseDir/outputDir with path.join().

Suggested change

import { describe, expect, it } from 'vitest';

import { bundle } from '../src/index.ts';

describe('@eggjs/egg-bundler', () => {

it('bundle() is a placeholder that throws until implemented', async () => {

await expect(bundle({ baseDir: '/tmp', outputDir: '/tmp/out' })).rejects.toThrow(/not implemented/);

import { mkdtemp } from 'node:fs/promises';

import { tmpdir } from 'node:os';

import * as path from 'node:path';

import { describe, expect, it } from 'vitest';

import { bundle } from '../src/index.ts';

describe('@eggjs/egg-bundler', () => {

it('bundle() is a placeholder that throws until implemented', async () => {

const baseDir = await mkdtemp(path.join(tmpdir(), 'egg-bundler-'));

const outputDir = path.join(baseDir, 'out');

await expect(bundle({ baseDir, outputDir })).rejects.toThrow(/not implemented/);

Copilot · 2026-04-21T15:27:00Z

+export interface BundlerConfig {
+  /** Application root directory. Required. */
+  readonly baseDir: string;
+  /** Output directory for the bundled artifact. Required. */
+  readonly outputDir: string;
+  /** Path to manifest.json. Defaults to `<baseDir>/.egg/manifest.json`. */
+  readonly manifestPath?: string;
+  /** Framework name or absolute path. Defaults to `'egg'`. */
+  readonly framework?: string;
+  /** Build mode. Defaults to `'production'`. */
+  readonly mode?: 'production' | 'development';
+  /** External package overrides. */
+  readonly externals?: BundlerExternalsConfig;
+  /** @utoo/pack tuning. */
+  readonly pack?: BundlerPackConfig;
+  /** Enable tegg decoratedFile collection. Defaults to `true`. */
+  readonly tegg?: boolean;
+}


The JSDoc on BundlerConfig describes runtime defaults/behavior, but bundle() currently always throws, so those defaults are not actually applied yet. To avoid misleading API docs, either (a) add a doc comment on bundle() explicitly stating it is a placeholder that always throws (and that config defaults are provisional), or (b) adjust the config field docs to indicate the defaults are planned (until implementation lands).

Copilot · 2026-04-21T15:27:00Z

+  /** Absolute path to the normalized bundled manifest. */
+  readonly manifestPath: string;
+}
+


The JSDoc on BundlerConfig describes runtime defaults/behavior, but bundle() currently always throws, so those defaults are not actually applied yet. To avoid misleading API docs, either (a) add a doc comment on bundle() explicitly stating it is a placeholder that always throws (and that config defaults are provisional), or (b) adjust the config field docs to indicate the defaults are planned (until implementation lands).

Suggested change

/**

* Placeholder API for the future bundling implementation.

*

* This function is not implemented yet and always throws.

* The defaults described on {@link BundlerConfig} are planned behavior and

* are not currently applied at runtime.

*/

Copilot · 2026-04-21T15:27:01Z

+import { describe, expect, it } from 'vitest';
+
+import { bundle } from '../src/index.ts';
+
+describe('@eggjs/egg-bundler', () => {


This smoke test verifies the placeholder error, but it doesn’t assert the new public API exports beyond bundle() (e.g., that bundle’s signature stays (_config: BundlerConfig) => Promise<BundleResult>). Consider adding a type-level assertion using Vitest’s expectTypeOf(...) (or a tsd-style test) to lock in the exported types/signature as part of defining the public API.

Suggested change

import { describe, expect, it } from 'vitest';

import { bundle } from '../src/index.ts';

describe('@eggjs/egg-bundler', () => {

import { describe, expect, expectTypeOf, it } from 'vitest';

import { bundle, type BundleResult, type BundlerConfig } from '../src/index.ts';

describe('@eggjs/egg-bundler', () => {

it('exports bundle() with the expected public API signature', () => {

expectTypeOf(bundle).toEqualTypeOf<(_config: BundlerConfig) => Promise<BundleResult>>();

});

Copilot AI review requested due to automatic review settings April 21, 2026 15:19

killagu mentioned this pull request Apr 21, 2026

Tracking: split #5863 into 19 small PRs #5871

Open

gemini-code-assist Bot reviewed Apr 21, 2026

View reviewed changes

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(bundler): define BundlerConfig public API#5882

feat(bundler): define BundlerConfig public API#5882
killagu wants to merge 1 commit intosplit/10-bundler-generate-manifestfrom
split/11-bundler-config-api

killagu commented Apr 21, 2026

Uh oh!

coderabbitai Bot commented Apr 21, 2026

Review skipped

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		export { ExternalsResolver, type ExternalsConfig, type ExternalsResolverOptions } from './lib/ExternalsResolver.ts';
		export { ManifestLoader, type ManifestLoaderOptions } from './lib/ManifestLoader.ts';

		@@ -0,0 +1,9 @@
		import { describe, expect, it } from 'vitest';

		import { bundle } from '../src/index.ts';

	import { bundle } from '../src/index.ts';
	import { bundle } from '../src/index.js';

+/**
+ * Placeholder API for the future bundling implementation.
+ *
+ * This function is not implemented yet and always throws.
+ * The defaults described on {@link BundlerConfig} are planned behavior and
+ * are not currently applied at runtime.
+ */

Uh oh!

Conversation

killagu commented Apr 21, 2026

Uh oh!

coderabbitai Bot commented Apr 21, 2026

Review skipped

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants