@comet/create-app 1.4.0 → 1.11.0

package/README.md

@@ -15,10 +15,11 @@ npx @comet/create-app <project-name>
 
 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.
+-   `project-name` (required): Specifies the name of the project. It will be used as the directory name for the project.
+-   `-ni` or `--no-install`: Disables the automatic installation of dependencies.
+-   `-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:
 
@@ -26,14 +27,13 @@ Example usage with arguments:
 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.
+-   `remove-showcase`: Removes the showcase content from the project.
 
 Example usage:
 
@@ -41,7 +41,7 @@ Example usage:
 npx @comet/create-app remove-showcase
 ```
 
-- `remove-site`: Removes the site from the project.
+-   `remove-site`: Removes the site from the project.
 
 Example usage:
 
@@ -57,11 +57,11 @@ To test the script locally, run the following commands:
 
 1. Start the development process:
     ```bash
-   npm start
+    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.
+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/lib/index.js

@@ -23,9 +23,10 @@ void (async () => {
     program
         .argument("<projectName>", "Sets the name of the project.")
         .option("-v, --verbose", "Enables extra console logs for verbose output.")
+        .option("-ni, --no-install", "Disables the automatic installation of dependencies.")
         .action((projectName, options) => {
         if ((0, isValidProjectName_1.isValidProjectName)(projectName)) {
-            (0, createApp_1.createApp)({ projectName, verbose: options.verbose });
+            (0, createApp_1.createApp)({ projectName, verbose: options.verbose, install: options.install });
         }
         else {
             program.error("Please provide a valid project name.");

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.amendCommitChanges = void 0;
+const child_process_1 = require("child_process");
+function amendCommitChanges() {
+    (0, child_process_1.execSync)("git add .");
+    (0, child_process_1.execSync)("git commit --amend --no-edit");
+}
+exports.amendCommitChanges = amendCommitChanges;

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

@@ -4,9 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApp = void 0;
+const child_process_1 = require("child_process");
 const kleur_1 = __importDefault(require("kleur"));
+const nanospinner_1 = require("nanospinner");
 const process_1 = __importDefault(require("process"));
 const replacePlaceholder_1 = require("../../util/replacePlaceholder");
+const runEslintFix_1 = require("../../util/runEslintFix");
+const amendCommitChanges_1 = require("./amendCommitChanges");
 const cleanupReadme_1 = require("./cleanupReadme");
 const cleanupWorkingDirectory_1 = require("./cleanupWorkingDirectory");
 const createInitialGitCommit_1 = require("./createInitialGitCommit");
@@ -18,6 +22,19 @@ async function createApp(projectConfiguration) {
     (0, cleanupWorkingDirectory_1.cleanupWorkingDirectory)(projectConfiguration.verbose);
     (0, replacePlaceholder_1.replacePlaceholder)(projectConfiguration.projectName, projectConfiguration.verbose);
     (0, createInitialGitCommit_1.createInitialGitCommit)();
+    if (projectConfiguration.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.");
+        }
+        catch (error) {
+            spinner.error({ text: `An error occurred while installing the project: ${error}` });
+        }
+    }
+    (0, runEslintFix_1.runEslintFix)();
+    (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`));

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

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (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");
+const runEslintFix_1 = require("../../util/runEslintFix");
 async function removeFileContent() {
     const contentToRemove = [
         {
@@ -31,26 +31,18 @@ async function removeFileContent() {
             replacements: ["MikroOrmModule.forFeature([Product]), "],
         },
     ];
-    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();
+        let fileContent = (0, fs_1.readFileSync)(content.file, "utf-8").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);
+            (0, fs_1.writeFileSync)(content.file, fileContent);
         }
         catch (e) {
             (0, fs_1.writeFileSync)(content.file, fileContent);
@@ -68,5 +60,6 @@ async function removeShowcaseContent() {
         "api/src/db/migrations/Migration20220721123033.ts",
     ];
     (0, deleteFilesAndFolders_1.deleteFilesAndFolders)(filesToRemove, false);
+    (0, runEslintFix_1.runEslintFix)();
 }
 exports.removeShowcaseContent = removeShowcaseContent;

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

@@ -3,21 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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.*\n/gim);
+    (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)("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();
+    (0, runEslintFix_1.runEslintFix)();
 }
 exports.removeSite = removeSite;

package/lib/util/hasDependenciesInstalled.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasDependenciesInstalled = void 0;
+const fs_1 = __importDefault(require("fs"));
+function hasDependenciesInstalled(microservice) {
+    const files = fs_1.default.readdirSync(`${process.cwd()}/${microservice}`);
+    if (!files.includes("package.json")) {
+        return false;
+    }
+    const packageJson = fs_1.default.readFileSync(`${process.cwd()}/${microservice}/package.json`, "utf8");
+    return ((packageJson.includes("dependencies") || packageJson.includes("devDependencies")) &&
+        fs_1.default.existsSync(`${process.cwd()}/${microservice}/node_modules`));
+}
+exports.hasDependenciesInstalled = hasDependenciesInstalled;

package/lib/util/runEslintFix.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEslintFix = void 0;
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
+const hasDependenciesInstalled_1 = require("./hasDependenciesInstalled");
+function runEslintFix() {
+    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`);
+            continue;
+        }
+        try {
+            if (microservice !== "api")
+                (0, child_process_1.execSync)(`npm --prefix ${microservice} run prelint`);
+            (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);
+        }
+    }
+}
+exports.runEslintFix = runEslintFix;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@comet/create-app",
-    "version": "1.4.0",
+    "version": "1.11.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": {
@@ -22,8 +22,9 @@
         "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": "run-p lint:prettier lint:eslint lint:tsc",
+        "lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.json --max-warnings 0 src/",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --project ./tsconfig.json",
         "prepublishOnly": "npm run lint && npm run build",
         "prestart": "npm run clean",
@@ -34,12 +35,14 @@
         "eslint": "^8.0.0",
         "glob": "^10.3.3",
         "kleur": "^4.1.5",
+        "nanospinner": "^1.1.0",
         "rimraf": "^5.0.1"
     },
     "devDependencies": {
-        "@comet/eslint-config": "^5.6.0",
+        "@comet/eslint-config": "^6.3.0",
         "@tsconfig/node20": "^20.1.2",
         "@types/node": "^20.0.0",
+        "npm-run-all": "^4.1.5",
         "prettier": "^2.1.2",
         "typescript": "~5.1.0"
     },