@pugpigjs/create-wp-project 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +11 -11
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ CLI tool to scaffold WordPress plugins and themes from a template repo.
|
|
|
7
7
|
The easiest way to scaffold a new WordPress project:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npm create @pugpigjs/wp-project -- init --git-url <repository-url> --directory <target-directory>
|
|
10
|
+
npm create @pugpigjs/wp-project@latest -- init --git-url <repository-url> --directory <target-directory>
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
**Note:** Both `--git-url` and `--directory` are required for all commands.
|
|
@@ -63,7 +63,7 @@ The CLI automatically computes all these variations from your namespace and proj
|
|
|
63
63
|
### `init` - Initialise a New Project
|
|
64
64
|
|
|
65
65
|
```bash
|
|
66
|
-
npm create @pugpigjs/wp-project -- init --git-url <repository-url> --directory <target-directory>
|
|
66
|
+
npm create @pugpigjs/wp-project@latest -- init --git-url <repository-url> --directory <target-directory>
|
|
67
67
|
```
|
|
68
68
|
|
|
69
69
|
This interactive CLI will:
|
|
@@ -80,7 +80,7 @@ This interactive CLI will:
|
|
|
80
80
|
If you've already initialised a project and want to add another plugin or theme:
|
|
81
81
|
|
|
82
82
|
```bash
|
|
83
|
-
npm create @pugpigjs/wp-project -- add --git-url <repository-url> --directory <target-directory>
|
|
83
|
+
npm create @pugpigjs/wp-project@latest -- add --git-url <repository-url> --directory <target-directory>
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
This will:
|
|
@@ -96,7 +96,7 @@ This will:
|
|
|
96
96
|
To remove a plugin or theme from your project:
|
|
97
97
|
|
|
98
98
|
```bash
|
|
99
|
-
npm create @pugpigjs/wp-project -- remove --directory <target-directory>
|
|
99
|
+
npm create @pugpigjs/wp-project@latest -- remove --directory <target-directory>
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
This will:
|
|
@@ -112,7 +112,7 @@ This will:
|
|
|
112
112
|
To refresh configuration files (like bitbucket-pipelines.yml, renovate.json, etc.) from the latest template:
|
|
113
113
|
|
|
114
114
|
```bash
|
|
115
|
-
npm create @pugpigjs/wp-project -- update --git-url <repository-url> --directory <target-directory>
|
|
115
|
+
npm create @pugpigjs/wp-project@latest -- update --git-url <repository-url> --directory <target-directory>
|
|
116
116
|
```
|
|
117
117
|
|
|
118
118
|
This will:
|
|
@@ -160,7 +160,7 @@ You can set the following environment variable to simplify usage:
|
|
|
160
160
|
```
|
|
161
161
|
- After setting, you can omit the `-g` flag:
|
|
162
162
|
```bash
|
|
163
|
-
npm create @pugpigjs/wp-project -- init -d ./my-project-server
|
|
163
|
+
npm create @pugpigjs/wp-project@latest -- init -d ./my-project-server
|
|
164
164
|
```
|
|
165
165
|
|
|
166
166
|
|
|
@@ -168,19 +168,19 @@ You can set the following environment variable to simplify usage:
|
|
|
168
168
|
|
|
169
169
|
### Initialise from a remote repository
|
|
170
170
|
```bash
|
|
171
|
-
npm create @pugpigjs/wp-project -- init \
|
|
171
|
+
npm create @pugpigjs/wp-project@latest -- init \
|
|
172
172
|
-g https://github.com/your-org/your-wp-template.git \
|
|
173
173
|
-d ./my-project-server
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
### Initialise from a local template (for development)
|
|
177
177
|
```bash
|
|
178
|
-
npm create @pugpigjs/wp-project -- init -g . -d ./test-server
|
|
178
|
+
npm create @pugpigjs/wp-project@latest -- init -g . -d ./test-server
|
|
179
179
|
```
|
|
180
180
|
|
|
181
181
|
### Initialise from a specific branch
|
|
182
182
|
```bash
|
|
183
|
-
npm create @pugpigjs/wp-project -- init \
|
|
183
|
+
npm create @pugpigjs/wp-project@latest -- init \
|
|
184
184
|
-g https://github.com/your-org/your-wp-template.git \
|
|
185
185
|
-d ./my-project-server \
|
|
186
186
|
-b beta
|
|
@@ -188,14 +188,14 @@ npm create @pugpigjs/wp-project -- init \
|
|
|
188
188
|
|
|
189
189
|
### Add another template to existing project
|
|
190
190
|
```bash
|
|
191
|
-
npm create @pugpigjs/wp-project -- add \
|
|
191
|
+
npm create @pugpigjs/wp-project@latest -- add \
|
|
192
192
|
-g https://github.com/your-org/your-wp-template.git \
|
|
193
193
|
-d ./my-project-server
|
|
194
194
|
```
|
|
195
195
|
|
|
196
196
|
### Update configuration files
|
|
197
197
|
```bash
|
|
198
|
-
npm create @pugpigjs/wp-project -- update \
|
|
198
|
+
npm create @pugpigjs/wp-project@latest -- update \
|
|
199
199
|
-g https://github.com/your-org/your-wp-template.git \
|
|
200
200
|
-d ./my-project-server
|
|
201
201
|
```
|