theme-juice 0.28.0 → 0.28.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9a776df3c544a31881c70f1bdd63fdc32ff50423
4
- data.tar.gz: c3b26a31fdfde2b1ce69a6ff44d4abb0f2fe5766
3
+ metadata.gz: 45986e3e185af0227b1519e087f5e788becedd96
4
+ data.tar.gz: b2db6200715f2a28eeaa369da9d5e70cb9d1f011
5
5
  SHA512:
6
- metadata.gz: a2c2fcde5aec836834b7fbe77faf5bc71187d14b24891f93506c77a9b8aba46eee3e645b95dba08acfafe6f11dd569122b6e31c47ee2609000a559bab1423c57
7
- data.tar.gz: bff98273a3d544cc258a500908857ba01d0cc54e112ccc1e1c41193dd9bf9633274912cf03b5e9625fe4ca0116a226948421ff72d9eaeb7485379dd390483fbf
6
+ metadata.gz: c8916cc2e1b45670d343a125006a047bd4450c28966347fe07c5214d195cdb452d589e2321be84da3b33ae2fb40f590ecc1b3a5dced4440333ff4d9196962fbc
7
+ data.tar.gz: 48951e85c92511d7f599c36d41439106cb6713d9ffcc192ca5af458116e99b1ee7c4acd079fae9567ce68175e0de2d9aca2909d2a8e4707f20a11fa9598ec6e8
data/README.md CHANGED
@@ -8,9 +8,9 @@
8
8
  ![Theme Juice CLI](demo.gif)
9
9
 
10
10
  ## What is it?
11
- The [Theme Juice CLI](http://themejuice.it), also known as `tj`, helps you create new local WordPress development sites, manage existing sites, and deploy them, all from the command line. It utilizes our [Graft VM](https://github.com/ezekg/graft) for the virtual machine to spin up new development sites in seconds.
11
+ The [Theme Juice CLI](http://cli.themejuice.it), also known as `tj`, helps you create new local WordPress development sites, manage existing sites, and deploy them, all from the command line. It utilizes our [Graft VM](https://github.com/ezekg/graft) for the virtual machine to spin up new development sites in seconds.
12
12
 
13
- Check out [our getting started guide over at SitePoint](http://www.sitepoint.com/introducing-theme-juice-for-local-wordpress-development/), or [view the documentation site](http://themejuice.it).
13
+ Check out [our getting started guide over at SitePoint](http://www.sitepoint.com/introducing-theme-juice-for-local-wordpress-development/), or [view the documentation site](http://cli.themejuice.it).
14
14
 
15
15
  ## What problems does `tj` help solve?
16
16
  To get the most out of `tj`, it is recommended that you use our [starter template](https://github.com/ezekg/theme-juice-starter). Why? Keep on reading and we'll tell you. `tj` is built on top of tried and true open source libraries such as [Capistrano](http://capistranorb.com/) for deployment, [Vagrant](https://www.vagrantup.com/) for local development, and even a little bit of [WP-CLI](http://wp-cli.org) for database migration. Some of the main pain points `tj` helps solve are:
@@ -91,7 +91,7 @@ tj delete
91
91
  ```
92
92
 
93
93
  ### Deploy a project
94
- After configuring your `Juicefile` and setting up SSH keys for yourself, this will deploy a project to the passed `<stage>` using [Capistrano](http://capistranorb.com/). Head over to the [docs](http://themejuice.it/deploy) to see all of the available commands. There's a quick getting started section there too for your first deployment!
94
+ After configuring your `Juicefile` and setting up SSH keys for yourself, this will deploy a project to the passed `<stage>` using [Capistrano](http://capistranorb.com/). Head over to the [docs](http://cli.themejuice.it/deploy) to see all of the available commands. There's a quick getting started section there too for your first deployment!
95
95
 
96
96
  ```
97
97
  tj deploy <stage>
@@ -104,7 +104,7 @@ Want to check out all of the various flags and features `tj` offers? Just ask `t
104
104
  tj help
105
105
  ```
106
106
 
107
- Or, you can also check out [themejuice.it](http://themejuice.it) for a pretty website chock-full of the same documentation provided by `tj help`.
107
+ Or, you can also check out [cli.themejuice.it](http://cli.themejuice.it) for a pretty website chock-full of the same documentation provided by `tj help`.
108
108
 
109
109
  ## FAQ
110
110
 
@@ -188,7 +188,7 @@ Yes and no; in order for `tj` to properly create a project, the Vagrant box need
188
188
  [It's a file that contains custom rules to add into the main `Vagrantfile`, without actually having to modify it](https://github.com/ezekg/graft/blob/master/Vagrantfile?ts=2). This allows us to easily modify the Vagrant box without causing merge conflicts if you were to update the VM source via `git pull`. Every file that `tj` modifies is _meant to be modified_, so at any time you may update your installation of Graft with a simple `git pull` without getting merge conflicts out the wazoo.
189
189
 
190
190
  ### What is a `Juicefile`?
191
- A YAML configuration file called a `Juicefile` can be used to store commonly-used build scripts, similar to [npm scripts](https://docs.npmjs.com/misc/scripts). Each command can be mapped to any build script you like, allowing you to define a set of commands that can be used across all of your projects. If you plan to deploy using `tj`, this file will also house your [deployment configuration](http://themejuice.it/deploy).
191
+ A YAML configuration file called a `Juicefile` can be used to store commonly-used build scripts, similar to [npm scripts](https://docs.npmjs.com/misc/scripts). Each command can be mapped to any build script you like, allowing you to define a set of commands that can be used across all of your projects. If you plan to deploy using `tj`, this file will also house your [deployment configuration](http://cli.themejuice.it/deploy).
192
192
 
193
193
  For reference, below is an example config: (see the config for our starter template, [Sprout](https://github.com/ezekg/theme-juice-starter))
194
194
 
@@ -28,7 +28,7 @@ Force IP address of VM*
28
28
  Force directory prefix for project in VM*
29
29
  .
30
30
  .TP
31
- \fB\-\-vm\-revision\fR
31
+ \fB\-\-vm\-revision\fR=\fIrevision\fR
32
32
  Revision hash or branch to checkout for VM (default is master)
33
33
  .
34
34
  .TP
@@ -37,7 +37,7 @@ Run Juicefile(5) commands from the passed path instead of from the current direc
37
37
  .
38
38
  .TP
39
39
  \fB\-\-from\-srv\fR, \fB\-\-in\-srv\fR=\fIpath\fR
40
- Run Juicefile(5) commands from the passed srv path instead of from the current host directory path when using the \fB\-\-inside\-vm\fR flag\.
40
+ Run Juicefile(5) commands from the passed srv path instead of from the current host directory\.
41
41
  .
42
42
  .TP
43
43
  \fB\-\-inside\-vm\fR, \fB\-\-in\-vm\fR
@@ -266,77 +266,64 @@ will be replaced with,
266
266
  .P
267
267
  if those were the options chosen during a creation\. The following variables are available for use:
268
268
  .
269
- .TP
270
- \fBname\fR
271
- Project name
269
+ .IP "\(bu" 4
270
+ \fBname\fR: Project name
272
271
  .
273
- .TP
274
- \fBlocation\fR
275
- Project location
272
+ .IP "\(bu" 4
273
+ \fBlocation\fR: Project location
276
274
  .
277
- .TP
278
- \fBurl\fR
279
- Project URL
275
+ .IP "\(bu" 4
276
+ \fBurl\fR: Project URL
280
277
  .
281
- .TP
282
- \fBxip_url\fR
283
- Project xip\.io URL
278
+ .IP "\(bu" 4
279
+ \fBxip_url\fR: Project xip\.io URL
284
280
  .
285
- .TP
286
- \fBtemplate\fR
287
- Project template repository URL
281
+ .IP "\(bu" 4
282
+ \fBtemplate\fR: Project template repository URL
288
283
  .
289
- .TP
290
- \fBrepository\fR
291
- Initialized repository URL, if available
284
+ .IP "\(bu" 4
285
+ \fBrepository\fR: Initialized repository URL, if available
292
286
  .
293
- .TP
294
- \fBdb_host\fR
295
- Project database host
287
+ .IP "\(bu" 4
288
+ \fBdb_host\fR: Project database host
296
289
  .
297
- .TP
298
- \fBdb_name\fR
299
- Project database name
290
+ .IP "\(bu" 4
291
+ \fBdb_name\fR: Project database name
300
292
  .
301
- .TP
302
- \fBdb_user\fR
303
- Project database user
293
+ .IP "\(bu" 4
294
+ \fBdb_user\fR: Project database user
304
295
  .
305
- .TP
306
- \fBdb_pass\fR
307
- Project database password
296
+ .IP "\(bu" 4
297
+ \fBdb_pass\fR: Project database password
308
298
  .
309
- .TP
310
- \fBdb_import\fR
311
- Path to imported database file
299
+ .IP "\(bu" 4
300
+ \fBdb_import\fR: Path to imported database file
312
301
  .
313
- .TP
314
- \fBvm_box\fR
315
- Virtual machine box URL
302
+ .IP "\(bu" 4
303
+ \fBvm_box\fR: Virtual machine box URL
316
304
  .
317
- .TP
318
- \fBvm_ip\fR
319
- Virtual machine IP address
305
+ .IP "\(bu" 4
306
+ \fBvm_ip\fR: Virtual machine IP address
320
307
  .
321
- .TP
322
- \fBvm_path\fR
323
- Virtual machine location on the host machine
308
+ .IP "\(bu" 4
309
+ \fBvm_revision\fR Revision hash or branch to checkout for VM
324
310
  .
325
- .TP
326
- \fBvm_root\fR
327
- Web root of the VM on the host machine
311
+ .IP "\(bu" 4
312
+ \fBvm_path\fR: Virtual machine location on the host machine
328
313
  .
329
- .TP
330
- \fBvm_location\fR
331
- Project location within the VM on the host machine
314
+ .IP "\(bu" 4
315
+ \fBvm_root\fR: Web root of the VM on the host machine
332
316
  .
333
- .TP
334
- \fBvm_srv\fR
335
- Project location within the VM on the guest machine
317
+ .IP "\(bu" 4
318
+ \fBvm_location\fR: Project location within the VM on the host machine
336
319
  .
337
- .TP
338
- \fBvm_prefix\fR
339
- Virtual machine project location prefix
320
+ .IP "\(bu" 4
321
+ \fBvm_srv\fR: Project location within the VM on the guest machine
322
+ .
323
+ .IP "\(bu" 4
324
+ \fBvm_prefix\fR: Virtual machine project location prefix
325
+ .
326
+ .IP "" 0
340
327
  .
341
328
  .SH "ENVIRONMENT"
342
329
  All of the global options have a corresponding \fBENV\fR variable that can be set to permanently use the specified value each time tj(1) is run\. This is useful if you\'re using an alternate vagrant(1) box, or if you need to disable certain features due to limited support i\.e\. on Windows\.
@@ -346,18 +333,34 @@ All of the global options have a corresponding \fBENV\fR variable that can be se
346
333
  Force vagrant(1) box for use as VM
347
334
  .
348
335
  .TP
349
- \fBTJ_PATH\fR=\fIpath\fR
336
+ \fBTJ_VM_PATH\fR=\fIpath\fR
350
337
  Force path to VM
351
338
  .
352
339
  .TP
353
- \fBTJ_IP\fR=\fIip\fR
340
+ \fBTJ_VM_IP\fR=\fIip\fR
354
341
  Force IP address of VM
355
342
  .
356
343
  .TP
357
- \fBTJ_PREFIX\fR=\fIstring\fR
344
+ \fBTJ_VM_REVISION\fR=\fIrevision\fR
345
+ Revision hash or branch to checkout for VM (default is master)
346
+ .
347
+ .TP
348
+ \fBTJ_VM_PREFIX\fR=\fIstring\fR
358
349
  Force directory prefix for project in VM
359
350
  .
360
351
  .TP
352
+ \fBTJ_FROM_PATH\fR=\fIpath\fR
353
+ Run Juicefile(5) commands from the passed path instead of from the current directory\.
354
+ .
355
+ .TP
356
+ \fBTJ_FROM_SRV\fR=\fIpath\fR
357
+ Run Juicefile(5) commands from the passed srv path instead of from the current host directory path\.
358
+ .
359
+ .TP
360
+ \fBTJ_INSIDE_VM\fR=\fIbool\fR
361
+ Run Juicefile(5) commands from inside of the virtual machine instead of your host machine\.
362
+ .
363
+ .TP
361
364
  \fBTJ_YOLO\fR=\fIbool\fR
362
365
  Say yes to anything and everything, and maybe even get a few surprises
363
366
  .
@@ -59,7 +59,7 @@ Location of the local project
59
59
  Starter template to install
60
60
  .
61
61
  .TP
62
- \fB\-\-template\-revision\fR, \fB\-\-template\-branch\fR
62
+ \fB\-\-template\-revision\fR, \fB\-\-template\-branch\fR=\fIrevision\fR
63
63
  Revision hash or branch to checkout for starter template (default is master)
64
64
  .
65
65
  .TP
@@ -49,7 +49,7 @@ GLOBAL OPTIONS
49
49
  -t, --template=repository
50
50
  Starter template to install
51
51
 
52
- --template-revision, --template-branch
52
+ --template-revision, --template-branch=revision
53
53
  Revision hash or branch to checkout for starter template
54
54
  (default is master)
55
55
 
@@ -21,7 +21,7 @@ GLOBAL OPTIONS
21
21
  --vm-prefix=string
22
22
  Force directory prefix for project in VM*
23
23
 
24
- --vm-revision
24
+ --vm-revision=revision
25
25
  Revision hash or branch to checkout for VM (default is master)
26
26
 
27
27
  --from-path, --in-path=path
@@ -30,15 +30,14 @@ GLOBAL OPTIONS
30
30
 
31
31
  --from-srv, --in-srv=path
32
32
  Run Juicefile(5) commands from the passed srv path instead of
33
- from the current host directory path when using the --inside-vm
34
- flag.
33
+ from the current host directory.
35
34
 
36
35
  --inside-vm, --in-vm
37
- Run Juicefile(5) commands from inside of the virtual machine
36
+ Run Juicefile(5) commands from inside of the virtual machine
38
37
  instead of your host machine.
39
38
 
40
39
  --yolo, --yes
41
- Say yes to anything and everything, and maybe even get a few
40
+ Say yes to anything and everything, and maybe even get a few
42
41
  surprises
43
42
 
44
43
  --boring
@@ -113,16 +112,16 @@ SECONDARY COMMANDS
113
112
  List all projects
114
113
 
115
114
  vm, vagrant, vvv=[command[,command]...]
116
- Manage development environment via vagrant(1). Commands are
117
- proxied to your Vagrant installation so that they can be run
115
+ Manage development environment via vagrant(1). Commands are
116
+ proxied to your Vagrant installation so that they can be run
118
117
  from any directory.
119
118
 
120
119
  CONFIG FILE
121
- A YAML configuration file called a Juicefile(5) can be used to store
122
- commonly used build scripts, similar to npm(1) scripts. Each command
123
- can be mapped to any build script you like, allowing you to define a
124
- set of commands that can be used across all of your projects. If you
125
- plan to deploy using tj, this file will also house your deploy(1) con-
120
+ A YAML configuration file called a Juicefile(5) can be used to store
121
+ commonly used build scripts, similar to npm(1) scripts. Each command
122
+ can be mapped to any build script you like, allowing you to define a
123
+ set of commands that can be used across all of your projects. If you
124
+ plan to deploy using tj, this file will also house your deploy(1) con-
126
125
  figuration.
127
126
 
128
127
  For reference, below is an example config:
@@ -174,8 +173,8 @@ CONFIG COMMANDS
174
173
  dev, which will in turn run the command grunt.
175
174
 
176
175
  If you noticed in the example above, there are a few commands that con-
177
- tain %args%; each command list is run within a single execution via
178
- joining: cmd1 && cmd2 [&& cmd3...], with all %args%/%argN% being
176
+ tain %args%; each command list is run within a single execution via
177
+ joining: cmd1 && cmd2 [&& cmd3...], with all %args%/%argN% being
179
178
  replaced with the corresponding argument index, when available.
180
179
 
181
180
  Here's a few example commands using placeholders:
@@ -192,16 +191,16 @@ CONFIG COMMANDS
192
191
 
193
192
 
194
193
 
195
- To clarify a little bit more, we could run tj dev build, and since our
196
- dev command contains %args%, that will in turn run the command grunt
197
- build; if we run tj dev some:other task, that would be interpreted and
194
+ To clarify a little bit more, we could run tj dev build, and since our
195
+ dev command contains %args%, that will in turn run the command grunt
196
+ build; if we run tj dev some:other task, that would be interpreted and
198
197
  run as grunt some:other task.
199
198
 
200
- You can specify an unlimited number of commands with an unlimited num-
201
- ber of arguments within your Juicefile; however, you should be careful
202
- with how this is used. Don't go including sudo rm -rf %arg1% in a com-
203
- mand, while passing / as an argument. Keep it simple. These are meant
204
- to make your life easier by helping you manage build tools, not to do
199
+ You can specify an unlimited number of commands with an unlimited num-
200
+ ber of arguments within your Juicefile; however, you should be careful
201
+ with how this is used. Don't go including sudo rm -rf %arg1% in a com-
202
+ mand, while passing / as an argument. Keep it simple. These are meant
203
+ to make your life easier by helping you manage build tools, not to do
205
204
  fancy scripting.
206
205
 
207
206
  CONFIG TEMPLATE STRINGS
@@ -233,73 +232,79 @@ CONFIG TEMPLATE STRINGS
233
232
  if those were the options chosen during a creation. The following vari-
234
233
  ables are available for use:
235
234
 
236
- name Project name
235
+ o name: Project name
236
+
237
+ o location: Project location
238
+
239
+ o url: Project URL
240
+
241
+ o xip_url: Project xip.io URL
237
242
 
238
- location
239
- Project location
243
+ o template: Project template repository URL
240
244
 
241
- url Project URL
245
+ o repository: Initialized repository URL, if available
242
246
 
243
- xip_url
244
- Project xip.io URL
247
+ o db_host: Project database host
245
248
 
246
- template
247
- Project template repository URL
249
+ o db_name: Project database name
248
250
 
249
- repository
250
- Initialized repository URL, if available
251
+ o db_user: Project database user
251
252
 
252
- db_host
253
- Project database host
253
+ o db_pass: Project database password
254
254
 
255
- db_name
256
- Project database name
255
+ o db_import: Path to imported database file
257
256
 
258
- db_user
259
- Project database user
257
+ o vm_box: Virtual machine box URL
260
258
 
261
- db_pass
262
- Project database password
259
+ o vm_ip: Virtual machine IP address
263
260
 
264
- db_import
265
- Path to imported database file
261
+ o vm_revision Revision hash or branch to checkout for VM
266
262
 
267
- vm_box Virtual machine box URL
263
+ o vm_path: Virtual machine location on the host machine
268
264
 
269
- vm_ip Virtual machine IP address
265
+ o vm_root: Web root of the VM on the host machine
270
266
 
271
- vm_path
272
- Virtual machine location on the host machine
267
+ o vm_location: Project location within the VM on the host machine
273
268
 
274
- vm_root
275
- Web root of the VM on the host machine
269
+ o vm_srv: Project location within the VM on the guest machine
276
270
 
277
- vm_location
278
- Project location within the VM on the host machine
271
+ o vm_prefix: Virtual machine project location prefix
279
272
 
280
- vm_srv Project location within the VM on the guest machine
281
273
 
282
- vm_prefix
283
- Virtual machine project location prefix
284
274
 
285
275
  ENVIRONMENT
286
276
  All of the global options have a corresponding ENV variable that can be
287
277
  set to permanently use the specified value each time tj(1) is run. This
288
- is useful if you're using an alternate vagrant(1) box, or if you need
278
+ is useful if you're using an alternate vagrant(1) box, or if you need
289
279
  to disable certain features due to limited support i.e. on Windows.
290
280
 
291
281
  TJ_VM_BOX=repository
292
282
  Force vagrant(1) box for use as VM
293
283
 
294
- TJ_PATH=path
284
+ TJ_VM_PATH=path
295
285
  Force path to VM
296
286
 
297
- TJ_IP=ip
287
+ TJ_VM_IP=ip
298
288
  Force IP address of VM
299
289
 
300
- TJ_PREFIX=string
290
+ TJ_VM_REVISION=revision
291
+ Revision hash or branch to checkout for VM (default is master)
292
+
293
+ TJ_VM_PREFIX=string
301
294
  Force directory prefix for project in VM
302
295
 
296
+ TJ_FROM_PATH=path
297
+ Run Juicefile(5) commands from the passed path instead of from
298
+ the current directory.
299
+
300
+ TJ_FROM_SRV=path
301
+ Run Juicefile(5) commands from the passed srv path instead of
302
+ from the current host directory path.
303
+
304
+ TJ_INSIDE_VM=bool
305
+ Run Juicefile(5) commands from inside of the virtual machine
306
+ instead of your host machine.
307
+
303
308
  TJ_YOLO=bool
304
309
  Say yes to anything and everything, and maybe even get a few
305
310
  surprises
@@ -51,7 +51,7 @@ namespace :dir do
51
51
  end
52
52
  else
53
53
  on roles(:app) do
54
- upload! args[:dir], release_path.join(Pathname.new(args[:dir]).parent), {
54
+ upload! args[:dir], release_path.join(Pathname.new(args[:dir]).parent.to_s), {
55
55
  recursive: true
56
56
  }
57
57
  end
@@ -84,7 +84,7 @@ namespace :dir do
84
84
  end
85
85
  else
86
86
  on roles(:app) do
87
- download! release_path.join(args[:dir]), Pathname.new(args[:dir]).parent, {
87
+ download! release_path.join(args[:dir]), Pathname.new(args[:dir]).parent.to_s, {
88
88
  recursive: true
89
89
  }
90
90
  end
@@ -31,6 +31,7 @@ module ThemeJuice
31
31
  else
32
32
  cmds << "git checkout master"
33
33
  end
34
+ cmds << "git pull"
34
35
  end
35
36
  end
36
37
  end
@@ -1,5 +1,5 @@
1
1
  # encoding: UTF-8
2
2
 
3
3
  module ThemeJuice
4
- VERSION = "0.28.0"
4
+ VERSION = "0.28.1"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: theme-juice
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.28.0
4
+ version: 0.28.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ezekiel Gabrielse
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-08-15 00:00:00.000000000 Z
11
+ date: 2016-08-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: thor