pkgbld 1.19.0 → 1.21.0

package/README.md

@@ -170,6 +170,14 @@ pkgbld --umd-pattern=[name].js
 
 Defines the pattern for umd output files. Default is `[name].umd.js`.
 
+### format-package-json
+
+```
+pkgbld --format-package-json
+```
+
+Formats package.json file.
+
 ## Plugin API
 
 `pkgbld` reads all installed packages named `pkgbld-plugin-*` and assumes they are plugins

package/dist/index.js

@@ -30,7 +30,19 @@ async function createSubpackages(inputs, config) {
     }
 }
 
-const defaults = {
+function CommaSeparatedString(value) {
+    return value.split(',').map((arg) => arg.trim());
+}
+function CommaSeparatedStringOrBoolean(value) {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    if (Array.isArray(value) && value.length === 0) {
+        return true;
+    }
+    return CommaSeparatedString(value);
+}
+const cliFlagsDefaults = {
     formats: ['es', 'cjs'],
     umdInputs: [],
     compressFormats: ['umd'],
@@ -44,100 +56,158 @@ const defaults = {
     noUpdatePackageJson: false,
     commonjsPattern: '[name].cjs',
     esPattern: '[name].mjs',
-    umdPattern: '[name].umd.js'
+    umdPattern: '[name].umd.js',
+    formatPackageJson: false
 };
-function CommaSeparatedString(value) {
-    return value.split(',').map((arg) => arg.trim());
-}
-function CommaSeparatedStringOrBoolean(value) {
-    if (typeof value === 'boolean') {
-        return value;
+const cliFlags = {
+    umd: {
+        type: CommaSeparatedString,
+        description: 'Package subpath exports in UMD format',
+        default: cliFlagsDefaults.umdInputs
+    },
+    compress: {
+        type: CommaSeparatedString,
+        description: 'Compress formats using terser',
+        default: cliFlagsDefaults.compressFormats
+    },
+    sourcemaps: {
+        type: CommaSeparatedString,
+        description: 'Emit sourcemaps for the specified formats',
+        default: cliFlagsDefaults.sourcemapFormats
+    },
+    formats: {
+        type: CommaSeparatedString,
+        description: 'Formats to emit',
+        default: cliFlagsDefaults.formats
+    },
+    preprocess: {
+        type: CommaSeparatedString,
+        description: 'Preprocess entry points / subpath exports',
+        default: cliFlagsDefaults.preprocess
+    },
+    dir: {
+        type: String,
+        description: 'Output directory',
+        default: cliFlagsDefaults.dir
+    },
+    sourceDir: {
+        type: String,
+        description: 'Source directory',
+        default: cliFlagsDefaults.sourceDir
+    },
+    bin: {
+        type: CommaSeparatedString,
+        description: 'Executable files'
+    },
+    includeExternals: {
+        type: CommaSeparatedStringOrBoolean,
+        description: 'Include all/specified externals into result bundle(s)',
+        default: cliFlagsDefaults.includeExternals
+    },
+    eject: {
+        type: Boolean,
+        description: 'Eject config',
+        default: cliFlagsDefaults.eject
+    },
+    noTsConfig: {
+        type: Boolean,
+        description: 'Do not create / update tsconfig.json',
+        default: cliFlagsDefaults.noTsConfig
+    },
+    noUpdatePackageJson: {
+        type: Boolean,
+        description: 'Do not create / update package.json',
+        default: cliFlagsDefaults.noUpdatePackageJson
+    },
+    commonjsPattern: {
+        type: String,
+        description: 'CommonJS output file name pattern',
+        default: cliFlagsDefaults.commonjsPattern
+    },
+    esmPattern: {
+        type: String,
+        description: 'ES output file name pattern',
+        default: cliFlagsDefaults.esPattern
+    },
+    umdPattern: {
+        type: String,
+        description: 'UMD output file name pattern',
+        default: cliFlagsDefaults.umdPattern
+    },
+    formatPackageJson: {
+        type: Boolean,
+        description: 'Format package.json',
+        default: cliFlagsDefaults.formatPackageJson
     }
-    if (Array.isArray(value) && value.length === 0) {
-        return true;
+};
+const packageJsonFieldsOrder = new Set([
+    'private',
+    'type',
+    'version',
+    'name',
+    'description',
+    'license',
+    'author',
+    'contributors',
+    'funding',
+    'bin',
+    'main',
+    'browser',
+    'unpkg',
+    'module',
+    'exports',
+    'imports',
+    'types',
+    'typings',
+    'files',
+    'packageManager',
+    'sideEffects',
+    'engines',
+    'os',
+    'cpu',
+    'man',
+    'directories',
+    'repository',
+    'bugs',
+    'homepage',
+    'readme',
+    'keywords',
+    'scripts',
+    'config',
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'peerDependenciesMeta',
+    'bundleDependencies',
+    'bundledDependencies',
+    'optionalDependencies',
+    'overrides',
+    'publishConfig',
+    'workspaces'
+]);
+function processPackageJson(pkg, needTreatment, treatKey) {
+    const newPkg = {};
+    for (const key of packageJsonFieldsOrder) {
+        if (needTreatment(key)) {
+            newPkg[key] = treatKey(key);
+        }
     }
-    return CommaSeparatedString(value);
+    for (const key in pkg) {
+        if (!packageJsonFieldsOrder.has(key)) {
+            newPkg[key] = pkg[key];
+        }
+    }
+    return newPkg;
+}
+function toFormattedJson(json) {
+    return JSON.stringify(json, null, 2) + '\n';
 }
+
 function getCliOptions(plugins, pkg) {
     const cliOptions = cleye.cli({
         name: 'pkgbld',
         version: pkg.version ?? '<unknown>',
-        flags: {
-            umd: {
-                type: CommaSeparatedString,
-                description: 'Package subpath exports in UMD format',
-                default: defaults.umdInputs
-            },
-            compress: {
-                type: CommaSeparatedString,
-                description: 'Compress formats using terser',
-                default: defaults.compressFormats
-            },
-            sourcemaps: {
-                type: CommaSeparatedString,
-                description: 'Emit sourcemaps for the specified formats',
-                default: defaults.sourcemapFormats
-            },
-            formats: {
-                type: CommaSeparatedString,
-                description: 'Formats to emit',
-                default: defaults.formats
-            },
-            preprocess: {
-                type: CommaSeparatedString,
-                description: 'Preprocess entry points / subpath exports',
-                default: defaults.preprocess
-            },
-            dir: {
-                type: String,
-                description: 'Output directory',
-                default: defaults.dir
-            },
-            sourceDir: {
-                type: String,
-                description: 'Source directory',
-                default: defaults.sourceDir
-            },
-            bin: {
-                type: CommaSeparatedString,
-                description: 'Executable files'
-            },
-            includeExternals: {
-                type: CommaSeparatedStringOrBoolean,
-                description: 'Include all/specified externals into result bundle(s)',
-                default: defaults.includeExternals
-            },
-            eject: {
-                type: Boolean,
-                description: 'Eject config',
-                default: defaults.eject
-            },
-            noTsConfig: {
-                type: Boolean,
-                description: 'Do not create / update tsconfig.json',
-                default: defaults.noTsConfig
-            },
-            noUpdatePackageJson: {
-                type: Boolean,
-                description: 'Do not create / update package.json',
-                default: defaults.noUpdatePackageJson
-            },
-            commonjsPattern: {
-                type: String,
-                description: 'CommonJS output file name pattern',
-                default: defaults.commonjsPattern
-            },
-            esmPattern: {
-                type: String,
-                description: 'ES output file name pattern',
-                default: defaults.esPattern
-            },
-            umdPattern: {
-                type: String,
-                description: 'UMD output file name pattern',
-                default: defaults.umdPattern
-            }
-        }
+        flags: cliFlags
     });
     const flags = cliOptions.flags;
     const options = {
@@ -145,7 +215,7 @@ function getCliOptions(plugins, pkg) {
         compressFormats: flags.compress,
         sourcemapFormats: flags.sourcemaps,
         formats: flags.formats,
-        formatsOverridden: flags.formats !== defaults.formats,
+        formatsOverridden: flags.formats !== cliFlagsDefaults.formats,
         preprocess: flags.preprocess,
         dir: flags.dir,
         sourceDir: flags.sourceDir,
@@ -156,7 +226,8 @@ function getCliOptions(plugins, pkg) {
         noUpdatePackageJson: flags.noUpdatePackageJson,
         commonjsPattern: flags.commonjsPattern,
         esPattern: flags.esmPattern,
-        umdPattern: flags.umdPattern
+        umdPattern: flags.umdPattern,
+        formatPackageJson: flags.formatPackageJson
     };
     for (const plugin of plugins) {
         plugin.options?.(flags, options);
@@ -224,7 +295,7 @@ function includeExternals(importer, external, id, config) {
     if (!external)
         return false;
     if (path.isAbsolute(id)) {
-        id = './' + path.relative(process.cwd(), id);
+        id = path.relative(path.join(process.cwd(), '..'), id);
     }
     const internals = config.includeExternals;
     if (internals.includes(id) || internals.some(internal => id.startsWith(internal))) {
@@ -384,6 +455,9 @@ function getTimeDiff(starting) {
     return `${now - starting}ms`;
 }
 const areSetsEqual = (a, b) => a.size === b.size ? [...a].every(value => b.has(value)) : false;
+function formatPackageJson(pkg) {
+    return processPackageJson(pkg, key => key in pkg, key => pkg[key]);
+}
 
 async function getRollupConfigs([provider, plugins$1], inputs, config, helpers, externalPlugins) {
     const factoryInProgress = [];
@@ -669,10 +743,10 @@ function patternToName(pattern, input) {
 }
 
 async function writeJson(path, json) {
-    await fs.writeFile(path, JSON.stringify(json, null, 2) + '\n');
+    await fs.writeFile(path, toFormattedJson(json));
 }
 
-var version = "1.19.0";
+var version = "1.21.0";
 var name = "pkgbld";
 var license = "MIT";
 var author = "Konstantin Shutkin";
@@ -708,7 +782,7 @@ var dependencies = {
 	"@niceties/draftlog-appender": "^1.3.0",
 	lodash: "^4.17.21",
 	rollup: "^3.20.2",
-	"rollup-plugin-typescript2": "^0.35.0",
+	"rollup-plugin-typescript2": "^0.36.0",
 	"rollup-plugin-preprocess": "^0.0.4",
 	"@rollup/plugin-commonjs": "^25.0.0",
 	"@rollup/plugin-terser": "^0.4.0",
@@ -726,7 +800,8 @@ var dependencies = {
 };
 var devDependencies = {
 	"@types/lodash": "^4.14.192",
-	"@total-typescript/ts-reset": "^0.5.1"
+	"@total-typescript/ts-reset": "^0.5.1",
+	options: "workspace:*"
 };
 var peerDependencies = {
 	typescript: "^5.2.2"
@@ -899,7 +974,10 @@ async function execute() {
     const mainLogger = logger.createLogger();
     mainLogger.update('preparing..');
     try {
-        const [pkgPath, pkg] = await getJson('package.json');
+        let pkg;
+        let pkgPath;
+        // eslint-disable-next-line prefer-const
+        [pkgPath, pkg] = await getJson('package.json');
         const plugins = await loadPlugins(pkg);
         mainLogger.update('');
         process.stdout.moveCursor?.(0, -1);
@@ -908,6 +986,9 @@ async function execute() {
         mainLogger.update('preparing...');
         checkTsConfig(options, mainLogger, plugins);
         const inputs = processPackage(pkg, options, plugins);
+        if (options.formatPackageJson) {
+            pkg = formatPackageJson(pkg);
+        }
         const helpers = getHelpers(pkg.name);
         const preimportMap = preimport();
         const provider = options.eject ? await createEjectProvider(preimportMap) : createProvider(preimportMap);

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

@@ -16,4 +16,5 @@ export declare function getCliOptions(plugins: Partial<PkgbldPlugin>[], pkg: Pac
     commonjsPattern: string;
     esPattern: string;
     umdPattern: string;
+    formatPackageJson: boolean;
 };

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

@@ -21,7 +21,7 @@ export declare function getRollupConfigs([provider, plugins]: [Provider, PkgbldR
         externalLiveBindings?: boolean | undefined;
         file?: string | undefined;
         footer?: string | import("rollup").AddonFunction | undefined;
-        format: "umd" | "es" | "cjs" | "amd" | "iife" | "system" | "commonjs" | "esm" | "module" | "systemjs";
+        format: "umd" | "amd" | "cjs" | "es" | "iife" | "system" | "commonjs" | "esm" | "module" | "systemjs";
         freeze?: boolean | undefined;
         generatedCode?: import("rollup").GeneratedCodePreset | import("rollup").GeneratedCodeOptions | undefined;
         globals?: import("rollup").GlobalsOption | undefined;

package/dist/src/helpers.d.ts

@@ -1,4 +1,5 @@
 import { OutputOptions } from 'rollup';
+import { PackageJson } from './types';
 export declare function getHelpers(pkgName: string): {
     getGlobalName: (anInput: string) => string;
     getExternalGlobalName: (id: string) => string;
@@ -8,3 +9,4 @@ export declare function formatInput(input: string[] | string): string;
 export declare function formatOutput(output: OutputOptions | OutputOptions[] | undefined, field: 'dir' | 'format'): string;
 export declare function getTimeDiff(starting: number): string;
 export declare const areSetsEqual: <T>(a: Set<T>, b: Set<T>) => boolean;
+export declare function formatPackageJson(pkg: PackageJson): PackageJson;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.19.0",
+  "version": "1.21.0",
   "name": "pkgbld",
   "license": "MIT",
   "author": "Konstantin Shutkin",
@@ -31,7 +31,7 @@
     "@niceties/draftlog-appender": "^1.3.0",
     "lodash": "^4.17.21",
     "rollup": "^3.20.2",
-    "rollup-plugin-typescript2": "^0.35.0",
+    "rollup-plugin-typescript2": "^0.36.0",
     "rollup-plugin-preprocess": "^0.0.4",
     "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-terser": "^0.4.0",
@@ -49,7 +49,8 @@
   },
   "devDependencies": {
     "@types/lodash": "^4.14.192",
-    "@total-typescript/ts-reset": "^0.5.1"
+    "@total-typescript/ts-reset": "^0.5.1",
+    "options": "0.0.0"
   },
   "peerDependencies": {
     "typescript": "^5.2.2"