pkgbld 1.25.0 → 1.27.0

package/README.md

@@ -178,6 +178,14 @@ pkgbld --format-package-json
 
 Formats package.json file.
 
+### no-pack
+
+Do not setup pack script in package.json
+
+```
+pkgbld --no-pack
+```
+
 ### prune (command)
 
 ```
@@ -186,6 +194,18 @@ pkgbld prune
 
 prune devDependencies and redundunt scripts from package.json
 
+### flatten
+
+```
+pkgbld prune --flatten=<directory>
+```
+
+Flattens file structure by moving all files from `dist` or other directory to the root directory and updating package.json.
+
+If the directory is not specified it is guessed from package.json.
+
+If files cannot be copied because of name conflicts the command will fail.
+
 ## Plugin API
 
 `pkgbld` reads all installed packages named `pkgbld-plugin-*` and assumes they are plugins

package/dist/index.js

@@ -141,6 +141,11 @@ const cliFlags = {
         type: Boolean,
         description: 'Format package.json',
         default: cliFlagsDefaults.formatPackageJson
+    },
+    noPack: {
+        type: Boolean,
+        description: 'Do not pack',
+        default: false
     }
 };
 const packageJsonFieldsOrder = new Set([
@@ -209,6 +214,15 @@ function toFormattedJson(json) {
     return JSON.stringify(json, null, 2) + '\n';
 }
 
+function FlattenParam(value) {
+    if (typeof value === 'boolean') {
+        return value; // false
+    }
+    if (value === '') {
+        return true; // means auto
+    }
+    return value; // string
+}
 function getCliOptions(plugins, pkg) {
     const cliOptions = cleye.cli({
         name: 'pkgbld',
@@ -223,6 +237,11 @@ function getCliOptions(plugins, pkg) {
                         type: String,
                         description: 'profile to use',
                         default: 'library'
+                    },
+                    flatten: {
+                        type: FlattenParam,
+                        description: 'flatten package files',
+                        default: false
                     }
                 }
             })
@@ -231,7 +250,8 @@ function getCliOptions(plugins, pkg) {
     if (cliOptions.command === 'prune') {
         return {
             kind: 'prune',
-            profile: cliOptions.flags.profile
+            profile: cliOptions.flags.profile,
+            flatten: cliOptions.flags.flatten
         };
     }
     else {
@@ -254,7 +274,8 @@ function getCliOptions(plugins, pkg) {
             commonjsPattern: flags.commonjsPattern,
             esPattern: flags.esmPattern,
             umdPattern: flags.umdPattern,
-            formatPackageJson: flags.formatPackageJson
+            formatPackageJson: flags.formatPackageJson,
+            noPack: flags.noPack
         };
         for (const plugin of plugins) {
             plugin.options?.(flags, options);
@@ -658,7 +679,18 @@ 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)) : ''}`;
 
+const emptySet = new Set;
 function processPackage(pkg, config, plugins) {
+    const exportsFields = new Set([
+        'types',
+        'import',
+        'require',
+        'svelte',
+        'default'
+    ]);
+    const typingsFilePattern = '[name].d.ts';
+    const indexId = 'index';
+    const typesVersionsLastFields = new Set(['*']);
     const inputs = [];
     const logger$1 = logger.createLogger();
     const allowEsm = (config.formatsOverridden && config.formats.includes('es') || !config.formatsOverridden);
@@ -684,7 +716,7 @@ function processPackage(pkg, config, plugins) {
     if (typeof pkg.scripts !== 'object' && pkg.scripts !== null) {
         pkg.scripts = {};
     }
-    if (!('prepack' in pkg.scripts)) {
+    if (!config.noPack && !('prepack' in pkg.scripts)) {
         const binary = typeof pkg.scripts.build === 'string' && pkg.scripts.build?.startsWith('pkgbld-internal') ? 'pkgbld-internal' : 'pkgbld';
         pkg.scripts.prepack = `${binary} prune`;
     }
@@ -700,9 +732,9 @@ function processPackage(pkg, config, plugins) {
     }
     pkg.types = `./${config.dir}/index.d.ts`;
     if (allowUmd && typeof pkg.umd === 'string') {
-        pkg.umd = `./${config.dir}/${patternToName(config.umdPattern, 'index')}`;
-        if (!config.umdInputs.includes('index')) {
-            config.umdInputs.push('index');
+        pkg.umd = `./${config.dir}/${patternToName(config.umdPattern, indexId)}`;
+        if (!config.umdInputs.includes(indexId)) {
+            config.umdInputs.push(indexId);
         }
     }
     if (config.bin) {
@@ -726,45 +758,57 @@ function processPackage(pkg, config, plugins) {
         delete pkg.bin;
     }
     if (allowCjs) {
-        pkg.main = `./${config.dir}/${patternToName(config.commonjsPattern, 'index')}`;
+        pkg.main = `./${config.dir}/${patternToName(config.commonjsPattern, indexId)}`;
     }
     if (allowEsm && !allowCjs) {
-        pkg.main = `./${config.dir}/${patternToName(config.esPattern, 'index')}`;
+        pkg.main = `./${config.dir}/${patternToName(config.esPattern, indexId)}`;
     }
     if (allowCjs && pkg.main !== pkg.exports['.'].require) {
         pkg.exports['.'].require = pkg.main;
     }
     if (allowCjs && allowEsm && typeof pkg.module !== 'string') {
-        pkg.module = `./${config.dir}/${patternToName(config.esPattern, 'index')}`;
+        pkg.module = `./${config.dir}/${patternToName(config.esPattern, indexId)}`;
     }
     if (pkg.module !== pkg.exports['.']?.default) {
         pkg.exports['.'].default = pkg.module;
     }
-    if (allowUmd && config.umdInputs.includes('index')) {
-        pkg.unpkg = `./${config.dir}/${patternToName(config.umdPattern, 'index')}`;
+    if (allowUmd && config.umdInputs.includes(indexId)) {
+        pkg.unpkg = `./${config.dir}/${patternToName(config.umdPattern, indexId)}`;
+    }
+    if (typeof pkg.typesVersions !== 'object' && pkg.typesVersions !== null) {
+        pkg.typesVersions = {};
+    }
+    if (typeof pkg.typesVersions['*'] !== 'object' && pkg.typesVersions['*'] !== null) {
+        pkg.typesVersions['*'] = {};
     }
     for (const id in pkg.exports) {
         if (id === './package.json')
             continue;
-        const basename = id == '.' ? 'index' : path.basename(id);
+        const basename = id == '.' ? indexId : path.basename(id);
         if (typeof pkg.exports[id] !== 'object') {
             pkg.exports[id] = {};
         }
-        pkg.exports[id].types = `./${config.dir}/${patternToName('[name].d.ts', basename)}`;
+        pkg.typesVersions['*'][id] = [`${config.dir}/${patternToName(typingsFilePattern, basename)}`];
+        pkg.exports[id].types = `./${config.dir}/${patternToName(typingsFilePattern, basename)}`;
         if (allowEsm) {
             pkg.exports[id].import = `./${config.dir}/${patternToName(config.esPattern, basename)}`;
         }
         if (allowCjs) {
             pkg.exports[id].require = `./${config.dir}/${patternToName(config.commonjsPattern, basename)}`;
         }
-        pkg.exports[id] = orderFields(pkg.exports[id]);
-        if (basename !== 'index') {
+        pkg.exports[id] = orderFields(exportsFields, pkg.exports[id]);
+        if (basename !== indexId) {
             if (!pkg.files.includes(basename)) {
                 pkg.files.push(basename);
             }
         }
         inputs.push(`./${config.sourceDir}/${basename}.ts`);
     }
+    pkg.typesVersions['*']['*'] = [
+        `${config.dir}/${patternToName(typingsFilePattern, indexId)}`,
+        `${config.dir}/*`
+    ];
+    pkg.typesVersions['*'] = orderFields(emptySet, pkg.typesVersions['*'], typesVersionsLastFields);
     if (allowUmd && config.umdInputs.length > 0 && !config.formats.includes('umd')) {
         config.formats.push('umd');
     }
@@ -776,22 +820,20 @@ function processPackage(pkg, config, plugins) {
 function patternToName(pattern, input) {
     return pattern.replace('[name]', input);
 }
-const fieldsOrder = new Set([
-    'types',
-    'import',
-    'require',
-    'svelte',
-    'default'
-]);
-function orderFields(exports) {
+function orderFields(firstFields, exports, lastFields = emptySet) {
     const ordered = {};
-    for (const key of fieldsOrder) {
+    for (const key of firstFields) {
         if (key in exports) {
             ordered[key] = exports[key];
         }
     }
     for (const key in exports) {
-        if (!fieldsOrder.has(key)) {
+        if (!firstFields.has(key) && !lastFields.has(key)) {
+            ordered[key] = exports[key];
+        }
+    }
+    for (const key of lastFields) {
+        if (key in exports) {
             ordered[key] = exports[key];
         }
     }
@@ -802,7 +844,7 @@ async function writeJson(path, json) {
     await fs.writeFile(path, toFormattedJson(json));
 }
 
-var version = "1.25.0";
+var version = "1.27.0";
 var name = "pkgbld";
 var license = "MIT";
 var author = "Konstantin Shutkin";
@@ -841,10 +883,10 @@ var dependencies = {
 	rollup: "^4.0.0",
 	"rollup-plugin-typescript2": "^0.36.0",
 	"rollup-plugin-preprocess": "^0.0.4",
-	"@rollup/plugin-commonjs": "^25.0.5",
+	"@rollup/plugin-commonjs": "^25.0.7",
 	"@rollup/plugin-terser": "^0.4.4",
 	"@rollup/plugin-json": "^6.0.1",
-	"@rollup/plugin-node-resolve": "^15.2.2",
+	"@rollup/plugin-node-resolve": "^15.2.3",
 	"@rollup-extras/plugin-clean": "^1.3.8",
 	"@rollup-extras/plugin-binify": "^1.1.9",
 	"@rollup-extras/plugin-externals": "^1.2.0",
@@ -853,7 +895,8 @@ var dependencies = {
 	"is-builtin-module": "^3.2.1",
 	terser: "^5.21.0",
 	kleur: "^4.1.5",
-	cleye: "^1.3.2"
+	cleye: "^1.3.2",
+	jsonata: "^2.0.3"
 };
 var devDependencies = {
 	"@types/lodash": "^4.14.199",
@@ -1028,31 +1071,186 @@ function loadPlugins(pkg) {
         .map(packageName => import(packageName)));
 }
 
-const scriptsToKeep = new Set([
-    'preinstall',
-    'install',
-    'postinstall',
-    'prepublish',
-    'preprepare',
-    'prepare',
-    'postprepare'
-]);
-function prunePkg(pkg, options) {
+async function prunePkg(pkg, options, logger) {
     if (options.kind !== 'prune') {
         throw new Error('prunePkg should only be called in prune mode');
     }
-    if (options.profile !== 'library') {
-        throw new Error('only library profile is supported');
+    const scriptsToKeep = getScriptsData();
+    const keys = scriptsToKeep[options.profile];
+    if (!keys) {
+        throw new Error(`unknown profile ${options.profile}`);
     }
     delete pkg.devDependencies;
     for (const key of Object.keys(pkg.scripts)) {
-        if (!scriptsToKeep.has(key)) {
+        if (!keys.has(key)) {
             delete pkg.scripts[key];
         }
     }
     if (Object.keys(pkg.scripts).length === 0) {
         delete pkg.scripts;
     }
+    if (options.flatten) {
+        await flatten(pkg, options.flatten, logger);
+    }
+}
+async function flatten(pkg, flatten, logger) {
+    const { default: jsonata } = await import('jsonata');
+    // find out where is the dist folder
+    const expression = jsonata('[bin, main, module, unpkg, umd, types, typings, exports[].*.*, typesVersions.*.*]');
+    const allReferences = (await expression.evaluate(pkg));
+    let distDir;
+    if (flatten === true) {
+        let commonSegments;
+        for (const entry of allReferences) {
+            if (typeof entry !== 'string') {
+                continue;
+            }
+            const dirname = path.dirname(entry);
+            const cleanedSegments = dirname.split('/').filter(path => path && path !== '.');
+            if (!commonSegments) {
+                commonSegments = cleanedSegments;
+            }
+            else {
+                for (let i = 0; i < commonSegments.length; ++i) {
+                    if (commonSegments[i] !== cleanedSegments[i]) {
+                        commonSegments.length = i;
+                        break;
+                    }
+                }
+            }
+        }
+        distDir = commonSegments?.join('/');
+    }
+    else {
+        distDir = flatten;
+    }
+    if (!distDir) {
+        throw new Error('could not find dist folder');
+    }
+    logger.update(`flattening ${distDir}...`);
+    // check if dist can be flattened
+    const relativeDistDir = './' + distDir;
+    const existsPromises = [];
+    const filesInDist = await walkDir(relativeDistDir);
+    for (const file of filesInDist) {
+        // check file is not in root dir
+        const relativePath = path.relative(relativeDistDir, file);
+        existsPromises.push(isExists(relativePath));
+    }
+    const exists = await Promise.all(existsPromises);
+    const filesAlreadyExist = exists.filter(Boolean);
+    if (filesAlreadyExist.length) {
+        throw new Error(`dist folder cannot be flattened because files already exist: ${filesAlreadyExist.join(', ')}`);
+    }
+    // move files to root dir (rename)
+    const renamePromises = [];
+    const newFiles = [];
+    for (const file of filesInDist) {
+        // check file is not in root dir
+        const relativePath = path.relative(relativeDistDir, file);
+        newFiles.push(relativePath);
+        renamePromises.push(fs.rename(file, relativePath));
+    }
+    await Promise.all(renamePromises);
+    // remove dist folder
+    try {
+        await fs.rm(relativeDistDir, { recursive: true, force: true });
+    }
+    catch (e) {
+        // ignore
+    }
+    const allReferencesSet = new Set(allReferences);
+    // update package.json
+    const stringToReplace = distDir + '/';
+    const pkgClone = cloneAndUpdate(pkg, value => allReferencesSet.has(value) ? value.replace(stringToReplace, '') : value);
+    Object.assign(pkg, pkgClone);
+    // update files
+    let files = pkg.files ?? [];
+    files = files.filter(file => {
+        let fileNormilized = path.normalize(file);
+        if (fileNormilized.endsWith('/')) {
+            // remove trailing slash
+            fileNormilized = fileNormilized.slice(0, -1);
+        }
+        return fileNormilized !== distDir;
+    });
+    files.push(...newFiles);
+    pkg.files = [...files];
+}
+function cloneAndUpdate(pkg, updater) {
+    if (typeof pkg === 'string') {
+        return updater(pkg);
+    }
+    if (Array.isArray(pkg)) {
+        return pkg.map(value => cloneAndUpdate(value, updater));
+    }
+    if (typeof pkg === 'object' && pkg !== null) {
+        const clone = {};
+        for (const key of Object.keys(pkg)) {
+            clone[key] = cloneAndUpdate(pkg[key], updater);
+        }
+        return clone;
+    }
+    return pkg;
+}
+async function isExists(file) {
+    try {
+        await fs.access(file);
+    }
+    catch (e) {
+        if (typeof e === 'object' && e != null && 'code' in e && e.code === 'ENOENT') {
+            return false;
+        }
+        throw e;
+    }
+    return file;
+}
+async function walkDir(dir) {
+    const entries = await fs.readdir(dir, { withFileTypes: true });
+    const files = [];
+    await Promise.all(entries.map(entry => {
+        const childPath = path.join(dir, entry.name);
+        if (entry.isDirectory()) {
+            return walkDir(childPath)
+                .then(childFiles => {
+                files.push(...childFiles);
+            });
+        }
+        else {
+            files.push(childPath);
+        }
+    }).filter(Boolean));
+    return files;
+}
+function getScriptsData() {
+    const libraryScripts = new Set([
+        'preinstall',
+        'install',
+        'postinstall',
+        'prepublish',
+        'preprepare',
+        'prepare',
+        'postprepare'
+    ]);
+    const appScripts = new Set([
+        ...libraryScripts,
+        'prestart',
+        'start',
+        'poststart',
+        'prerestart',
+        'restart',
+        'postrestart',
+        'prestop',
+        'stop',
+        'poststop',
+        'pretest',
+        'test',
+        'posttest'
+    ]);
+    return {
+        library: libraryScripts,
+        app: appScripts
+    };
 }
 
 execute();
@@ -1070,7 +1268,7 @@ async function execute() {
         process.stdout.moveCursor?.(0, -1);
         const options = getCliOptions(plugins, pkg);
         if (options.kind === 'prune') {
-            prunePkg(pkg, options);
+            await prunePkg(pkg, options, mainLogger);
             await writeJson(pkgPath, pkg);
             process.exit(0);
         }

package/dist/src/eject.d.ts

@@ -1,4 +1,5 @@
-import type { CliOptions, PackageJson, PkgbldRollupPlugin, Provider } from './types';
+import type { CliOptions, PkgbldRollupPlugin, Provider } from './types';
+import type { PackageJson } from 'options';
 import type { RollupOptions } from 'rollup';
 import { getHelpers } from './helpers';
 export declare function createEjectProvider(preimportMap: Map<string, Promise<never>>): Promise<[Provider, PkgbldRollupPlugin[]]>;

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

@@ -1,4 +1,5 @@
-import { PackageJson, PkgbldPlugin } from './types';
+import { PkgbldPlugin } from './types';
+import { PackageJson } from 'options';
 export declare function getCliOptions(plugins: Partial<PkgbldPlugin>[], pkg: PackageJson): {
     kind: 'build';
     umdInputs: string[];
@@ -18,7 +19,9 @@ export declare function getCliOptions(plugins: Partial<PkgbldPlugin>[], pkg: Pac
     esPattern: string;
     umdPattern: string;
     formatPackageJson: boolean;
+    noPack: boolean;
 } | {
     readonly kind: "prune";
     readonly profile: string;
+    readonly flatten: string | boolean;
 };

package/dist/src/helpers.d.ts

@@ -1,5 +1,5 @@
 import { OutputOptions } from 'rollup';
-import { PackageJson } from './types';
+import { PackageJson } from 'options';
 export declare function getHelpers(pkgName: string): {
     getGlobalName: (anInput: string) => string;
     getExternalGlobalName: (id: string) => string;

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

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

package/dist/src/prune.d.ts

@@ -1,5 +1,7 @@
-import { PackageJson } from './types';
+import { Logger } from '@niceties/logger';
+import { PackageJson } from 'options';
 export declare function prunePkg(pkg: PackageJson, options: {
     kind: 'prune';
     profile: string;
-}): void;
+    flatten: string | boolean;
+}, logger: Logger): Promise<void>;

package/dist/src/types.d.ts

@@ -1,17 +1,10 @@
 import type { Plugin, InternalModuleFormat, OutputOptions } from 'rollup';
 import type { getCliOptions } from './get-cli-options';
 import { Logger } from '@niceties/logger';
+import { PackageJson } from 'options';
 export type Json = null | string | number | boolean | Json[] | {
     [name: string]: Json;
 };
-export type PackageJson = {
-    name: string;
-    version: string;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-    peerDependencies: Record<string, string>;
-    scripts?: Record<string, string>;
-};
 export declare const enum Priority {
     preprocess = 1000,
     cleanup = 1000,

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.25.0",
+  "version": "1.27.0",
   "name": "pkgbld",
   "license": "MIT",
   "author": "Konstantin Shutkin",
@@ -33,10 +33,10 @@
     "rollup": "^4.0.0",
     "rollup-plugin-typescript2": "^0.36.0",
     "rollup-plugin-preprocess": "^0.0.4",
-    "@rollup/plugin-commonjs": "^25.0.5",
+    "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-json": "^6.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.2",
+    "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup-extras/plugin-clean": "^1.3.8",
     "@rollup-extras/plugin-binify": "^1.1.9",
     "@rollup-extras/plugin-externals": "^1.2.0",
@@ -45,7 +45,8 @@
     "is-builtin-module": "^3.2.1",
     "terser": "^5.21.0",
     "kleur": "^4.1.5",
-    "cleye": "^1.3.2"
+    "cleye": "^1.3.2",
+    "jsonata": "^2.0.3"
   },
   "peerDependencies": {
     "typescript": "^5.2.2"