auklet 0.0.7 → 0.0.9

package/README.md

@@ -21,7 +21,6 @@ Build utilities for TypeScript packages and module CSS output.
 ## Requirements
 
 - Node.js `>=22`
-- pnpm `10.27.0`
 
 ## CLI
 
@@ -38,7 +37,7 @@ pnpm auk dev
 
 Commands:
 
-- `build` removes `dist`, builds JavaScript output, then builds CSS output.
+- `build` removes the configured `output` directory, builds JavaScript output, then builds CSS output.
 - `build-js` runs tsdown with the default auklet tsdown config unless a config flag is passed.
 - `build-css` generates module CSS output.
 - `build-css --watch` watches source/config files and rebuilds CSS.
@@ -77,6 +76,16 @@ export const config: AukletConfig = {
   build: {
     formats: ['esm', 'cjs'],
     target: 'es2020',
+    globals: {
+      react: 'React',
+    },
+    configureTsdown(config, context) {
+      if (context.kind !== 'bundle') return config;
+      return {
+        ...config,
+        sourcemap: true,
+      };
+    },
     tsconfig: 'tsconfig.json',
   },
 };
@@ -85,7 +94,7 @@ export const config: AukletConfig = {
 ### Style Options
 
 - `source`: source directory relative to the package root. Defaults to `src`.
-- `output`: build output directory relative to the package root. Defaults to `dist`.
+- `output`: build output directory relative to the package root. Defaults to `dist`. `auk build` removes this directory before writing JavaScript and CSS output.
 - `styles.themes`: package theme style entries. Defaults to `{}`.
 - `styles.dependencies`: external package style dependencies. Defaults to `{}`.
 
@@ -136,6 +145,8 @@ export const config: AukletConfig = {
 - `build.platform`: build target runtime platform: `neutral`, `node`, or `browser`. Defaults to `neutral`.
 - `build.banner`: custom bundle banner. Defaults to a package name/version banner.
 - `build.externals`: additional external packages. Defaults to `[]`.
+- `build.globals`: IIFE external global names passed to tsdown `output.globals`. Values override auklet's generated global names.
+- `build.configureTsdown`: final customization hook for each generated tsdown config. It receives `(config, context)` and should return a tsdown config.
 - `build.tsconfig`: TypeScript config path relative to the package root. Defaults to the nearest `tsconfig.json` found from the package root upward.
 
 ### Build Constants

package/bin/entry.cjs

@@ -16,12 +16,18 @@ const runVersion = async () => {
   return 0;
 };
 
-const runBuildStyle = async (args) => {
-  const shouldWatch = args.includes('--watch') || args.includes('-w');
+const loadCurrentAukletConfig = async (options) => {
   const { loadAukletConfig } = await import('../dist/configLoader.js');
-  const aukletConfig = await loadAukletConfig(process.cwd(), {
-    cacheBust: shouldWatch,
-  });
+  return loadAukletConfig(process.cwd(), options);
+};
+
+const runBuildStyle = async (args, options = {}) => {
+  const shouldWatch = args.includes('--watch') || args.includes('-w');
+  const aukletConfig =
+    options.aukletConfig ??
+    (await loadCurrentAukletConfig({
+      cacheBust: shouldWatch,
+    }));
 
   if (shouldWatch) {
     const { ModuleStyleWatcher } = await import('../dist/css/watch/watcher.js');
@@ -53,15 +59,16 @@ const runBuildJs = async (args) => {
 };
 
 const runBuild = async (args) => {
-  fs.rmSync(path.join(process.cwd(), 'dist'), {
-    recursive: true,
-    force: true,
-  });
+  const aukletConfig = await loadCurrentAukletConfig();
+  const { cleanAukletOutputByConfig } = await import(
+    '../dist/build/cleanOutput.js'
+  );
+  cleanAukletOutputByConfig(process.cwd(), aukletConfig);
 
   const jsExitCode = await runBuildJs(args);
   if (jsExitCode) return jsExitCode;
 
-  return runBuildStyle([]);
+  return runBuildStyle([], { aukletConfig });
 };
 
 const runDev = async () => {

package/dist/build/cleanOutput.d.ts

@@ -0,0 +1,9 @@
+import type { AukletConfig, LoadAukletConfigOptions } from '#auklet/types';
+export declare function cleanAukletOutputByConfig(
+  packageRoot: string,
+  config?: AukletConfig,
+): void;
+export declare function cleanAukletOutput(
+  packageRoot: string,
+  options?: LoadAukletConfigOptions,
+): Promise<void>;

package/dist/build/cleanOutput.js

@@ -0,0 +1,15 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { normalizeAukletConfig } from '#auklet/config';
+import { loadAukletConfig } from '#auklet/configLoader';
+export function cleanAukletOutputByConfig(packageRoot, config = {}) {
+  const normalizedConfig = normalizeAukletConfig(config);
+  fs.rmSync(path.join(packageRoot, normalizedConfig.output), {
+    recursive: true,
+    force: true,
+  });
+}
+export async function cleanAukletOutput(packageRoot, options = {}) {
+  const rawConfig = await loadAukletConfig(packageRoot, options);
+  cleanAukletOutputByConfig(packageRoot, rawConfig);
+}

package/dist/build/tsdownConfig.d.ts

@@ -1,216 +1,12 @@
+import type { UserConfig } from 'tsdown/config';
 import type { AukletConfig, PackageBuildFormat } from '#auklet/types';
 export type TsdownFormat = PackageBuildFormat;
 export declare function defineKernelPackageConfigFromOptions(
   packageRoot?: string,
   config?: AukletConfig,
-): (
-  | {
-      entry: {
-        index: string;
-      };
-      format: PackageBuildFormat;
-      globalName: string;
-      outDir: string;
-      dts: boolean;
-      treeshake: true;
-      banner: string;
-      outExtensions: () => {
-        js: string;
-      };
-      outputOptions: {
-        entryFileNames: string;
-        chunkFileNames: string;
-        globals: {
-          [k: string]: string;
-        };
-      };
-      cwd: string;
-      root: string;
-      clean: false;
-      sourcemap: false;
-      tsconfig: string;
-      target: NonNullable<
-        import('#auklet/types').PackageBuildTarget | undefined
-      >;
-      platform: NonNullable<
-        import('#auklet/types').PackageBuildPlatform | undefined
-      >;
-      deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-      define: {
-        __TEST__: string;
-        __VERSION__: string;
-        __DEV__: string;
-      };
-    }
-  | {
-      entry: Record<string, string>;
-      format: 'cjs' | 'esm';
-      outDir: string;
-      dts: true;
-      unbundle: true;
-      outExtensions: () => {
-        js: string;
-        dts: string;
-      };
-      cwd: string;
-      root: string;
-      clean: false;
-      sourcemap: false;
-      tsconfig: string;
-      target: NonNullable<
-        import('#auklet/types').PackageBuildTarget | undefined
-      >;
-      platform: NonNullable<
-        import('#auklet/types').PackageBuildPlatform | undefined
-      >;
-      deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-      define: {
-        __TEST__: string;
-        __VERSION__: string;
-        __DEV__: string;
-      };
-    }
-)[];
+): UserConfig[];
 export declare function defineKernelPackageConfigFromFile(
   packageRoot?: string,
-): Promise<
-  (
-    | {
-        entry: {
-          index: string;
-        };
-        format: PackageBuildFormat;
-        globalName: string;
-        outDir: string;
-        dts: boolean;
-        treeshake: true;
-        banner: string;
-        outExtensions: () => {
-          js: string;
-        };
-        outputOptions: {
-          entryFileNames: string;
-          chunkFileNames: string;
-          globals: {
-            [k: string]: string;
-          };
-        };
-        cwd: string;
-        root: string;
-        clean: false;
-        sourcemap: false;
-        tsconfig: string;
-        target: NonNullable<
-          import('#auklet/types').PackageBuildTarget | undefined
-        >;
-        platform: NonNullable<
-          import('#auklet/types').PackageBuildPlatform | undefined
-        >;
-        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-        define: {
-          __TEST__: string;
-          __VERSION__: string;
-          __DEV__: string;
-        };
-      }
-    | {
-        entry: Record<string, string>;
-        format: 'cjs' | 'esm';
-        outDir: string;
-        dts: true;
-        unbundle: true;
-        outExtensions: () => {
-          js: string;
-          dts: string;
-        };
-        cwd: string;
-        root: string;
-        clean: false;
-        sourcemap: false;
-        tsconfig: string;
-        target: NonNullable<
-          import('#auklet/types').PackageBuildTarget | undefined
-        >;
-        platform: NonNullable<
-          import('#auklet/types').PackageBuildPlatform | undefined
-        >;
-        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-        define: {
-          __TEST__: string;
-          __VERSION__: string;
-          __DEV__: string;
-        };
-      }
-  )[]
->;
-declare const _default: Promise<
-  (
-    | {
-        entry: {
-          index: string;
-        };
-        format: PackageBuildFormat;
-        globalName: string;
-        outDir: string;
-        dts: boolean;
-        treeshake: true;
-        banner: string;
-        outExtensions: () => {
-          js: string;
-        };
-        outputOptions: {
-          entryFileNames: string;
-          chunkFileNames: string;
-          globals: {
-            [k: string]: string;
-          };
-        };
-        cwd: string;
-        root: string;
-        clean: false;
-        sourcemap: false;
-        tsconfig: string;
-        target: NonNullable<
-          import('#auklet/types').PackageBuildTarget | undefined
-        >;
-        platform: NonNullable<
-          import('#auklet/types').PackageBuildPlatform | undefined
-        >;
-        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-        define: {
-          __TEST__: string;
-          __VERSION__: string;
-          __DEV__: string;
-        };
-      }
-    | {
-        entry: Record<string, string>;
-        format: 'cjs' | 'esm';
-        outDir: string;
-        dts: true;
-        unbundle: true;
-        outExtensions: () => {
-          js: string;
-          dts: string;
-        };
-        cwd: string;
-        root: string;
-        clean: false;
-        sourcemap: false;
-        tsconfig: string;
-        target: NonNullable<
-          import('#auklet/types').PackageBuildTarget | undefined
-        >;
-        platform: NonNullable<
-          import('#auklet/types').PackageBuildPlatform | undefined
-        >;
-        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
-        define: {
-          __TEST__: string;
-          __VERSION__: string;
-          __DEV__: string;
-        };
-      }
-  )[]
->;
+): Promise<UserConfig[]>;
+declare const _default: Promise<UserConfig[]>;
 export default _default;

package/dist/build/tsdownConfig.js

@@ -41,9 +41,12 @@ const getDependencyGlobalName = (name) => {
     .join('');
 };
 const getIifeGlobals = (context) => {
-  return Object.fromEntries(
-    context.peerExternal.map((name) => [name, getDependencyGlobalName(name)]),
-  );
+  return {
+    ...Object.fromEntries(
+      context.peerExternal.map((name) => [name, getDependencyGlobalName(name)]),
+    ),
+    ...context.globals,
+  };
 };
 const getIifeAlwaysBundle = (context) => {
   const names = new Set(context.runtimeDependencyNames);
@@ -136,9 +139,11 @@ const createBuildContext = (packageRoot, options, output) => {
     runtimeDependencyNames: Object.keys(pkg.dependencies ?? {}),
     packageExternal: getPackageExternal(pkg, options),
     peerExternal: getPeerExternal(pkg, options),
+    globals: options.globals ?? {},
     globalName: getGlobalName(pkg),
     platform: options.platform,
     target: options.target,
+    configureTsdown: options.configureTsdown,
     tsconfig: options.tsconfig
       ? path.resolve(packageRoot, options.tsconfig)
       : findWorkspaceTsconfig(packageRoot),
@@ -162,6 +167,16 @@ const createCommonConfig = (context, deps) => {
     },
   };
 };
+const configureTsdown = (context, config, options) => {
+  return (
+    context.configureTsdown?.(config, {
+      ...options,
+      packageRoot: context.packageRoot,
+      output: context.output,
+      packageName: context.pkg.name,
+    }) ?? config
+  );
+};
 const createBundleConfigs = (context, formats) => {
   const outputConfigs = [];
   let hasDtsConfig = false;
@@ -184,39 +199,47 @@ const createBundleConfigs = (context, formats) => {
         : {
             neverBundle: context.packageExternal,
           };
-    return {
-      ...createCommonConfig(context, deps),
-      entry: getBundleEntry(context.packageRoot),
-      format,
-      globalName: context.globalName,
-      outDir: context.output,
-      dts,
-      treeshake: true,
-      banner: context.banner,
-      outExtensions: () => ({
-        js: extname,
-      }),
-      outputOptions: {
-        entryFileNames: `[name]${extname}`,
-        chunkFileNames: `[name]-[hash]${extname}`,
-        globals: format === 'iife' ? getIifeGlobals(context) : {},
+    return configureTsdown(
+      context,
+      {
+        ...createCommonConfig(context, deps),
+        entry: getBundleEntry(context.packageRoot),
+        format,
+        globalName: context.globalName,
+        outDir: context.output,
+        dts,
+        treeshake: true,
+        banner: context.banner,
+        outExtensions: () => ({
+          js: extname,
+        }),
+        outputOptions: {
+          entryFileNames: `[name]${extname}`,
+          chunkFileNames: `[name]-[hash]${extname}`,
+          globals: format === 'iife' ? getIifeGlobals(context) : {},
+        },
       },
-    };
+      { kind: 'bundle', format },
+    );
   });
 };
-const createModuleConfig = (commonConfig, entry, format, outDir) => {
-  return {
-    ...commonConfig,
-    entry,
-    format,
-    outDir,
-    dts: true,
-    unbundle: true,
-    outExtensions: () => ({
-      js: '.js',
-      dts: '.d.ts',
-    }),
-  };
+const createModuleConfig = (context, commonConfig, entry, format, outDir) => {
+  return configureTsdown(
+    context,
+    {
+      ...commonConfig,
+      entry,
+      format,
+      outDir,
+      dts: true,
+      unbundle: true,
+      outExtensions: () => ({
+        js: '.js',
+        dts: '.d.ts',
+      }),
+    },
+    { kind: 'module', format },
+  );
 };
 const createModuleConfigs = (context) => {
   const commonConfig = createCommonConfig(context, {
@@ -225,12 +248,14 @@ const createModuleConfigs = (context) => {
   const entry = getModuleEntries(context.packageRoot);
   return [
     createModuleConfig(
+      context,
       commonConfig,
       entry,
       'esm',
       path.join(context.output, 'es'),
     ),
     createModuleConfig(
+      context,
       commonConfig,
       entry,
       'cjs',

package/dist/config.d.ts

@@ -25,6 +25,8 @@ export declare function normalizeAukletConfig(config?: AukletConfig): {
     platform: import('#auklet/types').PackageBuildPlatform;
     banner?: string;
     externals?: Array<string>;
+    globals?: Record<string, string>;
+    configureTsdown?: import('#auklet/types').ConfigureTsdown;
     tsconfig?: string;
   };
   styles: {

package/dist/css/vite/moduleGraph/requestCache.d.ts

@@ -48,6 +48,8 @@ export declare class ModuleStyleGraphRequestCache {
             platform: import('#auklet/types').PackageBuildPlatform;
             banner?: string;
             externals?: Array<string>;
+            globals?: Record<string, string>;
+            configureTsdown?: import('#auklet/types').ConfigureTsdown;
             tsconfig?: string;
           };
           styles: {

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export type {
   AukletConfig,
+  ConfigureTsdown,
+  ConfigureTsdownContext,
   LoadAukletConfigOptions,
   ModuleStyleBuildConfig,
   ModuleStyleBuildContext,

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { UserConfig } from 'tsdown/config';
 export type StyleDependencyGroup = {
   entry?: string | Array<string>;
   themes?: Record<string, string>;
@@ -25,12 +26,25 @@ export interface NormalizedAukletConfig {
 export type PackageBuildFormat = 'cjs' | 'esm' | 'iife';
 export type PackageBuildPlatform = 'node' | 'neutral' | 'browser';
 export type PackageBuildTarget = string | Array<string> | false;
+export type ConfigureTsdownContext = {
+  kind: 'bundle' | 'module';
+  format: PackageBuildFormat;
+  packageRoot: string;
+  output: string;
+  packageName?: string;
+};
+export type ConfigureTsdown = (
+  config: UserConfig,
+  context: ConfigureTsdownContext,
+) => UserConfig;
 export type PackageBuildOptions = {
   formats?: Array<PackageBuildFormat>;
   target?: PackageBuildTarget;
   platform?: PackageBuildPlatform;
   banner?: string;
   externals?: Array<string>;
+  globals?: Record<string, string>;
+  configureTsdown?: ConfigureTsdown;
   tsconfig?: string;
 };
 export interface AukletConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auklet",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "type": "module",
   "author": "chentao.arthur",
   "packageManager": "pnpm@10.27.0",
@@ -53,6 +53,15 @@
     "dist",
     "!dist/__tests__"
   ],
+  "keywords": [
+    "build",
+    "typescript",
+    "css",
+    "vite",
+    "components",
+    "monorepo",
+    "tsdown"
+  ],
   "dependencies": {
     "unrun": "^0.3.0",
     "execa": "^9.1.0",