quick-scaffolds-cli 1.2.1 → 1.2.3

package/README.md

@@ -6,7 +6,7 @@ A lightweight interactive CLI for scaffolding starter web projects quickly.
 
 quick-scaffolds-cli generates a ready-to-use project from templates with a simple prompt flow.
 
-Current release: v1.2.1
+Current release: v1.2.3
 
 ## Quick Start
 
@@ -16,7 +16,7 @@ Install once and use the command anywhere:
 
 ```bash
 npm install -g quick-scaffolds-cli
-ct-pro
+ct-pro my-awesome-app
 ```
 
 ### Use with npx
@@ -24,16 +24,16 @@ ct-pro
 Run without installing globally:
 
 ```bash
-npx quick-scaffolds-cli
+npx quick-scaffolds-cli my-awesome-app
 ```
 
 ## Usage
 
-Run the CLI and answer two prompts:
+Run the CLI with an initial project name, then choose whether to keep it or change it:
 
 ```bash
-ct-pro
-? What is your project name? my-awesome-app
+ct-pro my-awesome-app
+? Your project name will be named "my-awesome-app". Do you want to keep it? (Y/n)
 ? What do you want to build?
   Static HTML/CSS/JS
   React starter
@@ -41,11 +41,19 @@ ct-pro
 
 Prompt details:
 
-1. Project name (default: my-new-project)
+1. Confirm project name:
+  - Keep the provided name
+  - Change it by entering a new project name (default: `my-new-project`)
 2. Project type:
    - Static HTML/CSS/JS
    - React starter
 
+If you choose not to keep the provided name, the CLI asks:
+
+```bash
+? What is your project name? my-updated-app
+```
+
 ## Templates
 
 ### 1. Static HTML/CSS/JS
@@ -71,9 +79,10 @@ Generated structure:
 
 ```text
 my-awesome-app/
+├── .gitignore
+├── index.html
 ├── package.json
 ├── public/
-│   ├── index.html
 │   └── index.css
 └── src/
     ├── App.css
@@ -101,8 +110,13 @@ npm run dev
 
 ```text
 quick-scaffolds-cli/
+├── .gitignore
+├── .npmignore
 ├── bin/
 │   └── cli.js
+├── package-lock.json
+├── package.json
+├── README.md
 ├── templates/
 │   ├── html-template/
 │   │   ├── index.html
@@ -111,17 +125,17 @@ quick-scaffolds-cli/
 │   │   └── js/
 │   │       └── app.js
 │   └── react-template/
+│       ├── .gitignore
+│       ├── index.html
 │       ├── package.json
 │       ├── public/
-│       │   ├── index.css
-│       │   └── index.html
+│       │   └── index.css
 │       └── src/
 │           ├── App.css
 │           ├── App.jsx
 │           ├── index.css
 │           └── main.jsx
-├── package.json
-└── README.md
+└── LICENSE
 ```
 
 ## Dependencies
@@ -134,4 +148,4 @@ MIT
 
 ## Contributing
 
-Issues and pull requests are welcome on github.
+Issues and pull requests are welcome on GitHub.

package/bin/cli.js

@@ -3,14 +3,21 @@ import { execSync } from 'node:child_process';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { input, select } from '@inquirer/prompts';
+import { input, select, confirm } from '@inquirer/prompts';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 async function main() {
-    try {
-        const name = await input(
+    let name = process.argv[2];
+
+    const keepName = await confirm({
+        message: `Your project name will be named "${name}". Do you want to keep it ?`,
+        default: true
+    });
+
+    if (!keepName) {
+        name = await input(
             {
                 name: 'projectName',
                 message: 'What is your project name?',
@@ -18,32 +25,34 @@ async function main() {
                 default: 'my-new-project'
             }
         );
-        const projectType = await select({
-            message: 'What do you want to build?',
-            type: "list",
-            choices: [
-                { name: 'Static HTML/CSS/JS', value: 'static' },
-                { name: 'React starter', value: 'react' }
-            ],
-        });
-        let templateFolder = '';
-        if (projectType === 'static') {
-            templateFolder = 'html-template';
-        }
+    }
 
-        if (projectType === 'react') {
-            templateFolder = 'react-template';
-            await reactApp(name, templateFolder);
-            return;
-        }
+    const projectType = await select({
+        message: 'What do you want to build?',
+        type: "list",
+        choices: [
+            { name: 'Static HTML/CSS/JS', value: 'static' },
+            { name: 'React starter', value: 'react' }
+        ],
+    });
+    let templateFolder = '';
+    if (projectType === 'static') {
+        templateFolder = 'html-template';
+    }
 
+    if (projectType === 'react') {
+        templateFolder = 'react-template';
+        await reactApp(name, templateFolder);
+        return;
+    }
+    try {
         const projectName = name;
         const targetPath = path.join(process.cwd(), projectName);
 
         const templatePath = path.join(__dirname, '../templates', templateFolder);
         await fs.mkdir(targetPath, { recursive: true });
         await fs.cp(templatePath, targetPath, { recursive: true });
-        console.log(`Successfully scaffolded the HTMl project - ${projectName}`)
+        console.log(`\nSuccessfully scaffolded the HTMl project - ${projectName}\n`)
 
     } catch (err) {
         console.error(`Error - ${err.message}`)
@@ -59,7 +68,7 @@ async function reactApp(projectName, templateFolder) {
 
         const filesToUpdate = [
             path.join(targetPath, 'package.json'),
-            path.join(targetPath, 'public','index.html')
+            path.join(targetPath, 'index.html')
         ];
         for (const filePath of filesToUpdate) {
             try {
@@ -72,17 +81,17 @@ async function reactApp(projectName, templateFolder) {
             }
         }
 
-        console.log(`Successfully scaffolded the React starter project - ${projectName}`)
-        console.log('📦 Installing dependencies... This may take a minute.');
+        console.log(`Successfully scaffolded the React starter project - ${projectName}\n`)
+        console.log('📦 Installing dependencies... This may take a minute.\n');
         try {
             execSync('npm install', {
                 cwd: targetPath,
                 stdio: 'inherit'
             });
-            console.log('✅ Dependencies installed successfully!');
-        } catch (err){
+            console.log('✅ Dependencies installed successfully!\n');
+        } catch (err) {
             console.error(err);
-            console.log('⚠️ Could not install dependencies automatically.');
+            console.log('⚠️ Could not install dependencies automatically.\n');
             console.log('Please run "npm install" manually inside your project folder.');
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quick-scaffolds-cli",
-    "version": "1.2.1",
+    "version": "1.2.3",
     "type": "module",
     "bin": {
         "ct-pro": "bin/cli.js"