Merge pull request #61 from dreamsicle-io/release/3.5.0

Release/3.5.0

Author: theenoahmason

.github/workflows/test.yml

@@ -56,4 +56,4 @@ jobs:
       # the path to `tests` and enable the `verbose` option for debugging.
       - name: Create Theme
         id: create_theme
-        run: npm test test-theme -- -v -f -P "tests" -N "Test Theme" -X "1.0.0" -T "parent-theme" -U "https://github.com/dreamsicle-io/test" -B "https://github.com/dreamsicle-io/test/issues" -R "git+ssh://git@github.com:dreamsicle-io/test.git" -r "git" -D "Just another WordPress theme." -A "Dreamsicle" -E "hello@dreamsicle.io" -u "https://www.dreamsicle.io" -L "gpl-3.0" -t "accessibility-ready,translation-ready" -W "6.1.0" -w "6.4.0" -F "test" -C "Test" -c "TEST" -e "testthemedev"
+        run: npm test test-theme -- -v -f -P "tests" -N "Test Theme" -X "1.0.0" -T "parent-theme" -U "https://github.com/dreamsicle-io/test" -B "https://github.com/dreamsicle-io/test/issues" -R "https://github.com/dreamsicle-io/test.git" -S "git@github.com:dreamsicle-io/test.git" -r "git" -D "Just another WordPress theme." -A "Dreamsicle" -E "hello@dreamsicle.io" -u "https://www.dreamsicle.io" -L "gpl-3.0" -t "accessibility-ready,translation-ready" -W "6.1.0" -w "6.4.0" -F "test" -C "Test" -c "TEST" -e "testthemedev"

README.md

@@ -37,7 +37,8 @@ Theme Name: (WP Theme)
 Template: ()
 Theme URI: (https://github.com/example/wp-theme)
 Theme Bugs URI: (https://github.com/example/wp-theme/issues)
-Theme Repository URI: (git+ssh://git@github.com:example/wp-theme.git)
+Theme Repository URI: (https://github.com/example/wp-theme.git)
+Theme Repository SSH: ()
 Theme Repository Type: (git)
 Description: (This theme was generated using create-wp-theme.)
 Author: (Example, INC.)
@@ -50,6 +51,7 @@ WP Version Tested: (6.0.0)
 Function Prefix: (wp_theme)
 Class Prefix: (WP_Theme)
 Constant Prefix: (WP_THEME)
+WP Engine Environment: (wpthemedev)
 ```
 
 > **Note:** Any promptable options that have values already provided by the user will not be prompted for. If the tool detects that all possible option values have already been provided by the user, it won't display the prompt, and will instead jump directly into creation.
@@ -70,7 +72,7 @@ The tool will log its progress and errors in the console, exiting on completion
 📄 License written ― LICENSE
 📚 Theme relocated ― tests\wp-theme
 📁 Repo initialized ― Repo type: "git"
-🔗 Remote repo added ― git+ssh://git@github.com:example/wp-theme.git
+🔗 Remote repo added ― git@github.com:example/wp-theme.git
 💾 Initial files committed ― [main (root-commit) 37be1d1] ― 56 files changed, 4276 insertions(+)
 
 🚀 Theme created ― Created "WP Theme" in tests\wp-theme
@@ -111,13 +113,14 @@ The tool will rename files and generate file contents if it detects placeholders
 
 ### File Content Replacement
 
-| Placeholder | Replacement              | Description                                 |
-| ----------- | ------------------------ | ------------------------------------------- | 
-| `wp-theme`  | `<dir>`                  | The kebab-cased directory argument.         |
-| `wp_theme`  | `-F`, `--functionPrefix` | The snake-cased function prefix option.     |
-| `WP_Theme`  | `-C`, `--classPrefix`    | The pascal-snake-cased class prefix option. |
-| `WP_THEME`  | `-c`, `--constantPrefix` | The constant-cased constant prefix option.  |
-| `WP Theme`  | `-N`, `--themeName`      | The unmodified theme name option.           |
+| Placeholder        | Replacement              | Description                                  |
+| -----------        | ------------------------ | -------------------------------------------- | 
+| `WP Theme`         | `-N`, `--themeName`      | The unmodified theme name option.            |
+| `wp_theme`         | `-F`, `--functionPrefix` | The snake-cased function prefix option.      |
+| `WP_THEME`         | `-c`, `--constantPrefix` | The constant-cased constant prefix option.   |
+| `WP_Theme`         | `-C`, `--classPrefix`    | The pascal-snake-cased class prefix option.  |
+| `class-wp-theme-*` | `-C`, `--classPrefix`    | The parsed class prefix option, kebab-cased. |
+| `wp-theme`         | `<dir>`                  | The kebab-cased directory argument.          |
 
 ### File Renaming
 
@@ -158,7 +161,8 @@ Options:
   -T, --themeTemplate [string]      The parent theme if this is a child theme (default: "")
   -U, --themeURI <string>           The theme URI (default: "https://github.com/example/wp-theme")
   -B, --themeBugsURI <string>       The theme bugs URI (default: "https://github.com/example/wp-theme/issues")
-  -R, --themeRepoURI <string>       The theme repository URI (default: "git+ssh://git@github.com:example/wp-theme.git")
+  -R, --themeRepoURI <string>       The theme repository HTTPS URI (default: "https://github.com/example/wp-theme.git")
+  -S, --themeRepoSSH [string]       The theme repository SSH URI (default: "")
   -r, --themeRepoType <string>      The theme repository type (default: "git")
   -D, --themeDescription <string>   The theme description (default: "This theme was generated using create-wp-theme.")
   -A, --themeAuthor <string>        The theme author (default: "Example, INC.")

index.js

@@ -21,6 +21,7 @@ import { Command } from 'commander';
  * @property {string} themeURI
  * @property {string} themeBugsURI
  * @property {string} themeRepoURI
+ * @property {string} themeRepoSSH
  * @property {string} themeRepoType
  * @property {string} themeDescription
  * @property {string} themeAuthor
@@ -198,13 +199,26 @@ const optionDefs = [
 		alias: 'R',
 		type: 'string',
 		title: 'Theme Repository URI',
-		description: 'The theme repository URI',
-		default: 'git+ssh://git@github.com:example/wp-theme.git',
+		description: 'The theme repository HTTPS URI',
+		default: 'https://github.com/example/wp-theme.git',
 		isRequired: true,
 		isPrompted: true,
+		sanitize: (value => {
+			return zod.string().trim().url().safeParse(value).data || '';
+		}),
+	},
+	{
+		key: 'themeRepoSSH',
+		alias: 'S',
+		type: 'string',
+		title: 'Theme Repository SSH',
+		description: 'The theme repository SSH URI',
+		default: '',
+		isRequired: false,
+		isPrompted: true,
 		sanitize: (value => {
 			// Parse this is a string rather than a URL, because the
-			// SSH repo URI format does not pass Zod URL validation.
+			// SSH URI format does not pass Zod URL validation.
 			return zod.string().trim().safeParse(value).data || '';
 		}),
 	},
@@ -923,10 +937,11 @@ function initGitRepo() {
 		data: stdoutInit.toString().trim(),
 	});
 	// Add remote origin.
-	const stdoutAddRemote = execSync(`git remote add origin ${options.themeRepoURI}`, { stdio: 'pipe' });
+	const remoteOrigin = options.themeRepoSSH || options.themeRepoURI;
+	const stdoutAddRemote = execSync(`git remote add origin ${remoteOrigin}`, { stdio: 'pipe' });
 	logInfo({
 		title: 'Remote repo added',
-		description: options.themeRepoURI,
+		description: remoteOrigin,
 		emoji: '🔗',
 		verbose: options.verbose,
 		dataLabel: 'Add remote response',

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dreamsicle.io/create-wp-theme",
-	"version": "3.4.1",
+	"version": "3.5.0",
 	"type": "module",
 	"description": "A command line tool for creating modern, optimized WordPress themes.",
 	"main": "index.js",
@@ -10,7 +10,7 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+ssh://git@github.com:dreamsicle-io/create-wp-theme.git"
+		"url": "https://github.com/dreamsicle-io/create-wp-theme.git"
 	},
 	"homepage": "https://github.com/dreamsicle-io/create-wp-theme",
 	"bugs": {