bunchee 6.0.0-beta.1 → 6.0.0-rc.1

package/README.md

@@ -40,6 +40,20 @@ cd ./my-lib
 mkdir src && touch ./src/index.ts
 ```
 
+#### Build
+
+Then files in `src` folders will be treated as entry files and match the export names in package.json. For example:
+`src/index.ts` will match the exports name `"."` or the only main export.
+
+Now just run `npm run build` (or `pnpm build` / `yarn build`) if you're using these package managers, `bunchee` will find the entry files and build them.
+The output format will based on the exports condition and also the file extension. Given an example:
+
+- It's CommonJS for `require` and ESM for `import` based on the exports condition.
+- It's CommonJS for `.js` and ESM for `.mjs` based on the extension regardless the exports condition. Then for export condition like "node" you could choose the format with your extension.
+
+> [!NOTE]
+> All the `dependencies` and `peerDependencies` will be marked as external automatically and not included in the bundle. If you want to include them in the bundle, you can use the `--no-external` option.
+
 #### Prepare
 
 ```sh
@@ -128,19 +142,17 @@ If you're using TypeScript with Node 10 and Node 16 module resolution, you can u
 
 </details>
 
-#### Build
+#### Lint
 
-Then files in `src` folders will be treated as entry files and match the export names in package.json. For example:
-`src/index.ts` will match the exports name `"."` or the only main export.
+`lint` command will check the package.json configuration is valid or not, it can valid few things like:
 
-Now just run `npm run build` (or `pnpm build` / `yarn build`) if you're using these package managers, `bunchee` will find the entry files and build them.
-The output format will based on the exports condition and also the file extension. Given an example:
+- if the entry files are matched with the exports conditions.
+- if the entry files are matched with the exports paths.
 
-- It's CommonJS for `require` and ESM for `import` based on the exports condition.
-- It's CommonJS for `.js` and ESM for `.mjs` based on the extension regardless the exports condition. Then for export condition like "node" you could choose the format with your extension.
-
-> [!NOTE]
-> All the `dependencies` and `peerDependencies` will be marked as external automatically and not included in the bundle. If you want to include them in the bundle, you can use the `--no-external` option.
+```sh
+# Use bunchee to lint if the package.json configuration is valid
+npm exec bunchee lint
+```
 
 ## Usage
 

package/dist/bin/cli.js

@@ -6,6 +6,7 @@ var perf_hooks = require('perf_hooks');
 var fs = require('fs');
 var fsp = require('fs/promises');
 var require$$0 = require('tty');
+var picomatch = require('picomatch');
 var index_js = require('../index.js');
 require('module');
 var glob = require('glob');
@@ -18,6 +19,7 @@ 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);
+var picomatch__default = /*#__PURE__*/_interopDefault(picomatch);
 var prettyBytes__default = /*#__PURE__*/_interopDefault(prettyBytes);
 
 const availableExtensions = new Set([
@@ -217,6 +219,14 @@ function sourceFilenameToExportFullPath(filename) {
     const exportPath = filename.slice(0, -ext.length);
     return relativify(exportPath);
 }
+// If the file is matching the private module convention file export path.
+// './lib/_foo' -> true
+// './_util/index' -> true
+// './lib/_foo/bar' -> true
+// './foo' -> false
+function isPrivateExportPath(exportPath) {
+    return /\/_/.test(exportPath);
+}
 
 function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exportToDist) {
     // End of searching, export value is file path.
@@ -371,6 +381,49 @@ function validateTypesFieldCondition(pair) {
     }
     return false;
 }
+const isPathIncluded = (filesField, filePath)=>{
+    return filesField.some((pattern)=>{
+        const normalizedPattern = path__default.default.normalize(pattern);
+        const matcher = picomatch__default.default(normalizedPattern);
+        return matcher(filePath);
+    });
+};
+function validateFilesField(packageJson) {
+    const state = {
+        definedField: false,
+        missingFiles: []
+    };
+    const filesField = packageJson.files || [];
+    const exportsField = packageJson.exports || {};
+    state.definedField = !!packageJson.files;
+    const resolveExportsPaths = (exports)=>{
+        const paths = [];
+        if (typeof exports === 'string') {
+            paths.push(exports);
+        } else if (typeof exports === 'object') {
+            for(const key in exports){
+                paths.push(...resolveExportsPaths(exports[key]));
+            }
+        }
+        return paths;
+    };
+    const exportedPaths = resolveExportsPaths(exportsField).map((p)=>path__default.default.normalize(p));
+    const commonFields = [
+        'main',
+        'module',
+        'types',
+        'module-sync'
+    ];
+    for (const field of commonFields){
+        if (field in packageJson) {
+            exportedPaths.push(packageJson[field]);
+        }
+    }
+    state.missingFiles = exportedPaths.filter((exportPath)=>{
+        return !isPathIncluded(filesField, exportPath);
+    });
+    return state;
+}
 function lint$1(pkg) {
     const { name, main, exports } = pkg;
     const isESM = isESModulePackage(pkg.type);
@@ -494,6 +547,15 @@ function lint$1(pkg) {
             }
         }
     }
+    const fieldState = validateFilesField(pkg);
+    if (!fieldState.definedField) {
+        logger.warn('Missing files field in package.json');
+    } else if (fieldState.missingFiles.length) {
+        logger.warn('Missing files in package.json');
+        fieldState.missingFiles.forEach((p)=>{
+            logger.warn(`  ${p}`);
+        });
+    }
     if (state.badMainExtension) {
         logger.warn('Cannot export `main` field with .mjs extension in CJS package, only .js extension is allowed');
     }
@@ -539,7 +601,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "6.0.0-beta.1";
+var version = "6.0.0-rc.1";
 
 async function writeDefaultTsconfig(tsConfigPath) {
     await fs.promises.writeFile(tsConfigPath, JSON.stringify(DEFAULT_TS_CONFIG, null, 2), 'utf-8');
@@ -916,12 +978,21 @@ function logOutputState(stats) {
         }).forEach((item, index)=>{
             const [filename, , size] = item;
             const normalizedExportName = normalizeExportName(exportName);
-            const prefix = index === 0 ? normalizedExportName : ' '.repeat(normalizedExportName.length);
+            const exportNameWithPadding = index === 0 ? // For other formats, just show the padding spaces.
+            normalizedExportName : ' '.repeat(normalizedExportName.length);
             const filenamePadding = ' '.repeat(Math.max(maxLengthOfExportName, 'Exports'.length) - normalizedExportName.length);
             const isType = isTypeFile(filename);
-            const sizePadding = ' '.repeat(Math.max(maxFilenameLength, 'File'.length) - filename.length);
             const prettiedSize = prettyBytes__default.default(size);
-            console.log(prefix, filenamePadding, `${pc[isType ? 'dim' : 'bold'](filename)}`, sizePadding, prettiedSize);
+            const sizePadding = ' '.repeat(Math.max(maxFilenameLength, 'File'.length) - filename.length);
+            // Logging shared in debug mode
+            if (isPrivateExportPath(exportName)) {
+                if (index === 0 && process.env.DEBUG) {
+                    const sizePadding = ' '.repeat(Math.max(maxFilenameLength, 'File'.length) - 'private shared'.length);
+                    console.log(pc.dim(normalizeExportName(exportName)), filenamePadding, pc.dim('private shared'), sizePadding, pc.dim(prettiedSize));
+                }
+                return;
+            }
+            console.log(exportNameWithPadding, filenamePadding, `${pc[isType ? 'dim' : 'bold'](filename)}`, sizePadding, prettiedSize);
         });
     });
 }
@@ -930,7 +1001,8 @@ const helpMessage = `
 Usage: bunchee [options]
 
 Commands:
-prepare                  auto configure package.json exports for building
+prepare                  auto setup package.json for building
+lint                     lint configuration in package.json
 
 Options:
   -v, --version          output the version number
@@ -1027,6 +1099,12 @@ async function parseCliArgs(argv) {
     }).command('lint', 'lint package.json', ()=>{}, (argv)=>{
         return lint(argv.cwd || process.cwd());
     }).version(version).help('help', 'output usage information').showHelpOnFail(true).parse();
+    const cmd = args._[0];
+    if (cmd === 'prepare' || cmd === 'lint') {
+        return {
+            cmd
+        };
+    }
     const source = args._[0];
     const parsedArgs = {
         source,
@@ -1172,6 +1250,9 @@ async function main() {
         // if (!error) help()
         return exit(error);
     }
+    if ('cmd' in params) {
+        return;
+    }
     await run(params);
 }
 function logWatcherBuildTime(result, spinner) {

package/dist/index.d.ts

@@ -31,6 +31,7 @@ type PackageMetadata = {
     main?: string;
     bin?: string | Record<string, string>;
     module?: string;
+    files?: string[];
     type?: 'commonjs' | 'module';
     dependencies?: Record<string, string>;
     peerDependencies?: Record<string, string>;

package/dist/index.js

@@ -1056,7 +1056,7 @@ async function writeDefaultTsconfig(tsConfigPath) {
 const FILENAME_REGEX = /__filename/;
 const DIRNAME_REGEX = /__dirname/;
 // not char, or space before require(.resolve)?(
-const GLOBAL_REQUIRE_REGEX = /(?:^|[^.\w'"`])\brequire(\.resolve)?\(\s*[\r\n]*(['"`])/;
+const GLOBAL_REQUIRE_REGEX = /(?:^|[^.\w'"`])\brequire(\.resolve)?\(\s*[\r\n]*(\w|['"`])/;
 const PolyfillComment = '/** rollup-private-do-not-use-esm-shim-polyfill */';
 const createESMShim = ({ filename, dirname, globalRequire })=>{
     const useNodeUrl = filename || dirname;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunchee",
-  "version": "6.0.0-beta.1",
+  "version": "6.0.0-rc.1",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",
@@ -48,6 +48,7 @@
     "glob": "^11.0.0",
     "magic-string": "^0.30.11",
     "ora": "^8.0.1",
+    "picomatch": "^4.0.2",
     "pretty-bytes": "^5.6.0",
     "rollup": "^4.27.4",
     "rollup-plugin-dts": "^6.1.1",
@@ -75,6 +76,7 @@
     "@types/clean-css": "^4.2.11",
     "@types/jest": "29.0.0",
     "@types/node": "^22.9.3",
+    "@types/picomatch": "^3.0.1",
     "@types/yargs": "^17.0.33",
     "bunchee": "link:./",
     "cross-env": "^7.0.3",
@@ -114,10 +116,10 @@
     "test:ci": "[ -z $CI ] || pnpm test",
     "clean": "rm -rf ./dist",
     "typecheck": "tsc --noEmit && tsc -p test/tsconfig.json --noEmit",
-    "cli": "cross-env SWC_NODE_IGNORE_DYNAMIC=1 node -r @swc-node/register",
-    "ts-bunchee": "pnpm cli ./src/bin/index.ts",
+    "run-ts": "cross-env SWC_NODE_IGNORE_DYNAMIC=1 node -r @swc-node/register",
+    "ts-bunchee": "pnpm run-ts ./src/bin/index.ts",
     "build-dir": "pnpm ts-bunchee --cwd",
-    "build": "pnpm cli ./src/bin/index.ts --runtime node",
+    "build": "pnpm run-ts ./src/bin/index.ts --runtime node",
     "format": "prettier --write ."
   }
 }