@pugpigjs/create-wp-project 0.0.2-beta.0 → 0.0.2-beta.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pugpigjs/create-wp-project
 
+## 0.0.2-beta.1
+
+### Patch Changes
+
+- 13f211a: Add --branch option and shorthand flags (-g, -d, -t, -b) to CLI for easier command usage.
+
 ## 0.0.2-beta.0
 
 ### Patch Changes

package/README.md

@@ -127,48 +127,56 @@ This is useful when:
 
 All commands (`init`, `add`, and `update`) require:
 
-- `--git-url <url>` - **(Required)** Git repository URL or local path to the template
+- `-g, --git-url <url>` - **(Required)** Git repository URL or local path to the template
   - Example: `https://github.com/user/wp-template.git`
   - Example: `/path/to/local/template`
   - Example: `.` (current directory for local development)
 
-- `--directory <path>` - **(Required)** Target/project directory
+- `-d, --directory <path>` - **(Required)** Target/project directory
   - **Must end with `-server`** for safety (e.g., `my-project-server`)
   - Example: `./my-project-server`
   - Example: `/absolute/path/to/project-server`
 
 Optional:
 
-- `--template-dir <path>` - Template source directory within the repository (defaults to `repo_template`)
+- `-t, --template-dir <path>` - Template source directory within the repository (defaults to `repo_template`)
+- `-b, --branch <name>` - Git branch to clone from (defaults to `master`)
+
 
 ## Examples
 
 ### Initialise from a remote repository
 ```bash
 npx @pugpigjs/create-wp-project init \
-  --git-url https://github.com/your-org/your-wp-template.git \
-  --directory ./my-project-server
+  -g https://github.com/your-org/your-wp-template.git \
+  -d ./my-project-server
 ```
 
 ### Initialise from a local template (for development)
 ```bash
+npx @pugpigjs/create-wp-project init -g . -d ./test-server
+```
+
+### Initialise from a specific branch
+```bash
 npx @pugpigjs/create-wp-project init \
-  --git-url . \
-  --directory ./test-server
+  -g https://github.com/your-org/your-wp-template.git \
+  -d ./my-project-server \
+  -b beta
 ```
 
 ### Add another template to existing project
 ```bash
 npx @pugpigjs/create-wp-project add \
-  --git-url https://github.com/your-org/your-wp-template.git \
-  --directory ./my-project-server
+  -g https://github.com/your-org/your-wp-template.git \
+  -d ./my-project-server
 ```
 
 ### Update configuration files
 ```bash
 npx @pugpigjs/create-wp-project update \
-  --git-url https://github.com/your-org/your-wp-template.git \
-  --directory ./my-project-server
+  -g https://github.com/your-org/your-wp-template.git \
+  -d ./my-project-server
 ```
 
 ## Safety Features
@@ -216,19 +224,16 @@ For local development and testing from within this repository:
 
 ```bash
 # From the repository root
-node packages/create-wp-project/src/cli.js init \
-  --git-url . \
-  --directory ./test-server
+node packages/create-wp-project/src/cli.js init -g . -d ./test-server
 
 # Or test the add command
-node packages/create-wp-project/src/cli.js add \
-  --git-url . \
-  --directory ./test-server
+node packages/create-wp-project/src/cli.js add -g . -d ./test-server
 
 # Or test the update command
-node packages/create-wp-project/src/cli.js update \
-  --git-url . \
-  --directory ./test-server
+node packages/create-wp-project/src/cli.js update -g . -d ./test-server
+
+# Test with a specific branch
+node packages/create-wp-project/src/cli.js init -g . -d ./test-server -b beta
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pugpigjs/create-wp-project",
-  "version": "0.0.2-beta.0",
+  "version": "0.0.2-beta.1",
   "description": "CLI tool to scaffold WordPress plugins and themes from a template repo.",
   "type": "module",
   "bin": {

package/src/cli.js

@@ -17,16 +17,18 @@ program
   .command('init')
   .description('Initialise a new WordPress project from the template')
   .requiredOption('-d, --directory <path>', 'Target directory (must end with -server)')
-  .requiredOption('--git-url <url>', 'Git repository URL or local path to template')
-  .option('--template-dir <path>', 'Template source directory', 'repo_template')
+  .requiredOption('-g, --git-url <url>', 'Git repository URL or local path to template')
+  .option('-t, --template-dir <path>', 'Template source directory', 'repo_template')
+  .option('-b, --branch <name>', 'Git branch to clone from', 'master')
   .action(initProject)
 
 program
   .command('add')
   .description('Add another plugin or theme to an existing project')
   .requiredOption('-d, --directory <path>', 'Project directory (must end with -server)')
-  .requiredOption('--git-url <url>', 'Git repository URL or local path to template')
-  .option('--template-dir <path>', 'Template source directory', 'repo_template')
+  .requiredOption('-g, --git-url <url>', 'Git repository URL or local path to template')
+  .option('-t, --template-dir <path>', 'Template source directory', 'repo_template')
+  .option('-b, --branch <name>', 'Git branch to clone from', 'master')
   .action(addTemplate)
 
 program
@@ -39,8 +41,9 @@ program
   .command('update')
   .description('Update root configuration files from the template')
   .requiredOption('-d, --directory <path>', 'Project directory (must end with -server)')
-  .requiredOption('--git-url <url>', 'Git repository URL or local path to template')
-  .option('--template-dir <path>', 'Template source directory', 'repo_template')
+  .requiredOption('-g, --git-url <url>', 'Git repository URL or local path to template')
+  .option('-t, --template-dir <path>', 'Template source directory', 'repo_template')
+  .option('-b, --branch <name>', 'Git branch to clone from', 'master')
   .action(updateProject)
 
 program.parse()

package/src/commands/add.js

@@ -108,7 +108,7 @@ export async function addTemplate(options) {
 
   try {
     // Step 1: Clone repository
-    await cloneRepo(options.gitUrl, tempDir)
+    await cloneRepo(options.gitUrl, tempDir, options.branch)
 
     // Step 2: Copy selected template
     const spinner = ora(`Copying ${TEMPLATES[template].name} template...`).start()

package/src/commands/init.js

@@ -136,7 +136,7 @@ export async function initProject(options) {
 
   try {
     // Step 1: Clone repository
-    await cloneRepo(options.gitUrl, tempDir)
+    await cloneRepo(options.gitUrl, tempDir, options.branch)
 
     // Step 2: Copy root files from repo_template directory
     const templateRoot = path.join(tempDir, options.templateDir)

package/src/commands/update.js

@@ -146,7 +146,7 @@ export async function updateProject(options) {
 
   try {
     // Clone repository to get latest templates
-    await cloneRepo(options.gitUrl, tempDir)
+    await cloneRepo(options.gitUrl, tempDir, options.branch)
 
     const templateRoot = path.join(tempDir, options.templateDir)
 

package/src/utils/shared.js

@@ -116,8 +116,9 @@ export const prompts = {
  * Clone the git repository to a temporary directory, or copy from local path
  * @param {string} gitUrlOrPath - Git URL or local filesystem path
  * @param {string} tempDir - Temporary directory to clone/copy into
+ * @param {string} branch - Git branch to clone (optional, defaults to remote's default branch)
  */
-export async function cloneRepo(gitUrlOrPath, tempDir) {
+export async function cloneRepo(gitUrlOrPath, tempDir, branch = null) {
   // Check if it's a local path
   const isLocalPath = !gitUrlOrPath.startsWith('http://') &&
                       !gitUrlOrPath.startsWith('https://') &&
@@ -136,11 +137,16 @@ export async function cloneRepo(gitUrlOrPath, tempDir) {
       throw error
     }
   } else {
-    const spinner = ora('Cloning template repository...').start()
+    const branchMsg = branch ? ` (branch: ${branch})` : ''
+    const spinner = ora(`Cloning template repository${branchMsg}...`).start()
     try {
       const git = simpleGit()
-      await git.clone(gitUrlOrPath, tempDir, ['--depth', '1'])
-      spinner.succeed('Template repository cloned')
+      const cloneOptions = ['--depth', '1']
+      if (branch) {
+        cloneOptions.push('--branch', branch)
+      }
+      await git.clone(gitUrlOrPath, tempDir, cloneOptions)
+      spinner.succeed(`Template repository cloned${branchMsg}`)
     } catch (error) {
       spinner.fail('Failed to clone repository')
       throw error
@@ -328,7 +334,7 @@ export async function cleanup(tempDir) {
 }
 
 /**
- * Display next steps after project initialization or template addition
+ * Display next steps after project initialisation or template addition
  * @param {string} targetDir - The target directory where files were created
  * @param {string} projectName - The project name
  * @param {string} templateType - The template type key