pkgbld 1.12.0 → 1.14.0

package/README.md

@@ -6,7 +6,7 @@ It is simple building tool that supports building to different targets like: `es
 
 ## Why
 
-It is created to easily build libraries that contains mutliple subpackages (exports, entry points) because it is not that easy to do at the moment with `microbundle`, `tsdx` or `ng-packagr`.
+It is created to easily build libraries that contains mutliple subpath exports (entry points, subpackages) because it is not that easy to do at the moment with `microbundle`, `tsdx` or `ng-packagr` (if you are on Typescript).
 
 ## Installation
 
@@ -15,6 +15,32 @@ Using npm:
 npm install --save-dev pkgbld
 ```
 
+### Getting started (minimalistic start from scratch)
+
+1. Start from creating pcakage.json using `npm init`
+2. Add pkgbld `npm install --save-dev pkgbld`
+3. Add `tsconfig.json` file into root project directory
+```json
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "esModuleInterop": true,
+    "strict": true,
+  }
+}
+
+```
+4. Create `src/index.ts`
+5. Add pkgbld in scripts field of your package.json like:
+```json
+  "scripts": {
+    "build": "pkgbld"
+  },
+```
+
+Run `npm run build`.
+
 ## package.json
 
 `pkgbld` expects name field to be filled in the package.json file. `exports` field defines what entries/outputs should be build for this package.
@@ -81,6 +107,22 @@ pkgbld --sourcedir=src
 
 Directory to search for input files.
 
+### bin
+
+```
+pkgbld --bin=./dist/index.cjs,./dist/index.mjs
+```
+
+File(s) to make executable. First entry will be added to package.json
+
+### include-externals
+
+```
+pkgbld --include-externals
+```
+
+Bundles all externals into package.
+
 # License
 
 [MIT](./LICENSE)

package/dist/builtin-plugins/binify.d.ts

@@ -0,0 +1,3 @@
+import { getCliOptions } from '../get-cli-options';
+import { Provider } from '../types';
+export default function (provide: Provider, config: ReturnType<typeof getCliOptions>): Promise<void>;

package/dist/get-cli-options.d.ts

@@ -3,7 +3,10 @@ export declare function getCliOptions(): {
     compressFormats: string[];
     sourcemapFormats: string[];
     formats: string[];
+    formatsOverriden: boolean;
     preprocess: string[];
     dir: string;
     sourceDir: string;
+    bin?: string[] | undefined;
+    includeExternals: boolean;
 };

package/dist/index.js

@@ -33,10 +33,11 @@ const defaults = {
     sourcemapFormats: ['umd'],
     preprocess: [],
     dir: 'dist',
-    sourceDir: 'src'
+    sourceDir: 'src',
+    includeExternals: false
 };
 function getCliOptions() {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     const parsedArgs = minimist(process.argv.slice(2));
     const umdInputs = (_b = (_a = parsedArgs.umd) === null || _a === void 0 ? void 0 : _a.split(',').map((arg) => arg.trim())) !== null && _b !== void 0 ? _b : defaults.umdInputs;
     const compressFormats = (_d = (_c = parsedArgs.compress) === null || _c === void 0 ? void 0 : _c.split(',').map((arg) => arg.trim())) !== null && _d !== void 0 ? _d : defaults.compressFormats;
@@ -45,14 +46,19 @@ function getCliOptions() {
     const preprocess = (_k = (_j = parsedArgs.preprocess) === null || _j === void 0 ? void 0 : _j.split(',').map((arg) => arg.trim())) !== null && _k !== void 0 ? _k : defaults.preprocess;
     const dir = (_l = parsedArgs.dir) !== null && _l !== void 0 ? _l : defaults.dir;
     const sourceDir = (_m = parsedArgs.sourceDir) !== null && _m !== void 0 ? _m : defaults.sourceDir;
+    const bin = (_o = parsedArgs.bin) === null || _o === void 0 ? void 0 : _o.split(',').map((arg) => arg.trim());
+    const includeExternals = (_p = parsedArgs['include-externals']) !== null && _p !== void 0 ? _p : defaults.includeExternals;
     return {
         umdInputs,
         compressFormats,
         sourcemapFormats,
         formats,
+        formatsOverriden: 'formats' in parsedArgs,
         preprocess,
         dir,
-        sourceDir
+        sourceDir,
+        bin,
+        includeExternals
     };
 }
 
@@ -65,7 +71,7 @@ async function getPackage() {
 async function clean (provide) {
     const { default: pluginClean } = await import('@rollup-extras/plugin-clean');
     const pluginInstance = pluginClean();
-    provide(pluginFactory, 100 /* Priotiry.cleanup */, { outputPlugin: true });
+    provide(pluginFactory, 1000 /* Priotiry.cleanup */, { outputPlugin: true });
     let firstPluginInstance = true;
     function pluginFactory() {
         const result = firstPluginInstance ? pluginInstance : pluginInstance.api.addInstance();
@@ -76,21 +82,24 @@ async function clean (provide) {
 
 async function commonjs (provide) {
     const { default: pluginCommonjs } = await import('@rollup/plugin-commonjs');
-    provide(() => pluginCommonjs(), 400 /* Priotiry.commonjs */);
+    provide(() => pluginCommonjs(), 4000 /* Priotiry.commonjs */);
 }
 
 async function externals (provide, config, inputs) {
+    if (config.includeExternals) {
+        return;
+    }
     const { default: pluginExternals } = await import('@rollup-extras/plugin-externals');
     const allowGenericUmd = config.umdInputs.length === 1 && inputs.length === 1;
     if (config.formats.length > 0) {
         const format = (allowGenericUmd ? undefined : config.formats.filter(format => format !== 'umd'));
-        provide(() => pluginExternals(), 200 /* Priotiry.externals */, { format });
+        provide(() => pluginExternals(), 2000 /* Priotiry.externals */, { format });
     }
     if (!allowGenericUmd && config.umdInputs.length > 0) {
         for (const currentInput of config.umdInputs) {
             provide(() => pluginExternals({
                 external: (id, external) => external || isExternalInput(currentInput, inputs, id, config)
-            }), 200 /* Priotiry.externals */, { format: 'umd', inputs: [`./${config.sourceDir}/${currentInput}.ts`] });
+            }), 2000 /* Priotiry.externals */, { format: 'umd', inputs: [`./${config.sourceDir}/${currentInput}.ts`] });
         }
     }
 }
@@ -114,11 +123,11 @@ async function preprocess (provide, config) {
         const include = config.preprocess.map(name => `${config.sourceDir}/${name}.ts`);
         for (const format of config.formats) {
             if (format !== 'umd') {
-                provide(() => pluginPreprocess({ include, context: { [format]: true } }), 100 /* Priotiry.preprocess */, { format });
+                provide(() => pluginPreprocess({ include, context: { [format]: true } }), 1000 /* Priotiry.preprocess */, { format });
             }
             else {
                 for (const currentInput of config.umdInputs) {
-                    provide(() => pluginPreprocess({ include, context: { umd: true } }), 100 /* Priotiry.preprocess */, { format, inputs: [`./${config.sourceDir}/${currentInput}.ts`] });
+                    provide(() => pluginPreprocess({ include, context: { umd: true } }), 1000 /* Priotiry.preprocess */, { format, inputs: [`./${config.sourceDir}/${currentInput}.ts`] });
                 }
             }
         }
@@ -127,7 +136,7 @@ async function preprocess (provide, config) {
 
 async function resolve (provide) {
     const { default: pluginResolve } = await import('@rollup/plugin-node-resolve');
-    provide(() => pluginResolve(), 300 /* Priotiry.resolve */);
+    provide(() => pluginResolve(), 3000 /* Priotiry.resolve */);
 }
 
 async function terser (provide, config) {
@@ -158,7 +167,21 @@ async function terser (provide, config) {
 
 async function typescript (provide) {
     const { default: pluginTypescript } = await import('rollup-plugin-typescript2');
-    provide(() => pluginTypescript(), 600 /* Priotiry.transpile */);
+    provide(() => pluginTypescript(), 6000 /* Priotiry.transpile */);
+}
+
+async function binify (provide, config) {
+    var _a;
+    if (config.bin != null) {
+        const { default: pluginBinify } = await import('@rollup-extras/plugin-binify');
+        const format = (_a = {
+            'cjs': 'cjs',
+            'mjs': 'es'
+        }[path.extname(config.bin[0])]) !== null && _a !== void 0 ? _a : 'cjs';
+        provide(() => pluginBinify({
+            filter: (item) => item.type === 'chunk' && item.isEntry && config.bin.some(input => input === `./${config.dir}/${item.fileName}`)
+        }), 20000 /* Priotiry.finalize */, { outputPlugin: true, format });
+    }
 }
 
 const plugins = [
@@ -168,7 +191,8 @@ const plugins = [
     preprocess,
     resolve,
     terser,
-    typescript
+    typescript,
+    binify
 ];
 function createProvider() {
     const plugins = [];
@@ -383,6 +407,9 @@ function processPackage(pkg, config) {
     var _a;
     const input = [];
     const logger$1 = logger.createLogger();
+    const allowEsm = (config.formatsOverriden && config.formats.includes('es') || !config.formatsOverriden);
+    const allowCjs = (config.formatsOverriden && config.formats.includes('cjs') || !config.formatsOverriden);
+    const allowUmd = (config.formatsOverriden && config.formats.includes('umd') || !config.formatsOverriden || config.umdInputs);
     if (typeof pkg !== 'object' || Array.isArray(pkg)) {
         logger$1.finish('expecting object on top level of package.json', 3 /* LogLevel.error */);
         process.exit(-1);
@@ -404,25 +431,47 @@ function processPackage(pkg, config) {
         pkg.exports['.'] = {};
     }
     pkg.exports['./package.json'] = './package.json';
-    if (typeof pkg.umd === 'string') {
+    if (allowUmd && typeof pkg.umd === 'string') {
         pkg.umd = `./${config.dir}/index.umd.js`;
         if (!config.umdInputs.includes('index')) {
             config.umdInputs.push('index');
         }
     }
-    if (typeof pkg.main !== 'string') {
+    if (config.bin) {
+        if (config.bin.length > 0) {
+            if (config.bin[0] === '') {
+                delete pkg.bin;
+            }
+            else {
+                pkg.bin = config.bin[0];
+            }
+            config.bin = config.bin.filter(Boolean);
+            if (config.bin.length === 0) {
+                delete config.bin;
+            }
+        }
+    }
+    else {
+        if (typeof pkg.bin === 'string') {
+            config.bin = [pkg.bin];
+        }
+        else {
+            delete pkg.bin;
+        }
+    }
+    if (allowCjs && typeof pkg.main !== 'string') {
         pkg.main = `./${config.dir}/index.cjs`;
     }
-    if (pkg.main !== pkg.exports['.'].require) {
+    if (allowCjs && pkg.main !== pkg.exports['.'].require) {
         pkg.exports['.'].require = pkg.main;
     }
-    if (typeof pkg.module !== 'string') {
+    if (allowEsm && typeof pkg.module !== 'string') {
         pkg.module = `./${config.dir}/index.mjs`;
     }
-    if (pkg.module !== ((_a = pkg.exports['.']) === null || _a === void 0 ? void 0 : _a.default)) {
+    if (allowEsm && pkg.module !== ((_a = pkg.exports['.']) === null || _a === void 0 ? void 0 : _a.default)) {
         pkg.exports['.'].default = pkg.module;
     }
-    if (config.umdInputs.includes('index')) {
+    if (allowUmd && config.umdInputs.includes('index')) {
         pkg.unpkg = `./${config.dir}/index.umd.js`;
     }
     for (const id in pkg.exports) {
@@ -432,8 +481,12 @@ function processPackage(pkg, config) {
         if (typeof pkg.exports[id] !== 'object') {
             pkg.exports[id] = {};
         }
-        pkg.exports[id].require = `./${config.dir}/${basename}.cjs`;
-        pkg.exports[id].default = `./${config.dir}/${basename}.mjs`;
+        if (allowCjs) {
+            pkg.exports[id].require = `./${config.dir}/${basename}.cjs`;
+        }
+        if (allowEsm) {
+            pkg.exports[id].default = `./${config.dir}/${basename}.mjs`;
+        }
         if (basename !== 'index') {
             if (!pkg.files.includes(basename)) {
                 pkg.files.push(basename);
@@ -441,7 +494,7 @@ function processPackage(pkg, config) {
         }
         input.push(`./${config.sourceDir}/${basename}.ts`);
     }
-    if (config.umdInputs.length > 0 && !config.formats.includes('umd')) {
+    if (allowUmd && config.umdInputs.length > 0 && !config.formats.includes('umd')) {
         config.formats.push('umd');
     }
     return input;

package/dist/types.d.ts

@@ -8,13 +8,14 @@ export type Json = null | string | number | boolean | Json[] | {
     [name: string]: Json;
 };
 export declare const enum Priotiry {
-    preprocess = 100,
-    cleanup = 100,
-    externals = 200,
-    resolve = 300,
-    commonjs = 400,
-    transpile = 600,
-    compress = 10000
+    preprocess = 1000,
+    cleanup = 1000,
+    externals = 2000,
+    resolve = 3000,
+    commonjs = 4000,
+    transpile = 6000,
+    compress = 10000,
+    finalize = 20000
 }
 export type Provider = (factory: () => Plugin, priority: Priotiry, options?: {
     format?: InternalModuleFormat | InternalModuleFormat[];

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.12.0",
+  "version": "1.14.0",
   "license": "MIT",
   "name": "pkgbld",
   "author": {
@@ -9,7 +9,8 @@
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "LICENSE"
   ],
   "engines": {
     "node": ">=16"
@@ -45,7 +46,6 @@
     "conventional-changelog-angular": "5.0.13",
     "eslint": "8.33.0",
     "semantic-release": "19.0.5",
-    "@rollup-extras/plugin-binify": "1.1.5",
     "@types/node": "18.11.18"
   },
   "dependencies": {
@@ -59,6 +59,7 @@
     "@rollup/plugin-terser": "0.4.0",
     "@rollup/plugin-node-resolve": "15.0.1",
     "@rollup-extras/plugin-clean": "1.3.4",
+    "@rollup-extras/plugin-binify": "1.1.5",
     "@rollup-extras/plugin-externals": "1.1.7",
     "@slimlib/refine-partition": "1.0.0",
     "typescript": "4.9.4",