@comet/create-app 1.0.0 → 1.1.0

package/README.md

@@ -29,6 +29,26 @@ npx @comet/create-app my-project -v
 
 This command will create a new Comet app with the name "my-project" and enable verbose logging.
 
+### Commands
+
+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:
+
+```bash
+npx @comet/create-app remove-site
+```
+
 ## For developers
 
 ### Development

package/bin/index.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require("../lib/createApp");
+require("../lib/index");

package/lib/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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");
+const isValidProjectName_1 = require("./util/isValidProjectName");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { name, version } = require("../package.json");
+if (!(0, isValidNodeVersion_1.isValidNodeVersion)()) {
+    console.error("Invalid Node Version (your Node.js version is prior to v18).");
+    process.exit(1);
+}
+void (async () => {
+    const program = new commander_1.Command();
+    program.name(name).description("CLI to create a Comet app").version(version);
+    program
+        .argument("<projectName>", "Sets the name of the project.")
+        .option("-v, --verbose", "Enables extra console logs for verbose output.")
+        .action((projectName, options) => {
+        if ((0, isValidProjectName_1.isValidProjectName)(projectName)) {
+            (0, createApp_1.createApp)({ projectName, verbose: options.verbose });
+        }
+        else {
+            program.error("Please provide a valid project name.");
+        }
+    })
+        .configureOutput({ outputError: (str, write) => write(kleur_1.default.bgRed(str)) });
+    program.addCommand(new commander_1.Command("remove-showcase").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 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)();
+    }));
+    program.parse();
+})();

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

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanupReadme = void 0;
+const fs = __importStar(require("fs"));
+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");
+}
+exports.cleanupReadme = cleanupReadme;

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanupWorkingDirectory = void 0;
+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);
+}
+exports.cleanupWorkingDirectory = cleanupWorkingDirectory;

package/lib/{createApp.js → scripts/create-app/createApp.js}

@@ -3,45 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
+exports.createApp = void 0;
 const kleur_1 = __importDefault(require("kleur"));
 const process_1 = __importDefault(require("process"));
-const cleanupWorkingDirectory_1 = require("./util/cleanupWorkingDirectory");
-const createInitialGitCommit_1 = require("./util/createInitialGitCommit");
-const createWorkingDirectoryCopy_1 = require("./util/createWorkingDirectoryCopy");
-const isValidNodeVersion_1 = require("./util/isValidNodeVersion");
-const replacePlaceholder_1 = require("./util/replacePlaceholder");
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { name, version } = require("../package.json");
-function isValidProjectName(value) {
-    const allowedFormat = /^[A-Za-z0-9][A-Za-z0-9-]*$/;
-    return allowedFormat.test(value);
-}
-void (async () => {
-    const program = new commander_1.Command();
-    if (!(0, isValidNodeVersion_1.isValidNodeVersion)()) {
-        console.log(kleur_1.default.bgRed("Invalid Node Version (your Node.js version is prior to v18)."));
-        return;
-    }
-    program.name(name).description("CLI to create a comet app").version(version);
-    program
-        .argument("<projectName>", "Sets the name of the project.")
-        .option("-v, --verbose", "Enables extra console logs for verbose output.")
-        .action((projectName, options) => {
-        if (isValidProjectName(projectName)) {
-            createApp({ projectName, verbose: options.verbose });
-        }
-        else {
-            console.log(kleur_1.default.bgRed("Please provide a valid project name."));
-        }
-    });
-    program.parse();
-})();
+const replacePlaceholder_1 = require("../../util/replacePlaceholder");
+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`));
-    if (!(0, createWorkingDirectoryCopy_1.createWorkingDirectoryCopy)(projectConfiguration.projectName, projectConfiguration.verbose)) {
-        return;
-    }
+    (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)();
@@ -64,3 +37,4 @@ async function createApp(projectConfiguration) {
     console.log(kleur_1.default.white(`Imports fixtures.\n`));
     console.log(kleur_1.default.green(`\n☄️ Successfully created Comet app: ${projectConfiguration.projectName}`));
 }
+exports.createApp = createApp;

package/lib/{util → scripts/create-app}/createInitialGitCommit.js

@@ -9,7 +9,7 @@ const kleur_1 = __importDefault(require("kleur"));
 function createInitialGitCommit() {
     try {
         (0, child_process_1.execSync)("git init");
-        (0, child_process_1.execSync)("git add .");
+        (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}"`);

package/lib/{util → scripts/create-app}/createWorkingDirectoryCopy.js

@@ -9,17 +9,10 @@ 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}`;
-    try {
-        (0, child_process_1.execSync)(clone);
-        process_1.default.chdir(`./${projectName}`);
-        if (verbose) {
-            console.log(kleur_1.default.white("Cloned git repository."));
-        }
+    (0, child_process_1.execSync)(clone);
+    process_1.default.chdir(`./${projectName}`);
+    if (verbose) {
+        console.log(kleur_1.default.white("Cloned git repository."));
     }
-    catch (e) {
-        console.log(kleur_1.default.bgRed(`Error while cloning working directory to ${projectName}`));
-        return false;
-    }
-    return true;
 }
 exports.createWorkingDirectoryCopy = createWorkingDirectoryCopy;

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

@@ -0,0 +1,72 @@
+"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 eslint_1 = require("eslint");
+const fs_1 = require("fs");
+const kleur_1 = __importDefault(require("kleur"));
+const deleteFilesAndFolders_1 = require("../../util/deleteFilesAndFolders");
+async function removeFileContent() {
+    const contentToRemove = [
+        {
+            file: `./admin/src/Routes.tsx`,
+            replacements: [/<.*?products.*?>/gs],
+        },
+        {
+            file: `./admin/src/common/MasterMenu.tsx`,
+            replacements: [/<MenuItemRouterLink[ \n]*primary={intl.formatMessage\({ id: "comet.menu.products".*products`}[ \n]*\/>/gs],
+        },
+        {
+            file: `./api/src/app.module.ts`,
+            replacements: [/ProductsModule,\n/gs],
+        },
+        {
+            file: `./api/src/db/fixtures/fixtures.console.ts`,
+            replacements: [/constructor.*Product.*{}/gs, /await Promise.all\(\[generateProducts.*]\);/gs],
+        },
+        {
+            file: `./api/src/db/fixtures/fixtures.module.ts`,
+            replacements: [/imports: \[MikroOrmModule.forFeature\(\[Product]\), ConfigModule, ConsoleModule],/gs],
+        },
+    ];
+    const eslint = new eslint_1.ESLint({
+        cwd: process.cwd(),
+        fix: true,
+    });
+    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).toString();
+        for (const replacement of content.replacements) {
+            fileContent = fileContent.replaceAll(replacement, "");
+        }
+        try {
+            const lintedFileContent = await eslint.lintText(fileContent, {
+                filePath: content.file,
+            });
+            const output = lintedFileContent[0] && lintedFileContent[0].output ? lintedFileContent[0].output : lintedFileContent[0].source;
+            (0, fs_1.writeFileSync)(content.file, output ?? 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);
+}
+exports.removeShowcaseContent = removeShowcaseContent;

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeSite = void 0;
+const deleteFilesAndFolders_1 = require("../../util/deleteFilesAndFolders");
+const removeReferenceInFile_1 = require("../../util/removeReferenceInFile");
+function removeSiteReferences() {
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".vscode/settings.json", /, "site"/g);
+    (0, removeReferenceInFile_1.removeReferenceInFile)(".env", /.*site.*\n/gim);
+    (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)("admin/src/environment.ts", /, "SITES_CONFIG"/g);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", / browser:site/g);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("./package.json", /.*site.*\n/gim);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("admin/src/config.ts", /.*site.*\n/gim);
+    (0, removeReferenceInFile_1.removeReferenceInFile)("dev-pm.config.js", /{[\n ]*name: "site.*},\n/gis);
+}
+function removeSite() {
+    (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(["site"], false);
+    removeSiteReferences();
+}
+exports.removeSite = removeSite;

package/lib/util/cwdIsCometProject.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cwdIsCometProject = void 0;
+const fs_1 = __importDefault(require("fs"));
+function cwdIsCometProject() {
+    return fs_1.default.existsSync("api/src/comet-config.json");
+}
+exports.cwdIsCometProject = cwdIsCometProject;

package/lib/util/isValidProjectName.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidProjectName = void 0;
+function isValidProjectName(value) {
+    const allowedFormat = /^[A-Za-z0-9][A-Za-z0-9-]*$/;
+    return allowedFormat.test(value);
+}
+exports.isValidProjectName = isValidProjectName;

package/lib/util/removeReferenceInFile.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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");
+}
+exports.removeReferenceInFile = removeReferenceInFile;

package/lib/util/replacePlaceholder.js

@@ -46,8 +46,6 @@ function replacePlaceholder(projectName, verbose) {
             if (placeholder.test(contents)) {
                 if (file.endsWith("intl-update.sh"))
                     fs.writeFileSync(file, contents.replaceAll("lang/starter-lang", `lang/${projectName}-lang`));
-                else if (file.endsWith("lint-staged.config.js"))
-                    fs.writeFileSync(file, contents.replaceAll(/"create.*lint:tsc",\n/gs, ""));
                 else
                     fs.writeFileSync(file, contents.replaceAll(placeholder, projectName));
                 changedFiles++;

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@comet/create-app",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "Command-line interface to create a new Comet application",
-    "homepage": "https://github.com/vivid-planet/comet-starter/create-app#readme",
+    "homepage": "https://github.com/vivid-planet/comet-starter/tree/main/create-app#readme",
     "bugs": {
         "url": "https://github.com/vivid-planet/comet-starter/issues"
     },
@@ -37,11 +37,10 @@
         "rimraf": "^5.0.1"
     },
     "devDependencies": {
-        "@comet/eslint-config": "^4.3.0",
+        "@comet/eslint-config": "^5.4.0",
         "@tsconfig/node18": "^18.2.2",
-        "@types/prompts": "^2.4.4",
         "prettier": "^2.1.2",
-        "typescript": "^5.2.2"
+        "typescript": "~5.1.0"
     },
     "publishConfig": {
         "access": "public",

package/lib/util/cleanupWorkingDirectory.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanupWorkingDirectory = void 0;
-const deleteFilesAndFolders_1 = require("./deleteFilesAndFolders");
-function cleanupWorkingDirectory(verbose) {
-    const cleanupFilesDirectories = ["create-app", ".git", ".github"];
-    (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(cleanupFilesDirectories, verbose);
-}
-exports.cleanupWorkingDirectory = cleanupWorkingDirectory;