feat: support pkg options

issue: #682

Author: XGHeaven

.changeset/slimy-walls-tease.md

@@ -0,0 +1,5 @@
+---
+'@ice/pkg': minor
+---
+
+feat: support `pkg` options

packages/pkg/src/core/createPkg.ts

@@ -4,8 +4,9 @@ import { Context, CustomFormatTaskCreator, ExtendsPluginAPI, TaskConfig, UserCon
 import taskRegisterPlugin from '../plugins/component.js';
 import { userConfigSchema } from '../config/schema.js';
 import { createMessageBuilder, fromZodError } from 'zod-validation-error';
-import { registerTasks } from './registerTasks.js';
+import { registerPkgTasks, registerTasks } from './registerTasks.js';
 import { initContextTasks } from './initContextTasks.js';
+import { resolvePackage, runPkgPlugins } from './pkg.js';
 
 export interface CreatePkgOptions {
   rootDir: string;
@@ -105,7 +106,15 @@ export async function createPkg(options: CreatePkgOptions) {
     throw prettyError;
   }
 
-  registerTasks(ctx, customFormats);
+  const pkgs = await resolvePackage(ctx);
+  await runPkgPlugins(ctx, pkgs);
+
+  if (pkgs.length) {
+    await registerPkgTasks(ctx, pkgs);
+  } else {
+    // when pkg is preset, no need to register old tasks
+    registerTasks(ctx, customFormats);
+  }
 
   initContextTasks(ctx);
 

packages/pkg/src/core/initContextTasks.ts

@@ -1,10 +1,10 @@
-import { BuildTask, BundleUserConfig, Context, DeclarationUserConfig } from '../types.js'; // 添加 .js 后缀
-import { formatEntry, getTransformDefaultOutputDir } from '../helpers/getTaskIO.js'; // 添加 .js 后缀
-import getDefaultDefineValues from '../helpers/getDefaultDefineValues.js'; // 添加 .js 后缀
-import { stringifyObject } from '../utils.js'; // 添加 .js 后缀
-import { getDefaultBundleSwcConfig, getDefaultTransformSwcConfig } from '../helpers/defaultSwcConfig.js'; // 添加 .js 后缀
-import { merge, mergeWith } from 'es-toolkit/object';
+import { BuildTask, BundleUserConfig, Context, DeclarationUserConfig } from '../types.js';
+import { formatEntry, getTransformDefaultOutputDir } from '../helpers/getTaskIO.js';
+import getDefaultDefineValues from '../helpers/getDefaultDefineValues.js';
+import { stringifyObject } from '../utils.js';
+import { merge, mergeWith, omit } from 'es-toolkit/object';
 import path from 'node:path';
+import { groupBy } from 'es-toolkit';
 
 const mergeDefaults: typeof merge = (target, source) => {
   return mergeWith(target, source, (targetValue, sourceValue) => {
@@ -33,49 +33,64 @@ const defaultDeclarationUserConfig = {
 export function initContextTasks(ctx: Context) {
   const tasks = ctx.getTaskConfig() as BuildTask[];
 
-  for (const buildTask of tasks) {
+  const { declaration: declarationTasks, buildable: buildableTasks } = groupBy(tasks, (task) =>
+    task.config.type === 'declaration' ? 'declaration' : 'buildable',
+  );
+
+  // 1. init all tasks except declaration
+  for (const buildTask of buildableTasks) {
     initTask(buildTask, ctx);
   }
+
+  // 2. init declaration based on transform tasks
+  for (const buildTask of declarationTasks ?? []) {
+    initDeclarationTask(buildTask, ctx, buildableTasks);
+  }
 }
 
-/**
- * @internal export for test
- */
-export function initTask(
-  buildTask: BuildTask,
-  { userConfig, rootDir, command }: Pick<Context, 'userConfig' | 'rootDir' | 'command'>,
-) {
-  const { config, name: taskName } = buildTask;
+type InitTaskOptions = Pick<Context, 'userConfig' | 'rootDir' | 'command'>;
 
-  config.entry = formatEntry(config.entry ?? userConfig.entry);
-  config.alias ??= userConfig.alias;
+function initSharedTask(buildTask: BuildTask, options: InitTaskOptions) {
+  const { userConfig, command } = options;
+  const { config } = buildTask;
+  const { pkg } = config;
+
+  config.entry = formatEntry(config.entry ?? pkg?.entry ?? userConfig.entry);
+  config.alias ??= mergeDefaults({ ...pkg?.alias }, userConfig.alias ?? {});
   // Configure define
   config.define = Object.assign(
     // Note: The define values in bundle mode will be defined (according to the `modes` value)
     // in generating rollup options. But when the command is test, we don't need to get the rollup options.
     // So in test, we assume the mode is 'development'.
     command === 'test' ? getDefaultDefineValues('development') : {},
-    stringifyObject(config.define ?? userConfig.define ?? {}),
+    stringifyObject(userConfig.define ?? {}),
+    stringifyObject(pkg?.define ?? {}),
+    stringifyObject(config.define ?? {}),
   );
 
-  config.sourcemap ??= userConfig.sourceMaps ?? command === 'start';
-  config.jsxRuntime ??= userConfig.jsxRuntime;
+  config.sourcemap ??= pkg?.sourceMaps ?? userConfig.sourceMaps ?? command === 'start';
+  config.jsxRuntime ??= pkg?.jsxRuntime ?? userConfig.jsxRuntime;
+}
+
+/**
+ * @internal export for test
+ */
+export function initTask(buildTask: BuildTask, options: InitTaskOptions) {
+  const { userConfig, rootDir, command } = options;
+  const { config, name: taskName } = buildTask;
+  const { pkg } = config;
+
+  initSharedTask(buildTask, options);
 
   const expectedMode = command === 'build' ? 'production' : 'development';
 
   if (config.type === 'bundle') {
     const bundleConfig = userConfig.bundle ?? {};
     config.modes ??= bundleConfig.modes ?? [expectedMode];
-    config.engine ??= bundleConfig.engine;
-    const defaultBundleSwcConfig = getDefaultBundleSwcConfig(config);
-    config.swcCompileOptions =
-      typeof config.modifySwcCompileOptions === 'function'
-        ? config.modifySwcCompileOptions(defaultBundleSwcConfig)
-        : merge(defaultBundleSwcConfig, config.swcCompileOptions || {});
     // TODO: 判断下这个东西是否真的有用
     // Set outputDir to process.env for CI
     process.env.ICE_PKG_BUNDLE_OUTPUT_DIR = config.outputDir;
-    const originMinifyConfig = bundleConfig.minify ?? defaultBundleUserConfig.minify ?? {};
+    const originMinifyConfig = pkg?.minify ?? bundleConfig.minify ?? defaultBundleUserConfig.minify ?? {};
     let { jsMinify, cssMinify } = config;
     if (typeof originMinifyConfig === 'object') {
       jsMinify ??= getMinifyFunction(originMinifyConfig.js);
@@ -88,39 +103,60 @@ export function initTask(
     config.jsMinify = jsMinify;
     config.cssMinify = cssMinify;
 
+    config.outputDir ??= pkg?.outputDir ?? bundleConfig.outputDir ?? defaultBundleUserConfig.outputDir;
+
+    if (pkg) {
+      mergeDefaults(config, omit(pkg, ['id', 'pluginInfos', 'id', 'target', 'module', 'declaration', 'outputDir']));
+    }
     mergeDefaults(config, bundleConfig);
     mergeDefaults(config, defaultBundleUserConfig);
   } else if (config.type === 'transform') {
     config.modes ??= [expectedMode];
-    config.outputDir ??= getTransformDefaultOutputDir(rootDir, taskName);
-    const defaultTransformSwcConfig = getDefaultTransformSwcConfig(config, expectedMode);
-    config.swcCompileOptions =
-      typeof config.modifySwcCompileOptions === 'function'
-        ? config.modifySwcCompileOptions(defaultTransformSwcConfig)
-        : merge(defaultTransformSwcConfig, config.swcCompileOptions || {});
+    config.outputDir ??= pkg?.outputDir ?? getTransformDefaultOutputDir(rootDir, taskName, config);
   } else if (config.type === 'declaration') {
-    const { declaration: declarationConfig } = userConfig;
-    if (declarationConfig === false) {
-      throw new Error('Cannot disable declaration when transform formats is not empty.');
-    }
-    config.outputMode ??=
-      declarationConfig === true
-        ? defaultDeclarationUserConfig.outputMode
-        : (declarationConfig.outputMode ?? defaultDeclarationUserConfig.outputMode);
-    // 这个 output 仅仅用于生成正确的 .d.ts 的 alias，不做实际输出目录
-    config.outputDir = path.resolve(rootDir, config.transformFormats[0]);
-    if (config.outputMode === 'unique') {
-      config.declarationOutputDirs = [path.resolve(rootDir, 'typings')];
-    } else {
-      config.declarationOutputDirs = config.transformFormats.map((format) => path.resolve(rootDir, format));
-    }
+    // should run in initDeclarationTask
   } else {
     throw new Error('Invalid task type.');
   }
 
   return buildTask;
 }
 
+/**
+ * 需要判断 entry 是否一致，对于不一致的 entry，理论上要生成多个 declaration task
+ * @internal export for test
+ */
+export function initDeclarationTask(buildTask: BuildTask, options: InitTaskOptions, allTasks: BuildTask[]) {
+  const { userConfig, rootDir } = options;
+  const { config } = buildTask;
+  const { declaration: declarationConfig } = userConfig;
+  if (config.type !== 'declaration') {
+    throw new Error('initDeclarationTask only allow declaration task');
+  }
+  if (declarationConfig === false) {
+    throw new Error('Cannot disable declaration when transform formats is not empty.');
+  }
+  initSharedTask(buildTask, options);
+  config.outputMode ??=
+    declarationConfig === true
+      ? defaultDeclarationUserConfig.outputMode
+      : (declarationConfig.outputMode ?? defaultDeclarationUserConfig.outputMode);
+  const allOutputDirs = allTasks
+    .map((v) => {
+      return v.config.type === 'transform' ? v.config.outputDir! : '';
+    })
+    .filter(Boolean);
+  // 这个 output 仅仅用于生成正确的 .d.ts 的 alias，不做实际输出目录
+  config.outputDir = allOutputDirs[0];
+  if (config.outputMode === 'unique') {
+    config.declarationOutputDirs = [path.resolve(rootDir, 'typings')];
+  } else {
+    config.declarationOutputDirs = allOutputDirs;
+  }
+
+  return buildTask;
+}
+
 function getMinifyFunction(minify: boolean | ((mode: string, command: string) => unknown)) {
   switch (typeof minify) {
     case 'boolean':