@comet/create-app 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2023, Vivid Planet Software GmbH
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,47 @@
+# @comet/create-app
+
+This is a command-line interface to create a new Comet application.
+It sets up a project with the necessary configuration and files to get started quickly.
+
+## Usage
+
+To create a new Comet app, run the following command:
+
+```bash
+npx @comet/create-app <project-name>
+```
+
+### Arguments
+
+The following arguments can be passed to customize the project setup:
+
+- `project-name` (required): Specifies the name of the project. It will be used as the directory name for the project.
+- `-v` or `--verbose`: Enables extra console logs for verbose output.
+- `-V` or `--version`: Outputs the version number.
+- `-h` or `--help`: Display help for the command.
+
+Example usage with arguments:
+
+```bash
+npx @comet/create-app my-project -v
+```
+
+
+This command will create a new Comet app with the name "my-project" and enable verbose logging.
+
+## For developers
+
+### Development
+
+To test the script locally, run the following commands:
+
+1. Start the development process:
+    ```bash
+   npm start
+    ```
+2. Run the script:
+    ```bash
+    node ./bin/index.js
+    ```
+
+Testing a close to production usage of the CLI can be done by calling `npm link` in the create-app/ directory. Then `npx @comet/create-app` can be used.

package/bin/index.js

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

package/lib/createApp.js

@@ -0,0 +1,66 @@
+"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 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();
+})();
+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, cleanupWorkingDirectory_1.cleanupWorkingDirectory)(projectConfiguration.verbose);
+    (0, replacePlaceholder_1.replacePlaceholder)(projectConfiguration.projectName, projectConfiguration.verbose);
+    (0, createInitialGitCommit_1.createInitialGitCommit)();
+    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(kleur_1.default.cyan(`npm run dev`));
+    console.log(kleur_1.default.white(`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(kleur_1.default.cyan(`npx dev-pm logs <service>`));
+    console.log(kleur_1.default.white(`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(kleur_1.default.cyan(`npx dev-pm shutdown`));
+    console.log(kleur_1.default.white(`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}`));
+}

package/lib/util/cleanupWorkingDirectory.js

@@ -0,0 +1,9 @@
+"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;

package/lib/util/createInitialGitCommit.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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() {
+    try {
+        (0, child_process_1.execSync)("git init");
+        (0, child_process_1.execSync)("git add .");
+        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."));
+    }
+    catch (e) {
+        console.log(kleur_1.default.yellow("Could not create git commit."));
+    }
+}
+exports.createInitialGitCommit = createInitialGitCommit;

package/lib/util/createWorkingDirectoryCopy.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWorkingDirectoryCopy = void 0;
+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}`;
+    try {
+        (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/util/deleteFilesAndFolders.js

@@ -0,0 +1,51 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteFilesAndFolders = void 0;
+const kleur_1 = __importDefault(require("kleur"));
+const deleteFileOrFolder = __importStar(require("rimraf"));
+function deleteFilesAndFolders(files, verbose) {
+    for (const toDelete of files) {
+        try {
+            deleteFileOrFolder.sync(`./${toDelete}`, {
+                maxRetries: 5,
+                retryDelay: 1000,
+            });
+            if (verbose) {
+                console.log(kleur_1.default.grey(`Info: Deleted ${toDelete}`));
+            }
+        }
+        catch (e) {
+            if (verbose) {
+                console.log(e);
+            }
+            console.log(kleur_1.default.yellow(`Could not delete ${toDelete}`));
+        }
+    }
+}
+exports.deleteFilesAndFolders = deleteFilesAndFolders;

package/lib/util/isValidNodeVersion.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidNodeVersion = void 0;
+function isNodeVersionGreaterThan18() {
+    const [major] = process.versions.node.split(".").map(Number);
+    return major >= 18;
+}
+function isValidNodeVersion() {
+    return isNodeVersionGreaterThan18();
+}
+exports.isValidNodeVersion = isValidNodeVersion;

package/lib/util/replacePlaceholder.js

@@ -0,0 +1,68 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replacePlaceholder = void 0;
+const fs = __importStar(require("fs"));
+const glob_1 = require("glob");
+const kleur_1 = __importDefault(require("kleur"));
+function replacePlaceholder(projectName, verbose) {
+    const files = glob_1.glob.sync([`./**`, `./.*`, `./.**/**`, `./**/.**/**`], {
+        maxDepth: 5,
+        ignore: `./.git/**`,
+    });
+    const placeholder = /[Ss]tarter/g;
+    let changedFiles = 0;
+    files.forEach((file) => {
+        try {
+            if (!fs.lstatSync(file).isFile()) {
+                return;
+            }
+            const contents = fs.readFileSync(file, "utf8").toString();
+            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++;
+                if (verbose) {
+                    console.log(kleur_1.default.grey(`Info: 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.green(`Successfully replaced content in ${changedFiles} files`));
+    }
+}
+exports.replacePlaceholder = replacePlaceholder;

package/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "@comet/create-app",
+    "version": "1.0.0",
+    "description": "Command-line interface to create a new Comet application",
+    "homepage": "https://github.com/vivid-planet/comet-starter/create-app#readme",
+    "bugs": {
+        "url": "https://github.com/vivid-planet/comet-starter/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/vivid-planet/comet-starter",
+        "directory": "create-app"
+    },
+    "license": "BSD-2-Clause",
+    "author": "Vivid Planet Software GmbH <office@vivid-planet.com> (https://www.vivid-planet.com/)",
+    "bin": "./bin/index.js",
+    "files": [
+        "bin/index.js",
+        "lib/**/*.js"
+    ],
+    "scripts": {
+        "prebuild": "npm run clean",
+        "build": "tsc --project tsconfig.json",
+        "clean": "rimraf lib",
+        "lint": "npm run lint:eslint && npm run lint:tsc",
+        "lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.json --max-warnings 0 src/ package.json",
+        "lint:tsc": "tsc --project ./tsconfig.json",
+        "prepublishOnly": "npm run lint && npm run build",
+        "prestart": "npm run clean",
+        "start": "tsc --watch --project tsconfig.json"
+    },
+    "dependencies": {
+        "commander": "^11.0.0",
+        "eslint": "^8.0.0",
+        "glob": "^10.3.3",
+        "kleur": "^4.1.5",
+        "rimraf": "^5.0.1"
+    },
+    "devDependencies": {
+        "@comet/eslint-config": "^4.3.0",
+        "@tsconfig/node18": "^18.2.2",
+        "@types/prompts": "^2.4.4",
+        "prettier": "^2.1.2",
+        "typescript": "^5.2.2"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    }
+}