Skip to content

fix(dts): explicit error for @microsoft/api-extractor is required #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Timeless0911 merged 1 commit into from
Apr 17, 2025
Merged

fix(dts): explicit error for @microsoft/api-extractor is required #930

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions packages/plugin-dts/src/apiExtractor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
import { join, relative } from 'node:path';
import {
Extractor,
ExtractorConfig,
ExtractorLogLevel,
type ExtractorResult,
} from '@microsoft/api-extractor';
import type * as ApiExtractor from '@microsoft/api-extractor';
import { logger } from '@rsbuild/core';
import color from 'picocolors';
import type { DtsEntry } from './index';
Expand All @@ -25,6 +20,16 @@ export type BundleOptions = {
};

export async function bundleDts(options: BundleOptions): Promise<void> {
let apiExtractor: typeof ApiExtractor | undefined = undefined;
try {
apiExtractor = await import('@microsoft/api-extractor');
} catch {
throw new Error(
`${color.cyan('@microsoft/api-extractor')} is required when ${color.cyan('dts.bundle')} is set to ${color.cyan('true')}, please make sure it is installed. You could check https://lib.rsbuild.dev/guide/advanced/dts#how-to-generate-declaration-files-in-rslib for more details.`,
);
}

const { Extractor, ExtractorConfig, ExtractorLogLevel } = apiExtractor!;
const {
name,
cwd,
Expand Down Expand Up @@ -65,7 +70,7 @@ export async function bundleDts(options: BundleOptions): Promise<void> {
packageJsonFullPath: join(cwd, 'package.json'),
});

const extractorResult: ExtractorResult = Extractor.invoke(
const extractorResult: ApiExtractor.ExtractorResult = Extractor.invoke(
extractorConfig,
{
localBuild: true,
Expand Down
Loading