complete-cli 1.0.2 → 1.0.3

package/dist/main.js.LICENSE.txt

@@ -0,0 +1,78 @@
+/*!
+ * fill-range <https://github.com/jonschlinkert/fill-range>
+ *
+ * Copyright (c) 2014-present, Jon Schlinkert.
+ * Licensed under the MIT License.
+ */
+
+/*!
+ * is-extglob <https://github.com/jonschlinkert/is-extglob>
+ *
+ * Copyright (c) 2014-2016, Jon Schlinkert.
+ * Licensed under the MIT License.
+ */
+
+/*!
+ * is-number <https://github.com/jonschlinkert/is-number>
+ *
+ * Copyright (c) 2014-present, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * negotiator
+ * Copyright(c) 2012 Federico Romero
+ * Copyright(c) 2012-2014 Isaac Z. Schlueter
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * node-progress
+ * Copyright(c) 2011 TJ Holowaychuk <tj@vision-media.ca>
+ * MIT Licensed
+ */
+
+/*!
+ * parse-github-url <https://github.com/jonschlinkert/parse-github-url>
+ *
+ * Copyright (c) 2015-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*!
+ * to-regex-range <https://github.com/micromatch/to-regex-range>
+ *
+ * Copyright (c) 2015-present, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+/*! queue-microtask. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/*! run-parallel. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/**
+ * @license
+ * Copyright (c) 2010-2012 Mikeal Rogers
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an "AS
+ * IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/**
+ * @preserve
+ * JS Implementation of incremental MurmurHash3 (r150) (as of May 10, 2013)
+ *
+ * @author <a href="mailto:jensyt@gmail.com">Jens Taylor</a>
+ * @see http://github.com/homebrewing/brauhaus-diff
+ * @author <a href="mailto:gary.court@gmail.com">Gary Court</a>
+ * @see http://github.com/garycourt/murmurhash-js
+ * @author <a href="mailto:aappleby@gmail.com">Austin Appleby</a>
+ * @see http://sites.google.com/site/murmurhash/
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-cli",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A command line tool for bootstrapping TypeScript projects.",
   "keywords": [
     "typescript"
@@ -43,10 +43,13 @@
     "complete-node": "^3.0.1",
     "glob": "11.0.1",
     "klaw-sync": "6.0.0",
+    "ts-loader": "9.5.2",
+    "tsconfig-paths-webpack-plugin": "^4.2.0",
     "typescript": "5.7.3",
     "typescript-eslint": "8.24.1",
     "webpack": "5.98.0",
     "webpack-cli": "6.0.1",
+    "webpack-shebang-plugin": "^1.1.8",
     "yaml": "2.7.0"
   },
   "engines": {

package/dist/commands/CheckCommand.js

@@ -1,141 +0,0 @@
-import chalk from "chalk";
-import { Command, Option } from "clipanion";
-import { ReadonlySet } from "complete-common";
-import { $, deleteFileOrDirectory, fatalError, isDirectory, isFile, readFile, writeFile, } from "complete-node";
-import klawSync from "klaw-sync";
-import path from "node:path";
-import { ACTION_YML, ACTION_YML_TEMPLATE_PATH, CWD, TEMPLATES_DYNAMIC_DIR, TEMPLATES_STATIC_DIR, } from "../constants.js";
-import { getTruncatedText } from "./check/getTruncatedText.js";
-const URL_PREFIX = "https://raw.githubusercontent.com/complete-ts/complete/main/packages/complete-cli/file-templates";
-export class CheckCommand extends Command {
-    static paths = [["check"], ["c"]];
-    ignore = Option.String("-i,--ignore", {
-        description: "Comma separated list of file names to ignore.",
-    });
-    verbose = Option.Boolean("-v,--verbose", false, {
-        description: "Enable verbose output.",
-    });
-    static usage = Command.Usage({
-        description: "Check the template files of the current TypeScript project to see if they are up to date.",
-    });
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async execute() {
-        let oneOrMoreErrors = false;
-        const ignore = this.ignore ?? "";
-        const ignoreFileNames = ignore.split(",");
-        const ignoreFileNamesSet = new ReadonlySet(ignoreFileNames);
-        // First, check the static files.
-        if (checkTemplateDirectory(TEMPLATES_STATIC_DIR, ignoreFileNamesSet, this.verbose)) {
-            oneOrMoreErrors = true;
-        }
-        // Second, check dynamic files that require specific logic.
-        if (checkIndividualFiles(ignoreFileNamesSet, this.verbose)) {
-            oneOrMoreErrors = true;
-        }
-        if (oneOrMoreErrors) {
-            fatalError("The check command failed.");
-        }
-    }
-}
-function checkTemplateDirectory(templateDirectory, ignoreFileNamesSet, verbose) {
-    let oneOrMoreErrors = false;
-    for (const klawItem of klawSync(templateDirectory)) {
-        const templateFilePath = klawItem.path;
-        if (isDirectory(templateFilePath)) {
-            continue;
-        }
-        const originalFileName = path.basename(templateFilePath);
-        if (originalFileName === "main.ts") {
-            continue;
-        }
-        const relativeTemplateFilePath = path.relative(templateDirectory, templateFilePath);
-        const templateFileName = path.basename(relativeTemplateFilePath);
-        let projectFilePath = path.join(CWD, relativeTemplateFilePath);
-        switch (templateFileName) {
-            case "_cspell.config.jsonc": {
-                projectFilePath = path.join(projectFilePath, "..", "cspell.config.jsonc");
-                break;
-            }
-            case "_gitattributes": {
-                projectFilePath = path.join(projectFilePath, "..", ".gitattributes");
-                break;
-            }
-            default: {
-                break;
-            }
-        }
-        const projectFileName = path.basename(projectFilePath);
-        if (ignoreFileNamesSet.has(projectFileName)) {
-            continue;
-        }
-        if (!compareTextFiles(projectFilePath, templateFilePath, verbose)) {
-            oneOrMoreErrors = true;
-        }
-    }
-    return oneOrMoreErrors;
-}
-function checkIndividualFiles(ignoreFileNamesSet, verbose) {
-    let oneOrMoreErrors = false;
-    if (!ignoreFileNamesSet.has(ACTION_YML)) {
-        const templateFilePath = ACTION_YML_TEMPLATE_PATH;
-        const relativeTemplateFilePath = path.relative(TEMPLATES_DYNAMIC_DIR, templateFilePath);
-        const projectFilePath = path.join(CWD, relativeTemplateFilePath);
-        if (!compareTextFiles(projectFilePath, templateFilePath, verbose)) {
-            oneOrMoreErrors = true;
-        }
-    }
-    return oneOrMoreErrors;
-}
-/** @returns Whether the project file is valid in reference to the template file. */
-function compareTextFiles(projectFilePath, templateFilePath, verbose) {
-    if (!isFile(projectFilePath)) {
-        console.log(`Failed to find the following file: ${projectFilePath}`);
-        printTemplateLocation(templateFilePath);
-        return false;
-    }
-    const projectFileObject = getTruncatedFileText(projectFilePath, new Set(), new Set());
-    const templateFileObject = getTruncatedFileText(templateFilePath, projectFileObject.ignoreLines, projectFileObject.linesBeforeIgnore);
-    if (projectFileObject.text === templateFileObject.text) {
-        return true;
-    }
-    console.log(`The contents of the following file do not match: ${chalk.red(projectFilePath)}`);
-    printTemplateLocation(templateFilePath);
-    if (verbose) {
-        const originalTemplateFile = readFile(templateFilePath);
-        const originalProjectFile = readFile(projectFilePath);
-        console.log("--- Original template file: ---\n");
-        console.log(originalTemplateFile);
-        console.log();
-        console.log("--- Original project file: ---\n");
-        console.log(originalProjectFile);
-        console.log();
-        console.log("--- Parsed template file: ---\n");
-        console.log(templateFileObject.text);
-        console.log();
-        console.log("--- Parsed project file: ---\n");
-        console.log(projectFileObject.text);
-        console.log();
-    }
-    const tempProjectFilePath = path.join(CWD, "tempProjectFile.txt");
-    const tempTemplateFilePath = path.join(CWD, "tempTemplateFile.txt");
-    writeFile(tempProjectFilePath, projectFileObject.text);
-    writeFile(tempTemplateFilePath, templateFileObject.text);
-    $.sync `diff ${tempProjectFilePath} ${tempTemplateFilePath} --ignore-blank-lines`;
-    deleteFileOrDirectory(tempProjectFilePath);
-    deleteFileOrDirectory(tempTemplateFilePath);
-    return false;
-}
-function getTruncatedFileText(filePath, ignoreLines, linesBeforeIgnore) {
-    const fileName = path.basename(filePath);
-    const fileContents = readFile(filePath);
-    return getTruncatedText(fileName, fileContents, ignoreLines, linesBeforeIgnore);
-}
-function printTemplateLocation(templateFilePath) {
-    const unixPath = templateFilePath.split(path.sep).join(path.posix.sep);
-    const match = unixPath.match(/.+\/file-templates\/(?<urlSuffix>.+)/);
-    if (match === null || match.groups === undefined) {
-        fatalError(`Failed to parse the template file path: ${templateFilePath}`);
-    }
-    const { urlSuffix } = match.groups;
-    console.log(`You can find the template at: ${chalk.green(`${URL_PREFIX}/${urlSuffix}`)}\n`);
-}

package/dist/commands/InitCommand.js

@@ -1,64 +0,0 @@
-import { Command, Option } from "clipanion";
-import path from "node:path";
-import { promptGitHubRepoOrGitRemoteURL } from "../git.js";
-import { promptEnd, promptStart } from "../prompt.js";
-import { checkIfProjectPathExists } from "./init/checkIfProjectPathExists.js";
-import { createProject } from "./init/createProject.js";
-import { getAuthorName } from "./init/getAuthorName.js";
-import { getProjectPath } from "./init/getProjectPath.js";
-import { getPackageManagerUsedForNewProject } from "./init/packageManager.js";
-import { vsCodeInit } from "./init/vsCodeInit.js";
-export class InitCommand extends Command {
-    static paths = [["init"], ["i"]];
-    // The first positional argument.
-    name = Option.String({
-        required: false,
-    });
-    yes = Option.Boolean("-y,--yes", false, {
-        description: 'Answer yes to every dialog option, similar to how "npm init --yes" works.',
-    });
-    useCurrentDirectory = Option.Boolean("--use-current-directory", false, {
-        description: "Use the current directory as the root for the project.",
-    });
-    customDirectory = Option.String("--custom-directory", {
-        description: "Initialize the project into the specified directory (instead of creating a new one based on the name or using the current working directory).",
-    });
-    vsCode = Option.Boolean("--vscode", false, {
-        description: "Open the project in VSCode after initialization.",
-    });
-    npm = Option.Boolean("--npm", false, {
-        description: "Use npm as the package manager.",
-    });
-    yarn = Option.Boolean("--yarn", false, {
-        description: "Use yarn as the package manager.",
-    });
-    pnpm = Option.Boolean("--pnpm", false, {
-        description: "Use pnpm as the package manager.",
-    });
-    skipGit = Option.Boolean("--skip-git", false, {
-        description: "Do not initialize Git.",
-    });
-    skipInstall = Option.Boolean("--skip-install", false, {
-        description: "Do not automatically install the dependencies after initializing the project.",
-    });
-    forceName = Option.Boolean("-f,--force-name", false, {
-        description: "Allow project names that are normally illegal.",
-    });
-    static usage = Command.Usage({
-        description: "Initialize a new TypeScript project.",
-    });
-    async execute() {
-        promptStart();
-        const packageManager = await getPackageManagerUsedForNewProject(this);
-        // Prompt the end-user for some information (and validate it as we go).
-        const { projectPath, createNewDir } = await getProjectPath(this.name, this.useCurrentDirectory, this.customDirectory, this.yes, this.forceName);
-        await checkIfProjectPathExists(projectPath, this.yes);
-        const projectName = path.basename(projectPath);
-        const authorName = await getAuthorName();
-        const gitRemoteURL = await promptGitHubRepoOrGitRemoteURL(projectName, this.yes, this.skipGit);
-        // Now that we have asked the user all of the questions we need, we can create the project.
-        await createProject(projectName, authorName, projectPath, createNewDir, gitRemoteURL, this.skipInstall, packageManager);
-        await vsCodeInit(projectPath, this.vsCode, this.yes);
-        promptEnd("Initialization completed.");
-    }
-}

package/dist/commands/NukeCommand.js

@@ -1,12 +0,0 @@
-import { Command } from "clipanion";
-import { nukeDependencies } from "complete-node";
-export class NukeCommand extends Command {
-    static paths = [["nuke"], ["n"]];
-    static usage = Command.Usage({
-        description: 'Delete the "node_modules" directory and the package lock file, then reinstall the dependencies for the project.',
-    });
-    async execute() {
-        await nukeDependencies();
-        console.log("Successfully reinstalled dependencies from npm.");
-    }
-}

package/dist/commands/PublishCommand.js

@@ -1,162 +0,0 @@
-import { Command, Option } from "clipanion";
-import { isSemanticVersion } from "complete-common";
-import { $, fatalError, getPackageJSONField, getPackageJSONVersion, getPackageManagerInstallCommand, getPackageManagerLockFileName, getPackageManagersForProject, isFileAsync, isGitRepository, isGitRepositoryClean, isLoggedInToNPM, readFile, updatePackageJSONDependencies, writeFileAsync, } from "complete-node";
-import path from "node:path";
-import { CWD, DEFAULT_PACKAGE_MANAGER } from "../constants.js";
-export class PublishCommand extends Command {
-    static paths = [["publish"], ["p"]];
-    // The first positional argument.
-    versionBumpType = Option.String({
-        required: true,
-    });
-    dryRun = Option.Boolean("--dry-run", false, {
-        description: "Skip committing/uploading & perform a Git reset afterward.",
-    });
-    skipLint = Option.Boolean("--skip-lint", false, {
-        description: "Skip linting before publishing.",
-    });
-    skipUpdate = Option.Boolean("--skip-update", false, {
-        description: "Skip updating the npm dependencies.",
-    });
-    static usage = Command.Usage({
-        description: "Bump the version & publish a new release.",
-    });
-    async execute() {
-        await validate();
-        await prePublish(this.versionBumpType, this.dryRun, this.skipLint, this.skipUpdate);
-        await publish(this.dryRun);
-    }
-}
-async function validate() {
-    const isRepository = await isGitRepository(CWD);
-    if (!isRepository) {
-        fatalError("Failed to publish since the current working directory is not inside of a git repository.");
-    }
-    const isRepositoryClean = await isGitRepositoryClean(CWD);
-    if (!isRepositoryClean) {
-        fatalError("Failed to publish since the Git repository was dirty. Before publishing, you must push any current changes to git. (Version commits should not contain any code changes.)");
-    }
-    const packageJSONExists = await isFileAsync("package.json");
-    if (!packageJSONExists) {
-        fatalError('Failed to find the "package.json" file in the current working directory.');
-    }
-    const isLoggedIn = await isLoggedInToNPM();
-    if (!isLoggedIn) {
-        fatalError('Failed to publish since you are not logged in to npm. Try doing "npm login".');
-    }
-}
-/**
- * Before uploading the project, we want to update dependencies, increment the version, and perform
- * some other steps.
- */
-async function prePublish(versionBumpType, dryRun, skipLint, skipUpdate) {
-    const packageManager = await getPackageManagerUsedForExistingProject();
-    await $ `git pull --rebase`;
-    await $ `git push`;
-    await updateDependencies(skipUpdate, dryRun, packageManager);
-    await incrementVersion(versionBumpType);
-    await unsetDevelopmentConstants();
-    await tryRunNPMScript("build");
-    if (!skipLint) {
-        await tryRunNPMScript("lint");
-    }
-}
-async function getPackageManagerUsedForExistingProject() {
-    const packageManagers = await getPackageManagersForProject(CWD);
-    if (packageManagers.length > 1) {
-        const packageManagerLockFileNames = packageManagers
-            .map((packageManager) => getPackageManagerLockFileName(packageManager))
-            .map((packageManagerLockFileName) => `"${packageManagerLockFileName}"`)
-            .join(" & ");
-        fatalError(`Multiple different kinds of package manager lock files were found (${packageManagerLockFileNames}). You should delete the ones that you are not using so that this program can correctly detect your package manager.`);
-    }
-    const packageManager = packageManagers[0];
-    if (packageManager !== undefined) {
-        return packageManager;
-    }
-    return DEFAULT_PACKAGE_MANAGER;
-}
-async function updateDependencies(skipUpdate, dryRun, packageManager) {
-    if (skipUpdate) {
-        return;
-    }
-    console.log('Updating dependencies in the "package.json" file...');
-    const hasNewDependencies = await updatePackageJSONDependencies(undefined);
-    if (hasNewDependencies) {
-        const command = getPackageManagerInstallCommand(packageManager);
-        const commandParts = command.split(" ");
-        await $ `${commandParts}`;
-        if (!dryRun) {
-            await gitCommitAllAndPush("chore: update dependencies");
-        }
-    }
-}
-async function gitCommitAllAndPush(message) {
-    await $ `git add --all`;
-    await $ `git commit --message ${message}`;
-    await $ `git push`;
-    console.log(`Committed and pushed to the git repository with a message of: ${message}`);
-}
-async function incrementVersion(versionBumpType) {
-    if (versionBumpType === "none") {
-        return;
-    }
-    if (versionBumpType === "dev") {
-        throw new Error('The version bump type of "dev" is not currently supported.');
-    }
-    if (versionBumpType !== "major" &&
-        versionBumpType !== "minor" &&
-        versionBumpType !== "patch" &&
-        versionBumpType !== "dev" &&
-        !isSemanticVersion(versionBumpType)) {
-        fatalError('The version must be one of "major", "minor", "patch", "dev", "none", or a specific semantic version like "1.2.3".');
-    }
-    // We always use `npm` here to avoid differences with the version command between package
-    // managers. The "--no-git-tag-version" flag will prevent npm from both making a commit and adding
-    // a tag.
-    await $ `npm version ${versionBumpType} --no-git-tag-version`;
-}
-async function unsetDevelopmentConstants() {
-    const constantsTSPath = path.join(CWD, "src", "constants.ts");
-    const constantsTSExists = await isFileAsync(constantsTSPath);
-    if (!constantsTSExists) {
-        return;
-    }
-    const constantsTS = readFile(constantsTSPath);
-    const newConstantsTS = constantsTS
-        .replace("const IS_DEV = true", "const IS_DEV = false")
-        .replace("const DEBUG = true", "const DEBUG = false");
-    await writeFileAsync(constantsTSPath, newConstantsTS);
-}
-async function tryRunNPMScript(scriptName) {
-    console.log(`Running: ${scriptName}`);
-    const $$ = $({
-        reject: false,
-    });
-    const { exitCode } = await $$ `npm run ${scriptName}`;
-    if (exitCode !== 0) {
-        await $ `git reset --hard`; // Revert the version changes.
-        fatalError(`Failed to run "${scriptName}".`);
-    }
-}
-async function publish(dryRun) {
-    const projectName = getPackageJSONField(undefined, "name");
-    const version = getPackageJSONVersion(undefined);
-    if (dryRun) {
-        await $ `git reset --hard`; // Revert the version changes.
-    }
-    else {
-        const releaseGitCommitMessage = getReleaseGitCommitMessage(version);
-        await gitCommitAllAndPush(releaseGitCommitMessage);
-        // - The "--access=public" flag is only technically needed for the first publish (unless the
-        //   package is a scoped package), but it is saved here for posterity.
-        // - The "--ignore-scripts" flag is needed since the "npm publish" command will run the
-        //   "publish" script in the "package.json" file, causing an infinite loop.
-        await $ `npm publish --access=public --ignore-scripts`;
-    }
-    const dryRunSuffix = dryRun ? " (dry-run)" : "";
-    console.log(`Published ${projectName} version ${version} successfully${dryRunSuffix}.`);
-}
-function getReleaseGitCommitMessage(version) {
-    return `chore: release ${version}`;
-}

package/dist/commands/UpdateCommand.js

@@ -1,15 +0,0 @@
-import { Command } from "clipanion";
-import { updatePackageJSONDependencies } from "complete-node";
-export class UpdateCommand extends Command {
-    static paths = [["update"], ["u"]];
-    static usage = Command.Usage({
-        description: 'Invoke "npm-check-updates" to update the dependencies inside of the "package.json" file and then install them.',
-    });
-    async execute() {
-        const hasNewDependencies = await updatePackageJSONDependencies();
-        const msg = hasNewDependencies
-            ? "Successfully installed new Node.js dependencies."
-            : "There were no new dependency updates from npm.";
-        console.log(msg);
-    }
-}

package/dist/commands/check/check.test.js

@@ -1,86 +0,0 @@
-import { strictEqual } from "node:assert";
-import test from "node:test";
-import { getTruncatedText } from "./getTruncatedText.js";
-test("no markers", () => {
-    const templateText = `
-line 1
-line 2
-line 3
-`.trim();
-    const { text } = getTruncatedText("test", templateText, new Set(), new Set());
-    strictEqual(text, templateText);
-});
-test("customization marker", () => {
-    const templateText = `
-line 1
-@template-customization-start
-line 2
-@template-customization-end
-line 3
-  `.trim();
-    const expectedTemplateText = `
-line 1
-line 3
-  `.trim();
-    const { text } = getTruncatedText("test", templateText, new Set(), new Set());
-    strictEqual(text, expectedTemplateText);
-});
-test("ignore block marker part 1", () => {
-    const templateText = `
-line 1
-@template-ignore-block-start
-// line 2
-@template-ignore-block-end
-line 3
-  `.trim();
-    const parsedTemplateText = `
-line 1
-line 3
-  `.trim();
-    const { text, ignoreLines } = getTruncatedText("test", templateText, new Set(), new Set());
-    strictEqual(text, parsedTemplateText);
-    strictEqual(ignoreLines.size, 1);
-    strictEqual([...ignoreLines][0], "line 2");
-});
-test("ignore block marker part 2", () => {
-    const templateText = `
-line 1
-line 2
-line 3
-  `.trim();
-    const expectedTemplateText = `
-line 1
-line 3
-  `.trim();
-    const { text } = getTruncatedText("test", templateText, new Set(["line 2"]), new Set());
-    strictEqual(text, expectedTemplateText);
-});
-test("ignore next line part 1", () => {
-    const templateText = `
-line 1
-@template-ignore-next-line
-line 2
-line 3
-  `.trim();
-    const expectedTemplateText = `
-line 1
-line 3
-  `.trim();
-    const { text, linesBeforeIgnore } = getTruncatedText("test", templateText, new Set(), new Set());
-    strictEqual(linesBeforeIgnore.size, 1);
-    strictEqual([...linesBeforeIgnore][0], "line 1");
-    strictEqual(text, expectedTemplateText);
-});
-test("ignore next line part 2", () => {
-    const templateText = `
-line 1
-line 2
-line 3
-  `.trim();
-    const expectedTemplateText = `
-line 1
-line 3
-  `.trim();
-    const { text } = getTruncatedText("test", templateText, new Set(), new Set(["line 1"]));
-    strictEqual(text, expectedTemplateText);
-});