pkgbld 1.15.7 → 1.16.1

package/README.md

@@ -4,13 +4,13 @@
 
 Rollup based build tool for building libraries based on package.json config and simple CLI options.
 
-It is simple building tool that supports building to different targets like: `es`, `cjs`, `umd` without additional trasformation other than minification using `terser` or preprocess using `rollup-plugin-preprocess`.
+It is a simple building tool that supports building to different targets like: `es`, `cjs`, `umd` without additional transformation other than minification using `terser` or preprocess using `rollup-plugin-preprocess`.
 
-[Changlelog](./CHANGELOG.md)
+[Changelog](./CHANGELOG.md)
 
 ## Why
 
-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).
+It is created to easily build libraries that contains multiple 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
 
@@ -36,7 +36,7 @@ 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.
+`pkgbld` expects the name field to be filled in the package.json file. `exports` field defines what entries/outputs should be built for this package.
 
 ## CLI options
 
@@ -82,7 +82,7 @@ Defines what formats to build, only supports `es` and `cjs` at the moment. Use `
 pkgbld --preprocess=index
 ```
 
-Defines what entry points/files should be preprocessed using `rollup-plugin-preprocess`. For the entry point will be defined variable es (for esm target), cjs (for commonjs) and umd (for umd) depending on the target type. Please request more variables / more granular logic if you want more.
+Defines what entry points/files should be preprocessed using `rollup-plugin-preprocess`. The entry point will be defined as variable es (for esm target), cjs (for commonjs) and umd (for umd) depending on the target type. Please request more variables / more granular logic if you want more.
 
 ### dir
 
@@ -114,7 +114,7 @@ File(s) to make executable. First entry will be added to package.json
 pkgbld --include-externals
 ```
 
-Bundles all externals into package.
+Bundles all externals into a package.
 
 ### eject
 
@@ -140,6 +140,23 @@ pkgbld --no-update-package-json
 
 Do not write package.json.
 
+## Plugin API
+
+`pkgbld` reads all installed packages named `pkgbld-plugin-*` and assumes they are plugins
+
+Plugins suppose to implement one or more of following interface methods as their package exports:
+
+```
+interface PkgbldPlugin {
+    options(parsedArgs: {[key: string]: string | number}, options: ReturnType<typeof getCliOptions>): void;
+    processPackageJson(packageJson: PackageJson, inputs: string[], logger: Logger): void;
+    processTsConfig(config: Json): void;
+    providePlugins(provider: Provider, config: Record<string, string | string[] | boolean>, inputs: string[]): Promise<void>;
+    getExtraOutputSettings(format: InternalModuleFormat, inputs: string[]): Partial<OutputOptions>;
+    buildEnd(): Promise<void>;
+}
+```
+
 # License
 
 [MIT](https://github.com/kshutkin/package-build/blob/main/LICENSE)

package/dist/index.js

@@ -11,7 +11,9 @@ var refiner = require('@slimlib/refine-partition');
 var camelCase = require('lodash/camelCase');
 var kleur = require('kleur');
 var lodash = require('lodash');
-var fs$1 = require('fs');
+var fsSync = require('fs');
+var cloneDeep = require('lodash/cloneDeep');
+var isEqual = require('lodash/isEqual');
 
 async function createSubpackages(inputs, config) {
     for (const input of inputs) {
@@ -41,7 +43,7 @@ const defaults = {
     noTsConfig: false,
     noUpdatePackageJson: false
 };
-function getCliOptions() {
+function getCliOptions(plugins) {
     const parsedArgs = minimist(process.argv.slice(2));
     const umdInputs = parsedArgs.umd?.split(',').map((arg) => arg.trim()) ?? defaults.umdInputs;
     const compressFormats = parsedArgs.compress?.split(',').map((arg) => arg.trim()) ?? defaults.compressFormats;
@@ -55,7 +57,7 @@ function getCliOptions() {
     const eject = !!parsedArgs.eject ?? defaults.eject;
     const noTsConfig = !!parsedArgs.noTsConfig ?? defaults.noTsConfig;
     const noUpdatePackageJson = !!parsedArgs.noUpdatePackageJson ?? defaults.noUpdatePackageJson;
-    return {
+    const options = {
         umdInputs,
         compressFormats,
         sourcemapFormats,
@@ -70,10 +72,14 @@ function getCliOptions() {
         noTsConfig,
         noUpdatePackageJson
     };
+    for (const plugin of plugins) {
+        plugin.options && plugin.options(parsedArgs, options);
+    }
+    return options;
 }
 
-async function getPackage() {
-    const pkgPath = path.resolve('package.json');
+async function getJson(fileName) {
+    const pkgPath = path.resolve(fileName);
     const buffer = await fs.readFile(pkgPath);
     return [pkgPath, JSON.parse(buffer.toString())];
 }
@@ -186,7 +192,7 @@ async function typescript (provider) {
 }
 
 async function binify (provider, config) {
-    if (config.bin != null) {
+    if (config.bin != null && config.bin.length > 0) {
         const pluginBinify = await provider.import('@rollup-extras/plugin-binify');
         const format = {
             'cjs': 'cjs',
@@ -272,10 +278,15 @@ const fileNamePatterns = {
     'cjs': '[name].cjs',
     'umd': '[name].umd.js',
 };
-async function getRollupConfigs([provider, plugins$1], inputs, config, helpers) {
+async function getRollupConfigs([provider, plugins$1], inputs, config, helpers, externalPlugins) {
+    const factoryInProgress = [];
     for (const factory of plugins) {
-        await factory(provider, config, inputs);
+        factoryInProgress.push(factory(provider, config, inputs));
     }
+    for (const ePlugin of externalPlugins) {
+        ePlugin.providePlugins && factoryInProgress.push(ePlugin.providePlugins(provider, config, inputs));
+    }
+    await Promise.all(factoryInProgress);
     const expandInputs = new Set;
     for (const plugin of plugins$1) {
         if (plugin.format && plugin.inputs?.length && !plugin.outputPlugin) {
@@ -369,10 +380,12 @@ async function getRollupConfigs([provider, plugins$1], inputs, config, helpers)
         };
     });
     function getExtraOutputSettings(format, inputs) {
+        let result = {};
         switch (format) {
             case 'cjs':
             case 'es':
-                return { chunkFileNames: fileNamePatterns[format] };
+                result = { chunkFileNames: fileNamePatterns[format] };
+                break;
             case 'umd':
                 if (inputs.length <= 0) {
                     break;
@@ -380,12 +393,16 @@ async function getRollupConfigs([provider, plugins$1], inputs, config, helpers)
                 if (inputs.length > 1) {
                     throw new Error(`Cannot produce global name for mutliple umd inputs in one output: ${inputs}`);
                 }
-                return {
-                    name: helpers.getGlobalName(inputs[0]),
+                result = {
+                    name: helpers.getGlobalName(inputs.join('_')),
                     globals: helpers.getExternalGlobalName,
                 };
+                break;
+        }
+        for (const ePlugin of externalPlugins) {
+            ePlugin.getExtraOutputSettings && Object.assign(result, ePlugin.getExtraOutputSettings(format, inputs));
         }
-        return {};
+        return result;
     }
     function getPlugins(formats, inputs, outputPlugin) {
         const filteredPlugins = [];
@@ -431,8 +448,8 @@ async function getRollupConfigs([provider, plugins$1], inputs, config, helpers)
 
 const mainLoggerText = (sourceDir, dir, configsCount, startingTime, finishedCount = 0) => (final = false) => `${sourceDir} → ${dir} ${final ? configsCount : finishedCount++} / ${configsCount}${final ? (' in ' + getTimeDiff(startingTime)) : ''}`;
 
-function processPackage(pkg, config) {
-    const input = [];
+function processPackage(pkg, config, plugins) {
+    const inputs = [];
     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);
@@ -519,19 +536,22 @@ function processPackage(pkg, config) {
                 pkg.files.push(basename);
             }
         }
-        input.push(`./${config.sourceDir}/${basename}.ts`);
+        inputs.push(`./${config.sourceDir}/${basename}.ts`);
     }
     if (allowUmd && config.umdInputs.length > 0 && !config.formats.includes('umd')) {
         config.formats.push('umd');
     }
-    return input;
+    for (const plugin of plugins) {
+        plugin.processPackageJson && plugin.processPackageJson(pkg, inputs, logger$1);
+    }
+    return inputs;
 }
 
 async function writeJson(path, json) {
     await fs.writeFile(path, JSON.stringify(json, null, 2) + '\n');
 }
 
-var version = "1.15.7";
+var version = "1.16.1";
 var license = "MIT";
 var name = "pkgbld";
 var author = {
@@ -586,11 +606,13 @@ var dependencies = {
 	"@slimlib/refine-partition": "^1.0.0",
 	"@slimlib/smart-mock": "^0.1.2",
 	"is-builtin-module": "^3.2.1",
-	typescript: "^5.0.2",
 	terser: "^5.16.8",
 	minimist: "^1.2.8",
 	kleur: "^4.1.5"
 };
+var peerDependencies = {
+	typescript: "^5.0.2"
+};
 var pkgbldPkg = {
 	version: version,
 	license: license,
@@ -607,7 +629,8 @@ var pkgbldPkg = {
 	keywords: keywords,
 	scripts: scripts,
 	devDependencies: devDependencies,
-	dependencies: dependencies
+	dependencies: dependencies,
+	peerDependencies: peerDependencies
 };
 
 const imports = new Map;
@@ -713,21 +736,42 @@ const defaultTsConfig = {
         module: 'esnext',
         esModuleInterop: true,
         strict: true,
+        noUncheckedIndexedAccess: true,
         declaration: true,
         moduleResolution: 'node'
     }
 };
-async function checkTsConfig(options, mainLogger) {
+async function checkTsConfig(options, mainLogger, plugins) {
     if (options.noTsConfig) {
         return;
     }
     const tsConfigPath = path.resolve('tsconfig.json');
-    if (fs$1.existsSync(tsConfigPath)) {
-        return;
+    let config, needWrite = false;
+    if (fsSync.existsSync(tsConfigPath)) {
+        [, config] = await getJson('tsconfig.json');
     }
-    mainLogger('no tsconfig.json and --no-ts-config not specified, writing tsconfig...');
-    await writeJson(tsConfigPath, defaultTsConfig);
-    mainLogger('done');
+    else {
+        config = defaultTsConfig;
+        needWrite = true;
+    }
+    const originalConfig = cloneDeep(config);
+    for (const plugin of plugins) {
+        plugin.processTsConfig && plugin.processTsConfig(config);
+    }
+    if (!isEqual(originalConfig, config)) {
+        needWrite = true;
+    }
+    if (needWrite) {
+        mainLogger('no tsconfig.json and --no-ts-config not specified, writing tsconfig...');
+        await writeJson(tsConfigPath, config);
+        mainLogger('done');
+    }
+}
+
+function loadPlugins(pkg) {
+    return Promise.all(Object.keys(pkg.devDependencies || {})
+        .filter(packageName => packageName.startsWith('pkgbld-plugin-'))
+        .map(packageName => import(packageName)));
 }
 
 execute();
@@ -737,14 +781,15 @@ async function execute() {
     const mainLogger = logger.createLogger();
     mainLogger.update('preparing...');
     try {
-        const [pkgPath, pkg] = await getPackage();
-        const options = getCliOptions();
-        checkTsConfig(options, mainLogger);
-        const inputs = processPackage(pkg, options);
+        const [pkgPath, pkg] = await getJson('package.json');
+        const plugins = await loadPlugins(pkg);
+        const options = getCliOptions(plugins);
+        checkTsConfig(options, mainLogger, plugins);
+        const inputs = processPackage(pkg, options, plugins);
         const helpers = getHelpers(pkg.name);
         const preimportMap = preimport();
         const provider = options.eject ? await createEjectProvider(preimportMap) : createProvider(preimportMap);
-        const rollupConfigs = await getRollupConfigs(provider, inputs, options, helpers);
+        const rollupConfigs = await getRollupConfigs(provider, inputs, options, helpers, plugins);
         if (options.eject) {
             await ejectConfig(rollupConfigs, pkgPath, options, inputs, helpers, pkg);
             mainLogger.finish(`ejected config in ${getTimeDiff(time)}`);
@@ -760,6 +805,9 @@ async function execute() {
                 await writeJson(pkgPath, pkg);
             }
             await createSubpackages(inputs, options);
+            await Promise.all(plugins
+                .filter(plugin => plugin.buildEnd)
+                .map(plugin => plugin.buildEnd()));
             mainLogger.finish(updater(true));
         }
     }

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

@@ -1,4 +1,5 @@
-export declare function getCliOptions(): {
+import { PkgbldPlugin } from './types';
+export declare function getCliOptions(plugins: Partial<PkgbldPlugin>[]): {
     umdInputs: string[];
     compressFormats: string[];
     sourcemapFormats: string[];

package/dist/src/get-json.d.ts

@@ -0,0 +1,2 @@
+import { Json } from './types';
+export declare function getJson(fileName: string): Promise<[string, Json]>;

package/dist/src/get-rollup-configs.d.ts

@@ -1,7 +1,7 @@
 import type { getCliOptions } from './get-cli-options';
 import type { getHelpers } from './helpers';
-import type { PkgbldRollupPlugin, Provider } from './types';
-export declare function getRollupConfigs([provider, plugins]: [Provider, PkgbldRollupPlugin[]], inputs: string[], config: ReturnType<typeof getCliOptions>, helpers: ReturnType<typeof getHelpers>): Promise<{
+import type { PkgbldPlugin, PkgbldRollupPlugin, Provider } from './types';
+export declare function getRollupConfigs([provider, plugins]: [Provider, PkgbldRollupPlugin[]], inputs: string[], config: ReturnType<typeof getCliOptions>, helpers: ReturnType<typeof getHelpers>, externalPlugins: Partial<PkgbldPlugin>[]): Promise<{
     input: string[];
     output: {
         amd?: import("rollup").AmdOptions | undefined;

package/dist/src/load-plugins.d.ts

@@ -0,0 +1,2 @@
+import { PackageJson, PkgbldPlugin } from './types';
+export declare function loadPlugins(pkg: PackageJson): Promise<Partial<PkgbldPlugin>[]>;

package/dist/src/process-pkg.d.ts

@@ -1,3 +1,3 @@
 import { getCliOptions } from './get-cli-options';
-import { Json } from './types';
-export declare function processPackage(pkg: Json, config: ReturnType<typeof getCliOptions>): string[];
+import { Json, PkgbldPlugin } from './types';
+export declare function processPackage(pkg: Json, config: ReturnType<typeof getCliOptions>, plugins: Partial<PkgbldPlugin>[]): string[];

package/dist/src/{check-ts-config.d.ts → process-ts-config.d.ts}

@@ -1,3 +1,4 @@
 import { Logger } from '@niceties/logger';
 import { getCliOptions } from './get-cli-options';
-export declare function checkTsConfig(options: ReturnType<typeof getCliOptions>, mainLogger: Logger): Promise<void>;
+import { PkgbldPlugin } from './types';
+export declare function checkTsConfig(options: ReturnType<typeof getCliOptions>, mainLogger: Logger, plugins: Partial<PkgbldPlugin>[]): Promise<void>;

package/dist/src/types.d.ts

@@ -1,9 +1,6 @@
-import type { Plugin, InternalModuleFormat } from 'rollup';
-/**
- * export interface Replacer {
-    name: string;
-    used: () => void;
-}*/
+import type { Plugin, InternalModuleFormat, OutputOptions } from 'rollup';
+import type { getCliOptions } from './get-cli-options';
+import { Logger } from '@niceties/logger';
 export type Json = null | string | number | boolean | Json[] | {
     [name: string]: Json;
 };
@@ -41,3 +38,13 @@ export type PkgbldRollupPlugin = {
     inputs?: string[];
     outputPlugin?: true;
 };
+export interface PkgbldPlugin {
+    options(parsedArgs: {
+        [key: string]: string | number;
+    }, options: ReturnType<typeof getCliOptions>): void;
+    processPackageJson(packageJson: PackageJson, inputs: string[], logger: Logger): void;
+    processTsConfig(config: Json): void;
+    providePlugins(provider: Provider, config: Record<string, string | string[] | boolean>, inputs: string[]): Promise<void>;
+    getExtraOutputSettings(format: InternalModuleFormat, inputs: string[]): Partial<OutputOptions>;
+    buildEnd(): Promise<void>;
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.15.7",
+  "version": "1.16.1",
   "license": "MIT",
   "name": "pkgbld",
   "author": {
@@ -50,11 +50,13 @@
     "@slimlib/refine-partition": "^1.0.0",
     "@slimlib/smart-mock": "^0.1.2",
     "is-builtin-module": "^3.2.1",
-    "typescript": "^5.0.2",
     "terser": "^5.16.8",
     "minimist": "^1.2.8",
     "kleur": "^4.1.5"
   },
+  "peerDependencies": {
+    "typescript": "^5.0.2"
+  },
   "scripts": {
     "build": "rollup -c",
     "lint": "eslint ./src"

package/dist/src/get-pkg.d.ts

@@ -1,2 +0,0 @@
-import { Json } from './types';
-export declare function getPackage(): Promise<[string, Json]>;