@rslib/core 0.0.0-next-20240927040621

package/dist-types/build.d.ts

@@ -0,0 +1,4 @@
+import type { RsbuildInstance } from '@rsbuild/core';
+import type { BuildOptions } from './cli/commands';
+import type { RslibConfig } from './types/config';
+export declare function build(config: RslibConfig, options?: BuildOptions): Promise<RsbuildInstance>;

package/dist-types/cli/commands.d.ts

@@ -0,0 +1,14 @@
+import type { RsbuildMode } from '@rsbuild/core';
+export type CommonOptions = {
+    config?: string;
+    envMode?: string;
+};
+export type BuildOptions = CommonOptions & {
+    watch?: boolean;
+};
+export type InspectOptions = CommonOptions & {
+    mode: RsbuildMode;
+    output: string;
+    verbose?: boolean;
+};
+export declare function runCli(): void;

package/dist-types/cli/prepare.d.ts

@@ -0,0 +1 @@
+export declare function prepareCli(): void;

package/dist-types/config.d.ts

@@ -0,0 +1,30 @@
+import { type RsbuildConfig, type RsbuildInstance } from '@rsbuild/core';
+import type { AutoExternal, BannerAndFooter, Format, PkgJson, RslibConfig, RslibConfigAsyncFn, RslibConfigExport, RslibConfigSyncFn } from './types';
+/**
+ * This function helps you to autocomplete configuration types.
+ * It accepts a Rslib config object, or a function that returns a config.
+ */
+export declare function defineConfig(config: RslibConfig): RslibConfig;
+export declare function defineConfig(config: RslibConfigSyncFn): RslibConfigSyncFn;
+export declare function defineConfig(config: RslibConfigAsyncFn): RslibConfigAsyncFn;
+export declare function defineConfig(config: RslibConfigExport): RslibConfigExport;
+export declare function loadConfig({ cwd, path, envMode, }: {
+    cwd?: string;
+    path?: string;
+    envMode?: string;
+}): Promise<RslibConfig>;
+export declare const composeAutoExternalConfig: (options: {
+    autoExternal: AutoExternal;
+    pkgJson?: PkgJson;
+    userExternals?: NonNullable<RsbuildConfig["output"]>["externals"];
+}) => RsbuildConfig;
+export declare function composeMinifyConfig(minify: NonNullable<RsbuildConfig['output']>['minify']): RsbuildConfig;
+export declare function composeBannerFooterConfig(banner: BannerAndFooter, footer: BannerAndFooter): RsbuildConfig;
+export declare function composeDecoratorsConfig(compilerOptions?: Record<string, any>, version?: NonNullable<NonNullable<RsbuildConfig['source']>['decorators']>['version']): RsbuildConfig;
+export declare function createConstantRsbuildConfig(): Promise<RsbuildConfig>;
+export declare const composeModuleImportWarn: (request: string) => string;
+export declare function composeCreateRsbuildConfig(rslibConfig: RslibConfig, path?: string): Promise<{
+    format: Format;
+    config: RsbuildConfig;
+}[]>;
+export declare function initRsbuild(rslibConfig: RslibConfig): Promise<RsbuildInstance>;

package/dist-types/constant.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_CONFIG_NAME = "rslib.config";
+export declare const DEFAULT_CONFIG_EXTENSIONS: readonly [".js", ".ts", ".mjs", ".mts", ".cjs", ".cts"];
+export declare const SWC_HELPERS = "@swc/helpers";
+export declare const JS_EXTENSIONS: string[];
+export declare const CSS_EXTENSIONS: string[];
+export declare const ENTRY_EXTENSIONS: string[];
+export declare const JS_EXTENSIONS_PATTERN: RegExp;
+export declare const ENTRY_EXTENSIONS_PATTERN: RegExp;

package/dist-types/index.d.ts

@@ -0,0 +1,7 @@
+export { prepareCli } from './cli/prepare';
+export { runCli } from './cli/commands';
+export { defineConfig, loadConfig } from './config';
+export { build } from './build';
+export { logger } from './utils/logger';
+export type * from './types';
+export declare const version: string;

package/dist-types/plugins/cjsShim.d.ts

@@ -0,0 +1,2 @@
+import { type RsbuildPlugin } from '@rsbuild/core';
+export declare const pluginCjsShim: () => RsbuildPlugin;

package/dist-types/types/config/index.d.ts

@@ -0,0 +1,45 @@
+import type { RsbuildConfig } from '@rsbuild/core';
+export type Format = 'esm' | 'cjs' | 'umd' | 'mf';
+export type FixedEcmaVersions = 'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'es2023';
+export type LatestEcmaVersions = 'es2024' | 'esnext';
+export type EcmaScriptVersion = FixedEcmaVersions | LatestEcmaVersions;
+export type RsbuildConfigOutputTarget = NonNullable<RsbuildConfig['output']>['target'];
+export type Syntax = EcmaScriptVersion | string[];
+export type Dts = {
+    bundle: boolean;
+    distPath?: string;
+    abortOnError?: boolean;
+} | false;
+export type AutoExternal = boolean | {
+    dependencies?: boolean;
+    devDependencies?: boolean;
+    peerDependencies?: boolean;
+};
+export type BannerAndFooter = {
+    js?: string;
+    css?: string;
+    dts?: string;
+};
+export interface LibConfig extends RsbuildConfig {
+    bundle?: boolean;
+    format?: Format;
+    autoExtension?: boolean;
+    autoExternal?: AutoExternal;
+    /** Support esX and browserslist query */
+    syntax?: Syntax;
+    externalHelpers?: boolean;
+    banner?: BannerAndFooter;
+    footer?: BannerAndFooter;
+    dts?: Dts;
+}
+export interface RslibConfig extends RsbuildConfig {
+    lib: LibConfig[];
+}
+export type ConfigParams = {
+    env: string;
+    command: string;
+    envMode?: string;
+};
+export type RslibConfigSyncFn = (env: ConfigParams) => RslibConfig;
+export type RslibConfigAsyncFn = (env: ConfigParams) => Promise<RslibConfig>;
+export type RslibConfigExport = RslibConfig | RslibConfigSyncFn | RslibConfigAsyncFn;

package/dist-types/types/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './config';
+export type * from './utils';

package/dist-types/types/utils.d.ts

@@ -0,0 +1,6 @@
+export type PkgJson = {
+    dependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    [key: string]: unknown;
+};

package/dist-types/utils/extension.d.ts

@@ -0,0 +1,10 @@
+import type { Format, PkgJson } from '../types';
+export declare const getDefaultExtension: (options: {
+    format: Format;
+    pkgJson?: PkgJson;
+    autoExtension: boolean;
+}) => {
+    jsExtension: string;
+    dtsExtension: string;
+    isModule?: boolean;
+};

package/dist-types/utils/helper.d.ts

@@ -0,0 +1,14 @@
+import color from 'picocolors';
+import type { PkgJson } from '../types';
+/**
+ * Node.js built-in modules.
+ * Copied from https://github.com/webpack/webpack/blob/dd44b206a9c50f4b4cb4d134e1a0bd0387b159a3/lib/node/NodeTargetPlugin.js#L12-L72
+ */
+export declare const nodeBuiltInModules: Array<string | RegExp>;
+export declare function calcLongestCommonPath(absPaths: string[]): Promise<string | null>;
+export declare const readPackageJson: (rootPath: string) => undefined | PkgJson;
+export declare const isObject: (obj: unknown) => obj is Record<string, any>;
+export declare const isEmptyObject: (obj: object) => boolean;
+export declare function pick<T, U extends keyof T>(obj: T, keys: ReadonlyArray<U>): Pick<T, U>;
+export declare function omit<T extends object, U extends keyof T>(obj: T, keys: ReadonlyArray<U>): Omit<T, U>;
+export { color };

package/dist-types/utils/logger.d.ts

@@ -0,0 +1,5 @@
+import { type Logger, logger } from 'rslog';
+export declare const isDebug: () => boolean;
+export declare const debug: (message: string | (() => string)) => void;
+export { logger };
+export type { Logger };

package/dist-types/utils/syntax.d.ts

@@ -0,0 +1,13 @@
+import type { RsbuildConfig, Rspack } from '@rsbuild/core';
+import type { FixedEcmaVersions, LatestEcmaVersions, RsbuildConfigOutputTarget, Syntax } from '../types/config';
+export declare const LATEST_TARGET_VERSIONS: Record<NonNullable<RsbuildConfigOutputTarget>, string[]>;
+/**
+ * The esX to browserslist mapping is transformed from esbuild:
+ * https://github.com/evanw/esbuild/blob/main/internal/compat/js_table.go
+ * It does not completely align with the browserslist query of Rsbuild now:
+ * https://github.com/rspack-contrib/browserslist-to-es-version
+ * TODO: align with Rsbuild, we may should align with SWC
+ */
+export declare const ESX_TO_BROWSERSLIST: Record<FixedEcmaVersions, Record<string, string | string[]>> & Record<LatestEcmaVersions, (target: RsbuildConfigOutputTarget) => string[]>;
+export declare function transformSyntaxToRspackTarget(syntax: Syntax): Rspack.Configuration['target'];
+export declare function transformSyntaxToBrowserslist(syntax: Syntax, target?: NonNullable<RsbuildConfig['output']>['target']): NonNullable<NonNullable<RsbuildConfig['output']>['overrideBrowserslist']>;

package/dist-types/utils/tsconfig.d.ts

@@ -0,0 +1,3 @@
+export declare function loadTsconfig(root: string, tsconfigPath?: string): Promise<{
+    compilerOptions?: Record<string, any>;
+}>;

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@rslib/core",
+  "version": "0.0.0-next-20240927040621",
+  "description": "The Rspack-based library build tool.",
+  "homepage": "https://lib.rsbuild.dev",
+  "bugs": {
+    "url": "https://github.com/web-infra-dev/rslib/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rslib",
+    "directory": "packages/core"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist-types/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist-types/index.d.ts",
+  "bin": {
+    "rslib": "./bin/rslib.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "dist-types",
+    "compiled"
+  ],
+  "dependencies": {
+    "@rsbuild/core": "1.0.7",
+    "rsbuild-plugin-dts": "0.0.0-next-20240927040621"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "commander": "^12.1.0",
+    "fast-glob": "^3.3.2",
+    "fs-extra": "^11.2.0",
+    "memfs": "^4.12.0",
+    "picocolors": "1.1.0",
+    "prebundle": "1.2.2",
+    "rslib": "npm:@rslib/core@0.0.7",
+    "rslog": "^1.2.3",
+    "tsconfck": "3.1.3",
+    "typescript": "^5.6.2",
+    "@rslib/tsconfig": "0.0.1"
+  },
+  "peerDependencies": {
+    "@microsoft/api-extractor": "^7",
+    "typescript": "^5"
+  },
+  "peerDependenciesMeta": {
+    "@microsoft/api-extractor": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "prebundle": "prebundle"
+  }
+}