@comet/create-app 1.18.0 → 1.20.0

package/README.md

@@ -17,17 +17,25 @@ 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.
 -   `-ni` or `--no-install`: Disables the automatic installation of dependencies.
+-   `-r` or `--repository <repository>`: Repository to clone from. Defaults to `https://github.com/vivid-planet/comet-starter.git`.
+-   `-b` or `--branch <branch>`: Branch to checkout. Defaults to `main`.
 -   `-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:
+#### Example usage with arguments
+
+Create a new Comet app with the name "my-project" and enable verbose logging:
 
 ```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.
+Create a new Comet app with a different repository and branch:
+
+```bash
+npx @comet/create-app my-project -r https://github.com/my-company/comet-starter.git -b next
+```
 
 ### Commands
 

package/lib/index.js

@@ -23,9 +23,17 @@ void (async () => {
         .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.")
+        .option("-r, --repository <repository>", "Repository to clone from.")
+        .option("-b, --branch <branch>", "Branch to checkout.")
         .action((projectName, options) => {
         if ((0, isValidProjectName_1.isValidProjectName)(projectName)) {
-            (0, createApp_1.createApp)({ projectName, verbose: options.verbose, install: options.install });
+            (0, createApp_1.createApp)({
+                projectName,
+                verbose: options.verbose,
+                install: options.install,
+                repository: options.repository,
+                branch: options.branch,
+            });
         }
         else {
             program.error("Please provide a valid project name.");

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

@@ -17,7 +17,7 @@ const createInitialGitCommit_1 = require("./createInitialGitCommit");
 const createWorkingDirectoryCopy_1 = require("./createWorkingDirectoryCopy");
 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, createWorkingDirectoryCopy_1.createWorkingDirectoryCopy)(commandOptions);
     (0, cleanupReadme_1.cleanupReadme)(commandOptions.verbose);
     (0, cleanupWorkingDirectory_1.cleanupWorkingDirectory)(commandOptions.verbose);
     (0, replacePlaceholder_1.replacePlaceholder)(commandOptions.projectName, commandOptions.verbose);

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

@@ -7,9 +7,9 @@ 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) {
+function createWorkingDirectoryCopy({ projectName, repository = "https://github.com/vivid-planet/comet-starter.git", branch = "main", verbose, }) {
     try {
-        const clone = `git clone --depth 1 https://github.com/vivid-planet/comet-starter.git ./${projectName}`;
+        const clone = `git clone --depth 1 --branch ${branch} ${repository} ./${projectName}`;
         (0, child_process_1.execSync)(clone);
         process_1.default.chdir(`./${projectName}`);
         if (verbose) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@comet/create-app",
-    "version": "1.18.0",
+    "version": "1.20.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": {
@@ -39,7 +39,7 @@
         "rimraf": "^5.0.1"
     },
     "devDependencies": {
-        "@comet/eslint-config": "^6.5.0",
+        "@comet/eslint-config": "^6.9.0",
         "@tsconfig/node20": "^20.1.2",
         "@types/node": "^20.0.0",
         "npm-run-all": "^4.1.5",