create-pkgbld 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Konstantin Shutkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# create-pkgbld
+
+Minimalistic scaffolding utility to create monorepo packages.
+
+*Disclaimer:* despite version 1.0.0+ it is still very raw, use only if it fits your needs.
+
+## Usage
+
+```
+npm init pkgbld
+```
+
+or
+
+```
+npm init pkgbld <folder name>
+```

package/dist/index.cjs

@@ -0,0 +1,179 @@
+'use strict';
+
+var prompts = require('prompts');
+var path = require('path');
+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');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var prompts__default = /*#__PURE__*/_interopDefaultLegacy(prompts);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var userName__default = /*#__PURE__*/_interopDefaultLegacy(userName);
+var gitConfig__default = /*#__PURE__*/_interopDefaultLegacy(gitConfig);
+var minimist__default = /*#__PURE__*/_interopDefaultLegacy(minimist);
+var degit__default = /*#__PURE__*/_interopDefaultLegacy(degit);
+
+async function execute() {
+    var _a, _b;
+    var _c;
+    const parsedArgs = minimist__default["default"](process.argv.slice(2));
+    const packageName = parsedArgs._[0];
+    const dir = packageName !== null && packageName !== void 0 ? packageName : '.';
+    let cancelled = false;
+    const chooseAction = await prompts__default["default"]({
+        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__default["default"].resolve(dir, '..'));
+    }
+    const template = chooseAction.action === 'root' ? 'kshutkin/monorepo-root' : 'kshutkin/monorepo-package';
+    const emitter = degit__default["default"](template, {
+        cache: true,
+        force: true,
+        verbose: true,
+    });
+    emitter.on('info', (info) => {
+        console.log(info.message);
+    });
+    await emitter.clone(dir);
+    const basePackageName = path__default["default"].basename(packageName) || path__default["default"].basename(process.cwd());
+    if (chooseAction.action === 'root') {
+        const response = await prompts__default["default"]([{
+                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 });
+        if (cancelled) {
+            process.exit(-1);
+        }
+        const fileName = path__default["default"].join(dir, '.github/workflows/main.yml');
+        let actionsTemplate = (await fs__default["default"].readFile(fileName)).toString();
+        actionsTemplate = actionsTemplate.replace('scope: # @echo scope', response.scope ? `scope: '@${response.scope}'` : '');
+        await fs__default["default"].writeFile(fileName, actionsTemplate);
+        const readmeFileName = path__default["default"].join(dir, 'README.md');
+        const readme = `# ${response.name}\n${response.description}\n\n## Packages`;
+        await fs__default["default"].writeFile(readmeFileName, readme);
+    }
+    if (chooseAction.action === 'subpackage') {
+        const response = await prompts__default["default"]([{
+                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'
+            }, {
+                type: 'text',
+                name: 'author',
+                message: 'author',
+                initial: (_a = userName__default["default"]()) !== null && _a !== void 0 ? _a : ''
+            }], { onCancel });
+        if (cancelled) {
+            process.exit(-1);
+        }
+        const gitInfo = {
+            homepage: '',
+            repository: undefined,
+            bugs: undefined
+        };
+        try {
+            const gitCfg = await gitConfig__default["default"]();
+            if (gitCfg) {
+                const url = gitCfg['remote "origin"'].url;
+                gitInfo.homepage = url.replace('.git', `/${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);
+        (_b = (_c = rootPkg.pkg).workspaces) !== null && _b !== void 0 ? _b : (_c.workspaces = []);
+        rootPkg.pkg.workspaces.push(basePackageName);
+        rootPkg.readme += `\n- [${basePackageName}](./${basePackageName}/README.md)`;
+        await writePackage(path__default["default"].resolve(dir, '..'), rootPkg);
+    }
+    function onCancel() {
+        cancelled = true;
+    }
+}
+execute();
+async function readPackage(dir) {
+    const packageFileName = path__default["default"].resolve(dir, 'package.json');
+    const readmeFileName = path__default["default"].resolve(dir, 'README.md');
+    try {
+        const pkgFile = await fs__default["default"].readFile(packageFileName);
+        const readmeFile = await fs__default["default"].readFile(readmeFileName);
+        return {
+            pkg: JSON.parse(pkgFile.toString()),
+            readme: readmeFile.toString()
+        };
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}
+async function writePackage(dir, pkg) {
+    const packageFileName = path__default["default"].resolve(dir, 'package.json');
+    const readmeFileName = path__default["default"].resolve(dir, 'README.md');
+    try {
+        await fs__default["default"].writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2));
+        await fs__default["default"].writeFile(readmeFileName, pkg.readme);
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,180 @@
+#!/usr/bin/env node
+'use strict';
+
+var prompts = require('prompts');
+var path = require('path');
+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');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var prompts__default = /*#__PURE__*/_interopDefaultLegacy(prompts);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var userName__default = /*#__PURE__*/_interopDefaultLegacy(userName);
+var gitConfig__default = /*#__PURE__*/_interopDefaultLegacy(gitConfig);
+var minimist__default = /*#__PURE__*/_interopDefaultLegacy(minimist);
+var degit__default = /*#__PURE__*/_interopDefaultLegacy(degit);
+
+async function execute() {
+    var _a, _b;
+    var _c;
+    const parsedArgs = minimist__default["default"](process.argv.slice(2));
+    const packageName = parsedArgs._[0];
+    const dir = packageName !== null && packageName !== void 0 ? packageName : '.';
+    let cancelled = false;
+    const chooseAction = await prompts__default["default"]({
+        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__default["default"].resolve(dir, '..'));
+    }
+    const template = chooseAction.action === 'root' ? 'kshutkin/monorepo-root' : 'kshutkin/monorepo-package';
+    const emitter = degit__default["default"](template, {
+        cache: true,
+        force: true,
+        verbose: true,
+    });
+    emitter.on('info', (info) => {
+        console.log(info.message);
+    });
+    await emitter.clone(dir);
+    const basePackageName = path__default["default"].basename(packageName) || path__default["default"].basename(process.cwd());
+    if (chooseAction.action === 'root') {
+        const response = await prompts__default["default"]([{
+                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 });
+        if (cancelled) {
+            process.exit(-1);
+        }
+        const fileName = path__default["default"].join(dir, '.github/workflows/main.yml');
+        let actionsTemplate = (await fs__default["default"].readFile(fileName)).toString();
+        actionsTemplate = actionsTemplate.replace('scope: # @echo scope', response.scope ? `scope: '@${response.scope}'` : '');
+        await fs__default["default"].writeFile(fileName, actionsTemplate);
+        const readmeFileName = path__default["default"].join(dir, 'README.md');
+        const readme = `# ${response.name}\n${response.description}\n\n## Packages`;
+        await fs__default["default"].writeFile(readmeFileName, readme);
+    }
+    if (chooseAction.action === 'subpackage') {
+        const response = await prompts__default["default"]([{
+                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'
+            }, {
+                type: 'text',
+                name: 'author',
+                message: 'author',
+                initial: (_a = userName__default["default"]()) !== null && _a !== void 0 ? _a : ''
+            }], { onCancel });
+        if (cancelled) {
+            process.exit(-1);
+        }
+        const gitInfo = {
+            homepage: '',
+            repository: undefined,
+            bugs: undefined
+        };
+        try {
+            const gitCfg = await gitConfig__default["default"]();
+            if (gitCfg) {
+                const url = gitCfg['remote "origin"'].url;
+                gitInfo.homepage = url.replace('.git', `/${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);
+        (_b = (_c = rootPkg.pkg).workspaces) !== null && _b !== void 0 ? _b : (_c.workspaces = []);
+        rootPkg.pkg.workspaces.push(basePackageName);
+        rootPkg.readme += `\n- [${basePackageName}](./${basePackageName}/README.md)`;
+        await writePackage(path__default["default"].resolve(dir, '..'), rootPkg);
+    }
+    function onCancel() {
+        cancelled = true;
+    }
+}
+execute();
+async function readPackage(dir) {
+    const packageFileName = path__default["default"].resolve(dir, 'package.json');
+    const readmeFileName = path__default["default"].resolve(dir, 'README.md');
+    try {
+        const pkgFile = await fs__default["default"].readFile(packageFileName);
+        const readmeFile = await fs__default["default"].readFile(readmeFileName);
+        return {
+            pkg: JSON.parse(pkgFile.toString()),
+            readme: readmeFile.toString()
+        };
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}
+async function writePackage(dir, pkg) {
+    const packageFileName = path__default["default"].resolve(dir, 'package.json');
+    const readmeFileName = path__default["default"].resolve(dir, 'README.md');
+    try {
+        await fs__default["default"].writeFile(packageFileName, JSON.stringify(pkg.pkg, null, 2));
+        await fs__default["default"].writeFile(readmeFileName, pkg.readme);
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}

package/dist/index.mjs

@@ -0,0 +1,167 @@
+import prompts from 'prompts';
+import path from 'path';
+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';
+
+async function execute() {
+    var _a, _b;
+    var _c;
+    const parsedArgs = minimist(process.argv.slice(2));
+    const packageName = parsedArgs._[0];
+    const dir = packageName !== null && packageName !== void 0 ? packageName : '.';
+    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, '..'));
+    }
+    const template = chooseAction.action === 'root' ? 'kshutkin/monorepo-root' : 'kshutkin/monorepo-package';
+    const emitter = degit(template, {
+        cache: true,
+        force: true,
+        verbose: true,
+    });
+    emitter.on('info', (info) => {
+        console.log(info.message);
+    });
+    await emitter.clone(dir);
+    const basePackageName = 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 });
+        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'
+            }, {
+                type: 'text',
+                name: 'author',
+                message: 'author',
+                initial: (_a = userName()) !== null && _a !== void 0 ? _a : ''
+            }], { 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', `/${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);
+        (_b = (_c = rootPkg.pkg).workspaces) !== null && _b !== void 0 ? _b : (_c.workspaces = []);
+        rootPkg.pkg.workspaces.push(basePackageName);
+        rootPkg.readme += `\n- [${basePackageName}](./${basePackageName}/README.md)`;
+        await writePackage(path.resolve(dir, '..'), rootPkg);
+    }
+    function onCancel() {
+        cancelled = true;
+    }
+}
+execute();
+async function readPackage(dir) {
+    const packageFileName = path.resolve(dir, 'package.json');
+    const readmeFileName = path.resolve(dir, 'README.md');
+    try {
+        const pkgFile = await fs.readFile(packageFileName);
+        const readmeFile = await fs.readFile(readmeFileName);
+        return {
+            pkg: JSON.parse(pkgFile.toString()),
+            readme: readmeFile.toString()
+        };
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}
+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.writeFile(readmeFileName, pkg.readme);
+    }
+    catch (e) {
+        console.error(e);
+        process.exit(-1);
+    }
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "version": "1.0.0",
+  "license": "MIT",
+  "name": "create-pkgbld",
+  "author": {
+    "name": "Konstantin Shutkin"
+  },
+  "funding": "https://www.donationalerts.com/r/excitingcode",
+  "bin": "./dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kshutkin/create-pkgbld.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kshutkin/create-pkgbld/issues"
+  },
+  "homepage": "https://github.com/kshutkin/create-pkgbld/README.md",
+  "keywords": [
+    "pkgbld"
+  ],
+  "scripts": {
+    "build": "pkgbld --formats=cjs,es && node binify.js",
+    "lint": "eslint ./src",
+    "semantic-release": "npx semantic-release"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/commit-analyzer": "9.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/npm": "8.0.2",
+    "@semantic-release/release-notes-generator": "10.0.2",
+    "@types/degit": "2.8.3",
+    "@types/git-user-name": "2.0.1",
+    "@types/lodash": "4.14.178",
+    "@types/parse-git-config": "3.0.1",
+    "@types/prompts": "2.0.14",
+    "@typescript-eslint/eslint-plugin": "5.8.0",
+    "@typescript-eslint/parser": "5.8.0",
+    "conventional-changelog-angular": "5.0.13",
+    "eslint": "8.5.0",
+    "pkgbld": "1.1.0",
+    "semantic-release": "18.0.0"
+  },
+  "dependencies": {
+    "degit": "2.8.4",
+    "git-user-name": "2.0.0",
+    "minimist": "1.2.5",
+    "parse-git-config": "3.0.0",
+    "prompts": "2.4.2"
+  }
+}