bunchee 5.5.1 → 5.6.1

package/README.md

@@ -470,6 +470,20 @@ Bunchee offers a convenient watch mode for rebuilding your library whenever chan
 #### `target`
 
 If you specify `target` option in `tsconfig.json`, then you don't have to pass it again through CLI.
+To target a range of browsers, you can use the `browserslist` field in `package.json`, bunchee will use it to determine the target browsers for the output bundle.
+
+For example:
+
+```json
+{
+  "browserslist": [
+    "last 1 version",
+    "> 1%",
+    "maintained node versions",
+    "not dead"
+  ]
+}
+```
 
 #### Package lint
 

package/dist/bin/cli.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 var path = require('path');
-var arg = require('arg');
+var yargs = require('yargs');
+var helpers = require('yargs/helpers');
 var perf_hooks = require('perf_hooks');
 var fs = require('fs');
 var fsp = require('fs/promises');
@@ -12,7 +13,7 @@ var prettyBytes = require('pretty-bytes');
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var path__default = /*#__PURE__*/_interopDefault(path);
-var arg__default = /*#__PURE__*/_interopDefault(arg);
+var yargs__default = /*#__PURE__*/_interopDefault(yargs);
 var fs__default = /*#__PURE__*/_interopDefault(fs);
 var fsp__default = /*#__PURE__*/_interopDefault(fsp);
 var require$$0__default = /*#__PURE__*/_interopDefault(require$$0);
@@ -524,7 +525,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "5.5.1";
+var version = "5.6.1";
 
 function relativify(path) {
     return path.startsWith('.') ? path : `./${path}`;
@@ -984,57 +985,90 @@ async function lint(cwd) {
     }
     await lint$1(await getPackageMeta(cwd));
 }
-function parseCliArgs(argv) {
-    let args;
-    args = arg__default.default({
-        '--cwd': String,
-        '--no-dts': Boolean,
-        '--output': String,
-        '--format': String,
-        '--watch': Boolean,
-        '--minify': Boolean,
-        '--help': Boolean,
-        '--version': Boolean,
-        '--runtime': String,
-        '--target': String,
-        '--sourcemap': Boolean,
-        '--env': String,
-        '--external': String,
-        '--no-external': Boolean,
-        '--no-clean': Boolean,
-        '--prepare': Boolean,
-        '--tsconfig': String,
-        '--dts-bundle': Boolean,
-        '-h': '--help',
-        '-v': '--version',
-        '-w': '--watch',
-        '-o': '--output',
-        '-f': '--format',
-        '-m': '--minify'
-    }, {
-        permissive: true,
-        argv
-    });
+async function parseCliArgs(argv) {
+    const args = await yargs__default.default(helpers.hideBin(argv)).option('cwd', {
+        type: 'string',
+        description: 'specify current working directory'
+    }).option('dts', {
+        coerce (arg) {
+            return arg === false ? false : undefined;
+        },
+        description: 'do not generate types'
+    }).option('clean', {
+        coerce (arg) {
+            return arg === false ? false : undefined;
+        },
+        description: 'do not clean dist folder before building'
+    }).option('output', {
+        type: 'string',
+        alias: 'o',
+        description: 'specify output filename'
+    }).option('format', {
+        type: 'string',
+        alias: 'f',
+        default: 'esm',
+        description: 'type of output (esm, amd, cjs, iife, umd, system)'
+    }).option('watch', {
+        type: 'boolean',
+        alias: 'w',
+        description: 'watch src files changes'
+    }).option('minify', {
+        type: 'boolean',
+        alias: 'm',
+        description: 'compress output'
+    }).option('help', {
+        type: 'boolean',
+        alias: 'h',
+        description: 'output usage information'
+    }).option('runtime', {
+        type: 'string',
+        default: 'browser',
+        description: 'build runtime (nodejs, browser)'
+    }).option('target', {
+        type: 'string',
+        description: 'js features target: swc target es versions'
+    }).option('sourcemap', {
+        type: 'boolean',
+        default: false,
+        description: 'enable sourcemap generation'
+    }).option('env', {
+        type: 'string',
+        description: 'inlined process env variables, separate by comma'
+    }).option('external', {
+        coerce (arg) {
+            return typeof arg === 'string' || typeof arg === 'boolean' ? arg : undefined;
+        },
+        description: 'specify an external dependency, separate by comma'
+    }).option('prepare', {
+        type: 'boolean',
+        description: 'auto configure package.json exports for building'
+    }).option('tsconfig', {
+        type: 'string',
+        description: 'path to tsconfig file'
+    }).option('dts-bundle', {
+        type: 'boolean',
+        description: 'bundle type declaration files'
+    }).version(version).help('help', 'output usage information').showHelpOnFail(true).parse();
     const source = args._[0];
     const parsedArgs = {
         source,
-        format: args['--format'],
-        file: args['--output'],
-        watch: args['--watch'],
-        minify: args['--minify'],
-        sourcemap: !!args['--sourcemap'],
-        cwd: args['--cwd'],
-        dts: args['--no-dts'] ? false : undefined,
-        dtsBundle: args['--dts-bundle'],
-        help: args['--help'],
-        version: args['--version'],
-        runtime: args['--runtime'],
-        target: args['--target'],
-        external: !!args['--no-external'] ? null : args['--external'],
-        clean: !args['--no-clean'],
-        env: args['--env'],
-        prepare: !!args['--prepare'],
-        tsconfig: args['--tsconfig']
+        format: args['format'],
+        file: args['output'],
+        watch: args['watch'],
+        minify: args['minify'],
+        sourcemap: !!args['sourcemap'],
+        cwd: args['cwd'],
+        dts: args['dts'] === false ? false : undefined,
+        dtsBundle: args['dts-bundle'],
+        help: args['help'],
+        runtime: args['runtime'],
+        target: args['target'],
+        // no-external is a boolean flag, turning external to `false`
+        external: args['external'] === false ? null : args['external'],
+        clean: args['clean'] !== false,
+        env: args['env'],
+        prepare: !!args['prepare'],
+        tsconfig: args['tsconfig']
     };
     return parsedArgs;
 }
@@ -1060,12 +1094,6 @@ async function run(args) {
         clean,
         tsconfig
     };
-    if (args.version) {
-        return logger.log(version);
-    }
-    if (args.help) {
-        return help();
-    }
     if (args.prepare) {
         return await prepare(cwd);
     }
@@ -1073,10 +1101,16 @@ async function run(args) {
     // lint package
     await lint(cwd);
     const { default: ora } = await import('ora');
-    const oraInstance = ora({
+    const oraInstance = process.stdout.isTTY ? ora({
         text: 'Building...\n\n',
         color: 'green'
-    });
+    }) : {
+        start: ()=>{},
+        stop: ()=>{},
+        clear: ()=>{},
+        stopAndPersist: ()=>{},
+        isSpinning: false
+    };
     const spinner = {
         start: startSpinner,
         stop: stopSpinner
@@ -1156,12 +1190,12 @@ async function run(args) {
 async function main() {
     let params, error;
     try {
-        params = parseCliArgs(process.argv.slice(2));
+        params = await parseCliArgs(process.argv);
     } catch (err) {
         error = err;
     }
     if (error || !params) {
-        if (!error) help();
+        // if (!error) help()
         return exit(error);
     }
     await run(params);

package/dist/index.d.ts

@@ -38,7 +38,9 @@ type PackageMetadata = {
     exports?: string | Record<string, ExportCondition>;
     types?: string;
     typings?: string;
+    browserslist?: BrowserslistConfig;
 };
+type BrowserslistConfig = string | string[] | Record<string, string>;
 
 declare function bundle(cliEntryPath: string, { cwd: _cwd, ...options }?: BundleConfig): Promise<void>;
 

package/dist/index.js

@@ -142,6 +142,67 @@ const runtimeExportConventions = new Set([
     // Browser only
     'browser'
 ]);
+const runtimeExportConventionsFallback = new Map([
+    // ESM only runtime
+    [
+        'workerd',
+        [
+            'import',
+            'default'
+        ]
+    ],
+    [
+        'edge-light',
+        [
+            'import',
+            'default'
+        ]
+    ],
+    [
+        'browser',
+        [
+            'import',
+            'default'
+        ]
+    ],
+    // it could be CJS or ESM
+    [
+        'electron',
+        [
+            'default'
+        ]
+    ],
+    [
+        'react-server',
+        [
+            'default'
+        ]
+    ],
+    [
+        'react-native',
+        [
+            'default'
+        ]
+    ],
+    [
+        'node',
+        [
+            'default'
+        ]
+    ],
+    [
+        'deno',
+        [
+            'default'
+        ]
+    ],
+    [
+        'bun',
+        [
+            'default'
+        ]
+    ]
+]);
 const optimizeConventions = new Set([
     'development',
     'production'
@@ -1153,7 +1214,17 @@ function findJsBundlePathCallback({ format, bundlePath, conditionNames }, specia
     const hasFormatCond = conditionNames.has('import') || conditionNames.has('require');
     const isMatchedFormat = hasFormatCond ? conditionNames.has(formatCond) : true;
     const isMatchedConditionWithFormat = conditionNames.has(specialCondition) || !conditionNames.has('default') && hasNoSpecialCondition(conditionNames);
-    return isMatchedConditionWithFormat && !isTypesCondName && hasBundle && isMatchedFormat;
+    const match = isMatchedConditionWithFormat && !isTypesCondName && hasBundle && isMatchedFormat;
+    if (!match) {
+        const fallback = runtimeExportConventionsFallback.get(specialCondition);
+        if (!fallback) {
+            return false;
+        } else {
+            return fallback.some((name)=>conditionNames.has(name));
+        }
+    } else {
+        return match;
+    }
 }
 function findTypesFileCallback({ format, bundlePath, conditionNames }) {
     const hasCondition = bundlePath != null;
@@ -1316,7 +1387,7 @@ async function createDtsPlugin(tsCompilerOptions, tsConfigPath, respectExternal,
 const memoizeDtsPluginByKey = memoizeByKey(createDtsPlugin);
 async function buildInputConfig(entry, bundleConfig, exportCondition, buildContext, dts) {
     var _bundleConfig_file, _bundleConfig_file1;
-    const { entries, pkg, cwd, tsOptions: { tsConfigPath, tsCompilerOptions }, pluginContext } = buildContext;
+    const { entries, pkg, cwd, tsOptions: { tsConfigPath, tsCompilerOptions }, browserslistConfig, pluginContext } = buildContext;
     const isBinEntry = isBinExportPath(exportCondition.name);
     const hasNoExternal = bundleConfig.external === null;
     var _bundleConfig_external;
@@ -1342,9 +1413,10 @@ async function buildInputConfig(entry, bundleConfig, exportCondition, buildConte
         exportDefaultFrom: true,
         decorators: true
     };
+    const hasBrowserslistConfig = !!(browserslistConfig && !hasSpecifiedTsTarget);
     const swcOptions = {
         jsc: {
-            ...!hasSpecifiedTsTarget && {
+            ...!hasSpecifiedTsTarget && !hasBrowserslistConfig && {
                 target: jscTarget
             },
             loose: true,
@@ -1362,7 +1434,12 @@ async function buildInputConfig(entry, bundleConfig, exportCondition, buildConte
         },
         sourceMaps: bundleConfig.sourcemap,
         inlineSourcesContent: false,
-        isModule: true
+        isModule: true,
+        ...hasBrowserslistConfig && {
+            env: {
+                targets: browserslistConfig
+            }
+        }
     };
     const sizePlugin = pluginContext.outputState.plugin(cwd);
     // common plugins for both dts and ts assets that need to be processed
@@ -1823,6 +1900,10 @@ async function bundle(cliEntryPath, { cwd: _cwd, ...options } = {}) {
         await writeDefaultTsconfig(tsConfigPath);
         hasTsConfig = true;
     }
+    let browserslistConfig;
+    if (options.runtime === 'browser') {
+        browserslistConfig = pkg.browserslist;
+    }
     const outputState = createOutputState({
         entries
     });
@@ -1832,6 +1913,7 @@ async function bundle(cliEntryPath, { cwd: _cwd, ...options } = {}) {
         cwd,
         tsOptions: defaultTsOptions,
         useTypeScript: hasTsConfig,
+        browserslistConfig,
         pluginContext: {
             outputState,
             moduleDirectiveLayerMap: new Map()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunchee",
-  "version": "5.5.1",
+  "version": "5.6.1",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",
@@ -44,7 +44,6 @@
     "@rollup/pluginutils": "^5.1.0",
     "@swc/core": "^1.7.14",
     "@swc/helpers": "^0.5.11",
-    "arg": "^5.0.2",
     "clean-css": "^5.3.3",
     "magic-string": "^0.30.11",
     "ora": "^8.0.1",
@@ -53,7 +52,8 @@
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-swc3": "^0.11.1",
     "rollup-preserve-directives": "^1.1.2",
-    "tslib": "^2.7.0"
+    "tslib": "^2.7.0",
+    "yargs": "^17.7.2"
   },
   "peerDependencies": {
     "typescript": "^4.1 || ^5.0"
@@ -74,6 +74,7 @@
     "@types/clean-css": "^4.2.11",
     "@types/jest": "29.0.0",
     "@types/node": "^20.4.1",
+    "@types/yargs": "^17.0.33",
     "bunchee": "link:./",
     "cross-env": "^7.0.3",
     "husky": "^9.0.11",