@comet/create-app 1.13.0 → 1.15.0

package/README.md

@@ -33,14 +33,6 @@ This command will create a new Comet app with the name "my-project" and enable v
 
 The following commands can be used to customize the project setup:
 
--   `remove-showcase`: Removes the showcase content from the project.
-
-Example usage:
-
-```bash
-npx @comet/create-app remove-showcase
-```
-
 -   `remove-site`: Removes the site from the project.
 
 Example usage:

package/lib/index.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const kleur_1 = __importDefault(require("kleur"));
 const createApp_1 = require("./scripts/create-app/createApp");
-const removeShowcase_1 = require("./scripts/remove-showcase/removeShowcase");
 const removeSite_1 = require("./scripts/remove-site/removeSite");
 const cwdIsCometProject_1 = require("./util/cwdIsCometProject");
 const isValidNodeVersion_1 = require("./util/isValidNodeVersion");
@@ -33,19 +32,12 @@ void (async () => {
         }
     })
         .configureOutput({ outputError: (str, write) => write(kleur_1.default.bgRed(str)) });
-    program.addCommand(new commander_1.Command("remove-showcase").action(() => {
+    program.addCommand(new commander_1.Command("remove-site").option("-v, --verbose", "Enables extra console logs for verbose output.").action((options) => {
         if (!(0, cwdIsCometProject_1.cwdIsCometProject)()) {
             program.error(`This command must be run from the root of a Comet project.`);
         }
-        console.log(kleur_1.default.white(`Removing showcase content from project`));
-        (0, removeShowcase_1.removeShowcaseContent)();
-    }));
-    program.addCommand(new commander_1.Command("remove-site").action(() => {
-        if (!(0, cwdIsCometProject_1.cwdIsCometProject)()) {
-            program.error(`This command must be run from the root of a Comet project.`);
-        }
-        console.log(kleur_1.default.white(`Removing site from project`));
-        (0, removeSite_1.removeSite)();
+        console.log("Removing site from project...");
+        (0, removeSite_1.removeSite)(options.verbose);
     }));
     program.parse();
 })();

package/lib/scripts/create-app/cleanupReadme.js

@@ -22,13 +22,28 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanupReadme = void 0;
 const fs = __importStar(require("fs"));
+const kleur_1 = __importDefault(require("kleur"));
 const readmePath = "README.md";
-function cleanupReadme() {
-    const originalReadme = fs.readFileSync(readmePath, "utf8").toString();
-    const newReadme = originalReadme.replace(/.+<!-- PROJECT_README_BEGIN.+-->\n\n/s, "");
-    fs.writeFileSync(readmePath, newReadme, "utf8");
+function cleanupReadme(verbose) {
+    try {
+        const originalReadme = fs.readFileSync(readmePath, "utf8").toString();
+        const newReadme = originalReadme.replace(/.+<!-- PROJECT_README_BEGIN.+-->\n\n/s, "");
+        fs.writeFileSync(readmePath, newReadme, "utf8");
+        if (verbose) {
+            console.log(kleur_1.default.grey("Cleaned up README.md"));
+        }
+    }
+    catch (e) {
+        console.log(kleur_1.default.yellow("Could not clean up README.md"));
+        if (verbose) {
+            console.log(kleur_1.default.grey(`${e}`));
+        }
+    }
 }
 exports.cleanupReadme = cleanupReadme;

package/lib/scripts/create-app/cleanupWorkingDirectory.js

@@ -5,7 +5,7 @@ const deleteFilesAndFolders_1 = require("../../util/deleteFilesAndFolders");
 const removeReferenceInFile_1 = require("../../util/removeReferenceInFile");
 function cleanupWorkingDirectory(verbose) {
     (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(["create-app", ".git", ".github", "LICENSE"], verbose);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("lint-staged.config.js", /.*create-app.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)(".vscode/settings.json", /, "create-app"/g);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("lint-staged.config.js", /.*create-app.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".vscode/settings.json", /, "create-app"/g, verbose);
 }
 exports.cleanupWorkingDirectory = cleanupWorkingDirectory;

package/lib/scripts/create-app/createApp.js

@@ -15,43 +15,50 @@ const cleanupReadme_1 = require("./cleanupReadme");
 const cleanupWorkingDirectory_1 = require("./cleanupWorkingDirectory");
 const createInitialGitCommit_1 = require("./createInitialGitCommit");
 const createWorkingDirectoryCopy_1 = require("./createWorkingDirectoryCopy");
-async function createApp(projectConfiguration) {
-    console.log(kleur_1.default.white(`Creating a new Comet app in `) + kleur_1.default.yellow(`${process_1.default.cwd()}\n`));
-    (0, createWorkingDirectoryCopy_1.createWorkingDirectoryCopy)(projectConfiguration.projectName, projectConfiguration.verbose);
-    (0, cleanupReadme_1.cleanupReadme)();
-    (0, cleanupWorkingDirectory_1.cleanupWorkingDirectory)(projectConfiguration.verbose);
-    (0, replacePlaceholder_1.replacePlaceholder)(projectConfiguration.projectName, projectConfiguration.verbose);
-    (0, createInitialGitCommit_1.createInitialGitCommit)();
-    if (projectConfiguration.install) {
+async function createApp(commandOptions) {
+    console.log(`Creating a new Comet app in ${kleur_1.default.blue(`${process_1.default.cwd()}\n`)}`);
+    (0, createWorkingDirectoryCopy_1.createWorkingDirectoryCopy)(commandOptions.projectName, commandOptions.verbose);
+    (0, cleanupReadme_1.cleanupReadme)(commandOptions.verbose);
+    (0, cleanupWorkingDirectory_1.cleanupWorkingDirectory)(commandOptions.verbose);
+    (0, replacePlaceholder_1.replacePlaceholder)(commandOptions.projectName, commandOptions.verbose);
+    (0, createInitialGitCommit_1.createInitialGitCommit)(commandOptions.verbose);
+    if (commandOptions.install) {
         const spinner = (0, nanospinner_1.createSpinner)("Installing project...").spin();
         try {
             (0, child_process_1.execSync)("sh ./install.sh");
             spinner.success();
-            console.log("Installation completed successfully.");
-            (0, runEslintFix_1.runEslintFix)();
+            if (commandOptions.verbose)
+                console.log(kleur_1.default.grey("Successfully installed project."));
+            (0, runEslintFix_1.runEslintFix)(commandOptions.verbose);
         }
         catch (error) {
-            spinner.error({ text: `An error occurred while installing the project: ${error}` });
+            spinner.error();
+            console.log(kleur_1.default.yellow("Could not install project."));
+            if (commandOptions.verbose)
+                console.log(kleur_1.default.grey(`${error}`));
         }
     }
     (0, amendCommitChanges_1.amendCommitChanges)();
-    console.log(`\n${kleur_1.default.white(`Success! Created '${projectConfiguration.projectName}' at '${process_1.default.cwd()}'.`)}`);
-    console.log(kleur_1.default.white(`Inside that directory, you can run several commands:\n`));
-    console.log(kleur_1.default.white(`nvm use\n`));
-    console.log(kleur_1.default.cyan(`sh ./install.sh\n`));
-    console.log(kleur_1.default.white(`Installs dependencies.\n`));
+    console.log(`\nSuccess! Created '${commandOptions.projectName}' at '${process_1.default.cwd()}'.`);
+    console.log(`Inside that directory, you can run several commands:\n`);
+    console.log(kleur_1.default.cyan(`nvm use`));
+    console.log(`Switches to the correct Node.js version.\n`);
+    if (!commandOptions.install) {
+        console.log(kleur_1.default.cyan(`sh ./install.sh`));
+        console.log(`Installs dependencies.\n`);
+    }
     console.log(kleur_1.default.cyan(`npm run dev`));
-    console.log(kleur_1.default.white(`Starts all services.\n`));
+    console.log(`Starts all services.\n`);
     console.log(kleur_1.default.cyan(`npx dev-pm status [--interval]`));
-    console.log(kleur_1.default.white(`Checks the status of services.\n`));
+    console.log(`Checks the status of services.\n`);
     console.log(kleur_1.default.cyan(`npx dev-pm logs <service>`));
-    console.log(kleur_1.default.white(`Shows the logs of a service.\n`));
+    console.log(`Shows the logs of a service.\n`);
     console.log(kleur_1.default.cyan(`npx dev-pm restart <service>`));
-    console.log(kleur_1.default.white(`Restarts a service.\n`));
+    console.log(`Restarts a service.\n`);
     console.log(kleur_1.default.cyan(`npx dev-pm shutdown`));
-    console.log(kleur_1.default.white(`Shutdown all services.\n`));
+    console.log(`Shutdown all services.\n`);
     console.log(kleur_1.default.cyan(`npm run --prefix api fixtures`));
-    console.log(kleur_1.default.white(`Imports fixtures.\n`));
-    console.log(kleur_1.default.green(`\n☄️ Successfully created Comet app: ${projectConfiguration.projectName}`));
+    console.log(`Imports fixtures.\n`);
+    console.log(kleur_1.default.green(`\n☄️ Successfully created Comet app: ${commandOptions.projectName}`));
 }
 exports.createApp = createApp;

package/lib/scripts/create-app/createInitialGitCommit.js

@@ -6,17 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createInitialGitCommit = void 0;
 const child_process_1 = require("child_process");
 const kleur_1 = __importDefault(require("kleur"));
-function createInitialGitCommit() {
+function createInitialGitCommit(verbose) {
     try {
         (0, child_process_1.execSync)("git init");
         (0, child_process_1.execSync)("git add . -f");
         const basedOnCommit = (0, child_process_1.execSync)('git ls-remote https://github.com/vivid-planet/comet-starter.git | head -1 | sed "s/HEAD//"');
         (0, child_process_1.execSync)("git checkout -b setup-project");
         (0, child_process_1.execSync)(`git commit -m "Initial commit from Starter" -m "Based on ${basedOnCommit}"`);
-        console.log(kleur_1.default.white("Created git commit."));
+        if (verbose) {
+            console.log(kleur_1.default.grey("Created initial git commit."));
+        }
     }
     catch (e) {
         console.log(kleur_1.default.yellow("Could not create git commit."));
+        if (verbose) {
+            console.log(kleur_1.default.grey(`${e}`));
+        }
     }
 }
 exports.createInitialGitCommit = createInitialGitCommit;

package/lib/scripts/create-app/createWorkingDirectoryCopy.js

@@ -8,11 +8,20 @@ const child_process_1 = require("child_process");
 const kleur_1 = __importDefault(require("kleur"));
 const process_1 = __importDefault(require("process"));
 function createWorkingDirectoryCopy(projectName, verbose) {
-    const clone = `git clone --depth 1 https://github.com/vivid-planet/comet-starter.git ./${projectName}`;
-    (0, child_process_1.execSync)(clone);
-    process_1.default.chdir(`./${projectName}`);
-    if (verbose) {
-        console.log(kleur_1.default.white("Cloned git repository."));
+    try {
+        const clone = `git clone --depth 1 https://github.com/vivid-planet/comet-starter.git ./${projectName}`;
+        (0, child_process_1.execSync)(clone);
+        process_1.default.chdir(`./${projectName}`);
+        if (verbose) {
+            console.log(kleur_1.default.grey("Cloned git repository."));
+        }
+    }
+    catch (e) {
+        console.log(kleur_1.default.red("Could not clone git repository."));
+        if (verbose) {
+            console.log(kleur_1.default.grey(`${e}`));
+        }
+        process_1.default.exit(1);
     }
 }
 exports.createWorkingDirectoryCopy = createWorkingDirectoryCopy;

package/lib/scripts/remove-site/removeSite.js

@@ -4,20 +4,20 @@ exports.removeSite = void 0;
 const deleteFilesAndFolders_1 = require("../../util/deleteFilesAndFolders");
 const removeReferenceInFile_1 = require("../../util/removeReferenceInFile");
 const runEslintFix_1 = require("../../util/runEslintFix");
-function removeSiteReferences() {
-    (0, removeReferenceInFile_1.removeReferenceInFile)(".vscode/settings.json", /, "site"/g);
-    (0, removeReferenceInFile_1.removeReferenceInFile)(".env", /# site.*NEXT_PUBLIC_SITE_IS_PREVIEW=false\n\n/gms);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("install.sh", /.*site.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)(".prettierignore", /.*site.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("copy-schema-files.js", /.*site.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("lint-staged.config.js", /.*site.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", / browser:site/g);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", /.*site.*\n/gim);
-    (0, removeReferenceInFile_1.removeReferenceInFile)("dev-pm.config.js", /{[\n ]*name: "site.*},\n/gis);
+function removeSiteReferences(verbose) {
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".vscode/settings.json", /, "site"/g, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".env", /# site.*NEXT_PUBLIC_SITE_IS_PREVIEW=false\n\n/gms, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("install.sh", /.*site.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".prettierignore", /.*site.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("copy-schema-files.js", /.*site.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("lint-staged.config.js", /.*site.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", / browser:site/g, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", /.*site.*\n/gim, verbose);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("dev-pm.config.js", /{[\n ]*name: "site.*},\n/gis, verbose);
 }
-function removeSite() {
-    (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(["site"], false);
-    removeSiteReferences();
-    (0, runEslintFix_1.runEslintFix)();
+function removeSite(verbose) {
+    (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(["site"], verbose);
+    removeSiteReferences(verbose);
+    (0, runEslintFix_1.runEslintFix)(verbose);
 }
 exports.removeSite = removeSite;

package/lib/util/deleteFilesAndFolders.js

@@ -37,14 +37,14 @@ function deleteFilesAndFolders(files, verbose) {
                 retryDelay: 1000,
             });
             if (verbose) {
-                console.log(kleur_1.default.grey(`Info: Deleted ${toDelete}`));
+                console.log(kleur_1.default.grey(`Deleted ${toDelete}`));
             }
         }
         catch (e) {
+            console.log(kleur_1.default.yellow(`Could not delete ${toDelete}`));
             if (verbose) {
-                console.log(e);
+                console.log(kleur_1.default.grey(`${e}`));
             }
-            console.log(kleur_1.default.yellow(`Could not delete ${toDelete}`));
         }
     }
 }

package/lib/util/removeReferenceInFile.js

@@ -22,12 +22,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeReferenceInFile = void 0;
 const fs = __importStar(require("fs"));
-function removeReferenceInFile(filePath, regex) {
-    const data = fs.readFileSync(filePath, "utf8");
-    const result = data.replace(regex, "");
-    fs.writeFileSync(filePath, result, "utf8");
+const kleur_1 = __importDefault(require("kleur"));
+function removeReferenceInFile(filePath, regex, verbose) {
+    try {
+        const data = fs.readFileSync(filePath, "utf8");
+        const result = data.replace(regex, "");
+        fs.writeFileSync(filePath, result, "utf8");
+        if (verbose) {
+            console.log(kleur_1.default.grey(`Removed reference in ${filePath}`));
+        }
+    }
+    catch (e) {
+        console.log(kleur_1.default.yellow(`Could not remove reference in ${filePath}`));
+        if (verbose) {
+            console.log(kleur_1.default.grey(`${e}`));
+        }
+    }
 }
 exports.removeReferenceInFile = removeReferenceInFile;

package/lib/util/replacePlaceholder.js

@@ -50,17 +50,19 @@ function replacePlaceholder(projectName, verbose) {
                     fs.writeFileSync(file, contents.replaceAll(placeholder, projectName));
                 changedFiles++;
                 if (verbose) {
-                    console.log(kleur_1.default.grey(`Info: Replaced content in ${file}`));
+                    console.log(kleur_1.default.grey(`Replaced content in ${file}`));
                 }
             }
         }
         catch (e) {
-            console.log(e);
             console.log(kleur_1.default.yellow(`Could not replace placeholder in ${file}`));
+            if (verbose) {
+                console.log(kleur_1.default.grey(`${e}`));
+            }
         }
     });
     if (verbose) {
-        console.log(kleur_1.default.green(`Successfully replaced content in ${changedFiles} files`));
+        console.log(kleur_1.default.grey(`Successfully replaced content in ${changedFiles} files`));
     }
 }
 exports.replacePlaceholder = replacePlaceholder;

package/lib/util/runEslintFix.js

@@ -6,15 +6,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runEslintFix = void 0;
 const child_process_1 = require("child_process");
 const fs_1 = __importDefault(require("fs"));
+const kleur_1 = __importDefault(require("kleur"));
 const hasDependenciesInstalled_1 = require("./hasDependenciesInstalled");
-function runEslintFix() {
+function runEslintFix(verbose) {
     const microservices = ["admin", "api", "site"];
     for (const microservice of microservices) {
         if (!fs_1.default.existsSync(microservice)) {
             continue;
         }
-        else if (!(0, hasDependenciesInstalled_1.hasDependenciesInstalled)(microservice)) {
-            console.warn(`Cannot fix ESLint errors in ${microservice} because it has no dependencies installed`);
+        else if (!(0, hasDependenciesInstalled_1.hasDependenciesInstalled)(microservice) && verbose) {
+            console.log(kleur_1.default.grey(`Skipping ESLint fix in ${microservice} because dependencies are not installed.`));
             continue;
         }
         try {
@@ -23,9 +24,10 @@ function runEslintFix() {
             (0, child_process_1.execSync)(`npm run --prefix ${microservice} lint:eslint -- --fix`);
         }
         catch (err) {
-            console.error(`Failed to fix ESLint errors in ${microservice}. See original error below`);
-            console.error(err);
-            process.exit(1);
+            console.log(kleur_1.default.yellow(`Failed to fix ESLint errors in ${microservice}.`));
+            if (verbose) {
+                console.log(kleur_1.default.grey(`${err}`));
+            }
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@comet/create-app",
-    "version": "1.13.0",
+    "version": "1.15.0",
     "description": "Command-line interface to create a new Comet application",
     "homepage": "https://github.com/vivid-planet/comet-starter/tree/main/create-app#readme",
     "bugs": {

package/lib/scripts/remove-showcase/removeShowcase.js

@@ -1,65 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeShowcaseContent = void 0;
-const fs_1 = require("fs");
-const kleur_1 = __importDefault(require("kleur"));
-const deleteFilesAndFolders_1 = require("../../util/deleteFilesAndFolders");
-const runEslintFix_1 = require("../../util/runEslintFix");
-async function removeFileContent() {
-    const contentToRemove = [
-        {
-            file: `./admin/src/Routes.tsx`,
-            replacements: [/\s*<.*?products.*?>/g],
-        },
-        {
-            file: `./admin/src/common/MasterMenu.tsx`,
-            replacements: [/\s*<MenuCollapsibleItem.*products`}\s*\/>\s*<\/MenuCollapsibleItem>/gs],
-        },
-        {
-            file: `./api/src/app.module.ts`,
-            replacements: [/\s*ProductsModule,/gs],
-        },
-        {
-            file: `./api/src/db/fixtures/fixtures.console.ts`,
-            replacements: [/, @InjectRepository.*Product.*<Product>/gs, /\s*await Promise.all\(\[generateProducts.*]\);/gs],
-        },
-        {
-            file: `./api/src/db/fixtures/fixtures.module.ts`,
-            replacements: ["MikroOrmModule.forFeature([Product]), "],
-        },
-    ];
-    for (const content of contentToRemove) {
-        if (!(0, fs_1.existsSync)(content.file)) {
-            console.log(kleur_1.default.bgYellow(`File: ${content.file} does not exist!`));
-            console.log(kleur_1.default.bgYellow(`Skipping: ${content.file}...`));
-            continue;
-        }
-        let fileContent = (0, fs_1.readFileSync)(content.file, "utf-8").toString();
-        for (const replacement of content.replacements) {
-            fileContent = fileContent.replaceAll(replacement, "");
-        }
-        try {
-            (0, fs_1.writeFileSync)(content.file, fileContent);
-        }
-        catch (e) {
-            (0, fs_1.writeFileSync)(content.file, fileContent);
-            console.log(kleur_1.default.yellow(`Could not lint: ${content.file}!`));
-            console.log(e);
-        }
-    }
-}
-async function removeShowcaseContent() {
-    await removeFileContent();
-    const filesToRemove = [
-        "api/src/products",
-        "admin/src/products",
-        "api/src/db/fixtures/generators/product.fixture.ts",
-        "api/src/db/migrations/Migration20220721123033.ts",
-    ];
-    (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(filesToRemove, false);
-    (0, runEslintFix_1.runEslintFix)();
-}
-exports.removeShowcaseContent = removeShowcaseContent;