create-pkgbld 1.1.10 → 1.3.0

package/dist/index.cjs

@@ -7,139 +7,176 @@ var fs = require('fs/promises');
 var userName = require('git-user-name');
 var gitConfig = require('parse-git-config');
 var minimist = require('minimist');
-var degit = require('degit');
+var kleur = require('kleur');
 
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 async function execute() {
-    const myPkg = await readPackage(path.resolve(__dirname, '..'));
-    console.log('create-pkgbld ' + myPkg.pkg.version);
-    const parsedArgs = minimist(process.argv.slice(2));
-    const packageName = parsedArgs._[0];
-    const dir = packageName ?? '.';
+    await reportVersion();
+    const targetDir = getTargetDir();
+    console.log(kleur.grey(pad16plus('Target Directory', 0)) + kleur.white(targetDir));
+    const pkg = await readPackage(targetDir);
+    console.log(kleur.grey(pad16plus('Mode', 0)) + kleur.white(pkg.mode));
+    const packageName = path.basename(targetDir);
     let cancelled = false;
-    const chooseAction = await prompts({
-        type: 'select',
-        name: 'action',
-        message: 'What do you need to do?',
-        choices: [
-            { title: 'Create Monorepo Root', value: 'root' },
-            { title: 'Create a Subpackage', value: 'subpackage' }
-        ],
-        initial: 1
-    }, { onCancel });
-    if (cancelled) {
-        process.exit(-1);
-    }
-    let rootPkg = {
-        pkg: {},
-        readme: ''
-    };
-    if (chooseAction.action === 'subpackage') {
-        rootPkg = await readPackage(path.resolve(dir, packageName ? '..' : '.'));
-    }
-    const template = chooseAction.action === 'root' ? 'kshutkin/monorepo-root' : 'kshutkin/monorepo-package';
-    const emitter = degit(template, {
-        cache: false,
-        force: true,
-        verbose: true,
-    });
-    emitter.on('info', (info) => {
-        console.log(info.message);
-    });
-    await emitter.clone(dir);
-    const basePackageName = (packageName && path.basename(packageName)) || path.basename(process.cwd());
-    if (chooseAction.action === 'root') {
-        const response = await prompts([{
-                type: 'text',
-                name: 'name',
-                message: 'package name',
-                initial: basePackageName
-            }, {
-                type: 'text',
-                name: 'scope',
-                message: 'scope (without @ or empty)'
-            }, {
-                type: 'text',
-                name: 'description',
-                message: 'description',
-                initial: ''
-            }], { onCancel });
+    const options = getBasicOptions(packageName);
+    options.push(...await getGitOptions(packageName));
+    const state = getOptionsValue(options);
+    for (;;) {
+        const topLevelAction = await prompts({
+            type: 'select',
+            name: 'value',
+            message: 'Select an option to change, Done to execute, Ctrl+C to cancel',
+            choices: [
+                { title: kleur.green('Done'), description: `${pkg.mode === 'update' ? 'Update' : 'Create'} package`, value: 'done' },
+                ...options.map(mapOption(state))
+            ],
+            initial: 0
+        }, { onCancel });
         if (cancelled) {
             process.exit(-1);
         }
-        const fileName = path.join(dir, '.github/workflows/main.yml');
-        let actionsTemplate = (await fs.readFile(fileName)).toString();
-        actionsTemplate = actionsTemplate.replace('scope: # @echo scope', response.scope ? `scope: '@${response.scope}'` : '');
-        await fs.writeFile(fileName, actionsTemplate);
-        const readmeFileName = path.join(dir, 'README.md');
-        const readme = `# ${response.name}\n${response.description}\n\n## Packages`;
-        await fs.writeFile(readmeFileName, readme);
-    }
-    if (chooseAction.action === 'subpackage') {
-        const response = await prompts([{
-                type: 'text',
-                name: 'name',
-                message: 'package name',
-                initial: basePackageName
-            }, {
-                type: 'text',
-                name: 'version',
-                message: 'version',
-                initial: '1.0.0'
-            }, {
-                type: 'text',
-                name: 'description',
-                message: 'description',
-                initial: ''
-            }, {
-                type: 'text',
-                name: 'license',
-                message: 'license',
-                initial: 'MIT'
-            }, {
+        if (topLevelAction.value === 'done') {
+            break;
+        }
+        let option = options.find(item => item.field === topLevelAction.value);
+        let mutateObject = state;
+        if ('items' in option) {
+            const nextLevelAction = await prompts([{
+                    type: 'select',
+                    name: 'value',
+                    message: option.title,
+                    choices: option.items.map(mapOption(state[option.field]))
+                }], { onCancel });
+            if (cancelled) {
+                process.exit(-1);
+            }
+            if (option.mutateInnerObject) {
+                mutateObject = state[option.field];
+            }
+            option = option.items.find(item => item.field === nextLevelAction.value);
+        }
+        const action = await prompts([{
                 type: 'text',
-                name: 'author',
-                message: 'author',
-                initial: userName() ?? ''
+                name: option.field,
+                message: option.title,
+                initial: state[option.field]
             }], { onCancel });
         if (cancelled) {
             process.exit(-1);
         }
-        const gitInfo = {
-            homepage: '',
-            repository: undefined,
-            bugs: undefined
-        };
-        try {
-            const gitCfg = await gitConfig();
-            if (gitCfg) {
-                const url = gitCfg['remote "origin"'].url;
-                gitInfo.homepage = url.replace('.git', `/blob/main/${basePackageName}/README.md`);
-                gitInfo.repository = {
-                    type: 'git',
-                    url: `git+${url}`
-                };
-                gitInfo.bugs = {
-                    url: url.replace('.git', '/issues')
-                };
-            }
-        }
-        catch (e) {
-            /* ignore */
-        }
-        const pkg = await readPackage(dir);
-        Object.assign(pkg.pkg, response, gitInfo);
-        pkg.readme = `# ${response.name}`;
-        await writePackage(dir, pkg);
-        rootPkg.pkg.workspaces ??= [];
-        rootPkg.pkg.workspaces.push(basePackageName);
-        rootPkg.readme += `\n- [${basePackageName}](./${basePackageName}/README.md)`;
-        await writePackage(path.resolve(dir, '..'), rootPkg);
+        mutateObject[option.field] = action[option.field];
+    }
+    if (cancelled) {
+        process.exit(-1);
     }
+    Object.assign(pkg.pkg, state);
+    pkg.readme ??= `# ${state.name}`;
+    await writePackage(targetDir, pkg);
     function onCancel() {
         cancelled = true;
     }
 }
 execute();
+function mapOption(state) {
+    return (option) => {
+        const fieldValue = state[option.field];
+        return {
+            title: pad16plus(option.title) + kleur.magenta('items' in option ? viewObject(option.items, fieldValue) : fieldValue),
+            value: option.field
+        };
+    };
+}
+function viewObject(items, json) {
+    return items
+        .map(item => kleur.grey(item.title) + ' ' + kleur.white(json[item.field]))
+        .join(', ');
+}
+function getOptionsValue(options) {
+    return options.reduce((accumulator, item) => ({
+        ...accumulator,
+        [item.field]: 'items' in item ? getOptionsValue(item.items) : item.initialValue
+    }), {});
+}
+async function reportVersion() {
+    const createPkgBldPackage = await readPackage(path.resolve(__dirname, '..'));
+    console.log(kleur.grey(pad16plus('create-pkgbld', 0)) + kleur.white('v' + createPkgBldPackage.pkg.version));
+}
+function getTargetDir() {
+    const parsedArgs = minimist(process.argv.slice(2));
+    const targetDir = path.join(process.cwd(), parsedArgs._[0] ?? '.');
+    return targetDir;
+}
+async function getGitOptions(packageName) {
+    const options = [];
+    try {
+        const gitCfg = await gitConfig();
+        if (gitCfg) {
+            const url = gitCfg['remote "origin"'].url;
+            options.push({
+                title: 'Homepage',
+                field: 'homepage',
+                initialValue: url.replace('.git', `/blob/main/${packageName}/README.md`)
+            });
+            options.push({
+                title: 'Repository',
+                field: 'repository',
+                items: [{
+                        title: 'Type',
+                        field: 'type',
+                        initialValue: 'git'
+                    }, {
+                        title: 'Url',
+                        field: 'url',
+                        initialValue: `git+${url}`
+                    }],
+                mutateInnerObject: true
+            });
+            options.push({
+                title: 'Bugs',
+                field: 'bugs',
+                initialValue: url.replace('.git', '/issues')
+            });
+        }
+    }
+    catch (e) {
+        /* ignore */
+    }
+    return options;
+}
+function getBasicOptions(packageName) {
+    return [{
+            title: 'Package Name',
+            field: 'name',
+            initialValue: packageName
+        }, {
+            title: 'Version',
+            field: 'version',
+            initialValue: '0.0.1'
+        }, {
+            title: 'Description',
+            field: 'description',
+            initialValue: ''
+        }, {
+            title: 'License',
+            field: 'license',
+            initialValue: 'MIT'
+        }, {
+            title: 'Author',
+            field: 'author',
+            initialValue: userName() ?? ''
+        }, {
+            title: 'Destination folder',
+            field: 'dest',
+            initialValue: 'dest'
+        }, {
+            title: 'Source folder',
+            field: 'src',
+            initialValue: 'src'
+        }];
+}
+function pad16plus(value, indent = 4, offset = 3) {
+    return value + ''.padEnd(offset - Math.floor((value.length + indent) / 8), '\t');
+}
 async function readPackage(dir) {
     const packageFileName = path.resolve(dir, 'package.json');
     const readmeFileName = path.resolve(dir, 'README.md');
@@ -148,19 +185,23 @@ async function readPackage(dir) {
         const readmeFile = await fs.readFile(readmeFileName);
         return {
             pkg: JSON.parse(pkgFile.toString()),
-            readme: readmeFile.toString()
+            readme: readmeFile.toString(),
+            mode: 'update'
         };
     }
-    catch (e) {
-        console.error(e);
-        process.exit(-1);
-    }
+    catch (e) { /**/ }
+    return {
+        pkg: {},
+        readme: '',
+        mode: 'create'
+    };
 }
 async function writePackage(dir, pkg) {
     const packageFileName = path.resolve(dir, 'package.json');
     const readmeFileName = path.resolve(dir, 'README.md');
     try {
-        await fs.writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2));
+        await fs.mkdir(dir, { recursive: true });
+        await fs.writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2), {});
         await fs.writeFile(readmeFileName, pkg.readme);
     }
     catch (e) {

package/dist/index.mjs

@@ -4,139 +4,176 @@ import fs from 'fs/promises';
 import userName from 'git-user-name';
 import gitConfig from 'parse-git-config';
 import minimist from 'minimist';
-import degit from 'degit';
+import { grey, white, green, magenta } from 'kleur';
 
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 async function execute() {
-    const myPkg = await readPackage(path.resolve(__dirname, '..'));
-    console.log('create-pkgbld ' + myPkg.pkg.version);
-    const parsedArgs = minimist(process.argv.slice(2));
-    const packageName = parsedArgs._[0];
-    const dir = packageName ?? '.';
+    await reportVersion();
+    const targetDir = getTargetDir();
+    console.log(grey(pad16plus('Target Directory', 0)) + white(targetDir));
+    const pkg = await readPackage(targetDir);
+    console.log(grey(pad16plus('Mode', 0)) + white(pkg.mode));
+    const packageName = path.basename(targetDir);
     let cancelled = false;
-    const chooseAction = await prompts({
-        type: 'select',
-        name: 'action',
-        message: 'What do you need to do?',
-        choices: [
-            { title: 'Create Monorepo Root', value: 'root' },
-            { title: 'Create a Subpackage', value: 'subpackage' }
-        ],
-        initial: 1
-    }, { onCancel });
-    if (cancelled) {
-        process.exit(-1);
-    }
-    let rootPkg = {
-        pkg: {},
-        readme: ''
-    };
-    if (chooseAction.action === 'subpackage') {
-        rootPkg = await readPackage(path.resolve(dir, packageName ? '..' : '.'));
-    }
-    const template = chooseAction.action === 'root' ? 'kshutkin/monorepo-root' : 'kshutkin/monorepo-package';
-    const emitter = degit(template, {
-        cache: false,
-        force: true,
-        verbose: true,
-    });
-    emitter.on('info', (info) => {
-        console.log(info.message);
-    });
-    await emitter.clone(dir);
-    const basePackageName = (packageName && path.basename(packageName)) || path.basename(process.cwd());
-    if (chooseAction.action === 'root') {
-        const response = await prompts([{
-                type: 'text',
-                name: 'name',
-                message: 'package name',
-                initial: basePackageName
-            }, {
-                type: 'text',
-                name: 'scope',
-                message: 'scope (without @ or empty)'
-            }, {
-                type: 'text',
-                name: 'description',
-                message: 'description',
-                initial: ''
-            }], { onCancel });
+    const options = getBasicOptions(packageName);
+    options.push(...await getGitOptions(packageName));
+    const state = getOptionsValue(options);
+    for (;;) {
+        const topLevelAction = await prompts({
+            type: 'select',
+            name: 'value',
+            message: 'Select an option to change, Done to execute, Ctrl+C to cancel',
+            choices: [
+                { title: green('Done'), description: `${pkg.mode === 'update' ? 'Update' : 'Create'} package`, value: 'done' },
+                ...options.map(mapOption(state))
+            ],
+            initial: 0
+        }, { onCancel });
         if (cancelled) {
             process.exit(-1);
         }
-        const fileName = path.join(dir, '.github/workflows/main.yml');
-        let actionsTemplate = (await fs.readFile(fileName)).toString();
-        actionsTemplate = actionsTemplate.replace('scope: # @echo scope', response.scope ? `scope: '@${response.scope}'` : '');
-        await fs.writeFile(fileName, actionsTemplate);
-        const readmeFileName = path.join(dir, 'README.md');
-        const readme = `# ${response.name}\n${response.description}\n\n## Packages`;
-        await fs.writeFile(readmeFileName, readme);
-    }
-    if (chooseAction.action === 'subpackage') {
-        const response = await prompts([{
-                type: 'text',
-                name: 'name',
-                message: 'package name',
-                initial: basePackageName
-            }, {
-                type: 'text',
-                name: 'version',
-                message: 'version',
-                initial: '1.0.0'
-            }, {
-                type: 'text',
-                name: 'description',
-                message: 'description',
-                initial: ''
-            }, {
-                type: 'text',
-                name: 'license',
-                message: 'license',
-                initial: 'MIT'
-            }, {
+        if (topLevelAction.value === 'done') {
+            break;
+        }
+        let option = options.find(item => item.field === topLevelAction.value);
+        let mutateObject = state;
+        if ('items' in option) {
+            const nextLevelAction = await prompts([{
+                    type: 'select',
+                    name: 'value',
+                    message: option.title,
+                    choices: option.items.map(mapOption(state[option.field]))
+                }], { onCancel });
+            if (cancelled) {
+                process.exit(-1);
+            }
+            if (option.mutateInnerObject) {
+                mutateObject = state[option.field];
+            }
+            option = option.items.find(item => item.field === nextLevelAction.value);
+        }
+        const action = await prompts([{
                 type: 'text',
-                name: 'author',
-                message: 'author',
-                initial: userName() ?? ''
+                name: option.field,
+                message: option.title,
+                initial: state[option.field]
             }], { onCancel });
         if (cancelled) {
             process.exit(-1);
         }
-        const gitInfo = {
-            homepage: '',
-            repository: undefined,
-            bugs: undefined
-        };
-        try {
-            const gitCfg = await gitConfig();
-            if (gitCfg) {
-                const url = gitCfg['remote "origin"'].url;
-                gitInfo.homepage = url.replace('.git', `/blob/main/${basePackageName}/README.md`);
-                gitInfo.repository = {
-                    type: 'git',
-                    url: `git+${url}`
-                };
-                gitInfo.bugs = {
-                    url: url.replace('.git', '/issues')
-                };
-            }
-        }
-        catch (e) {
-            /* ignore */
-        }
-        const pkg = await readPackage(dir);
-        Object.assign(pkg.pkg, response, gitInfo);
-        pkg.readme = `# ${response.name}`;
-        await writePackage(dir, pkg);
-        rootPkg.pkg.workspaces ??= [];
-        rootPkg.pkg.workspaces.push(basePackageName);
-        rootPkg.readme += `\n- [${basePackageName}](./${basePackageName}/README.md)`;
-        await writePackage(path.resolve(dir, '..'), rootPkg);
+        mutateObject[option.field] = action[option.field];
+    }
+    if (cancelled) {
+        process.exit(-1);
     }
+    Object.assign(pkg.pkg, state);
+    pkg.readme ??= `# ${state.name}`;
+    await writePackage(targetDir, pkg);
     function onCancel() {
         cancelled = true;
     }
 }
 execute();
+function mapOption(state) {
+    return (option) => {
+        const fieldValue = state[option.field];
+        return {
+            title: pad16plus(option.title) + magenta('items' in option ? viewObject(option.items, fieldValue) : fieldValue),
+            value: option.field
+        };
+    };
+}
+function viewObject(items, json) {
+    return items
+        .map(item => grey(item.title) + ' ' + white(json[item.field]))
+        .join(', ');
+}
+function getOptionsValue(options) {
+    return options.reduce((accumulator, item) => ({
+        ...accumulator,
+        [item.field]: 'items' in item ? getOptionsValue(item.items) : item.initialValue
+    }), {});
+}
+async function reportVersion() {
+    const createPkgBldPackage = await readPackage(path.resolve(__dirname, '..'));
+    console.log(grey(pad16plus('create-pkgbld', 0)) + white('v' + createPkgBldPackage.pkg.version));
+}
+function getTargetDir() {
+    const parsedArgs = minimist(process.argv.slice(2));
+    const targetDir = path.join(process.cwd(), parsedArgs._[0] ?? '.');
+    return targetDir;
+}
+async function getGitOptions(packageName) {
+    const options = [];
+    try {
+        const gitCfg = await gitConfig();
+        if (gitCfg) {
+            const url = gitCfg['remote "origin"'].url;
+            options.push({
+                title: 'Homepage',
+                field: 'homepage',
+                initialValue: url.replace('.git', `/blob/main/${packageName}/README.md`)
+            });
+            options.push({
+                title: 'Repository',
+                field: 'repository',
+                items: [{
+                        title: 'Type',
+                        field: 'type',
+                        initialValue: 'git'
+                    }, {
+                        title: 'Url',
+                        field: 'url',
+                        initialValue: `git+${url}`
+                    }],
+                mutateInnerObject: true
+            });
+            options.push({
+                title: 'Bugs',
+                field: 'bugs',
+                initialValue: url.replace('.git', '/issues')
+            });
+        }
+    }
+    catch (e) {
+        /* ignore */
+    }
+    return options;
+}
+function getBasicOptions(packageName) {
+    return [{
+            title: 'Package Name',
+            field: 'name',
+            initialValue: packageName
+        }, {
+            title: 'Version',
+            field: 'version',
+            initialValue: '0.0.1'
+        }, {
+            title: 'Description',
+            field: 'description',
+            initialValue: ''
+        }, {
+            title: 'License',
+            field: 'license',
+            initialValue: 'MIT'
+        }, {
+            title: 'Author',
+            field: 'author',
+            initialValue: userName() ?? ''
+        }, {
+            title: 'Destination folder',
+            field: 'dest',
+            initialValue: 'dest'
+        }, {
+            title: 'Source folder',
+            field: 'src',
+            initialValue: 'src'
+        }];
+}
+function pad16plus(value, indent = 4, offset = 3) {
+    return value + ''.padEnd(offset - Math.floor((value.length + indent) / 8), '\t');
+}
 async function readPackage(dir) {
     const packageFileName = path.resolve(dir, 'package.json');
     const readmeFileName = path.resolve(dir, 'README.md');
@@ -145,19 +182,23 @@ async function readPackage(dir) {
         const readmeFile = await fs.readFile(readmeFileName);
         return {
             pkg: JSON.parse(pkgFile.toString()),
-            readme: readmeFile.toString()
+            readme: readmeFile.toString(),
+            mode: 'update'
         };
     }
-    catch (e) {
-        console.error(e);
-        process.exit(-1);
-    }
+    catch (e) { /**/ }
+    return {
+        pkg: {},
+        readme: '',
+        mode: 'create'
+    };
 }
 async function writePackage(dir, pkg) {
     const packageFileName = path.resolve(dir, 'package.json');
     const readmeFileName = path.resolve(dir, 'README.md');
     try {
-        await fs.writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2));
+        await fs.mkdir(dir, { recursive: true });
+        await fs.writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2), {});
         await fs.writeFile(readmeFileName, pkg.readme);
     }
     catch (e) {

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+export type Option = {
+    title: string;
+    field: string;
+} & ({
+    initialValue: string;
+} | {
+    items: Option[];
+    mutateInnerObject: boolean;
+});
+export type PkgInfo = {
+    readme: string;
+    pkg: object;
+};

package/package.json

@@ -1,11 +1,8 @@
 {
-  "version": "1.1.10",
+  "version": "1.3.0",
   "license": "MIT",
   "name": "create-pkgbld",
-  "author": {
-    "name": "Konstantin Shutkin"
-  },
-  "funding": "https://www.donationalerts.com/r/excitingcode",
+  "author": "Konstantin Shutkin",
   "bin": "./dist/index.cjs",
   "exports": {
     ".": {
@@ -37,19 +34,18 @@
     "init"
   ],
   "devDependencies": {
-    "@types/degit": "2.8.3",
     "@types/git-user-name": "2.0.1",
     "@types/parse-git-config": "3.0.1",
     "@types/prompts": "2.4.4",
     "@types/minimist": "1.2.2",
-    "pkgbld": "1.16.3"
+    "pkgbld": "1.16.7"
   },
   "dependencies": {
-    "degit": "2.8.4",
     "git-user-name": "2.0.0",
     "minimist": "1.2.8",
     "parse-git-config": "3.0.0",
-    "prompts": "2.4.2"
+    "prompts": "2.4.2",
+    "kleur": "4.1.5"
   },
   "scripts": {
     "build": "node ../pkgbld/dist/index.js --formats=cjs,es",