theme-juice 0.7.13 → 0.7.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9eb3ca4662552ce5f2cb74bd324ee62cb727f89
-  data.tar.gz: c60afebc30567f86d9b38de0e996b15d8a23d7d4
+  metadata.gz: 7ed570de1bcd5ee6386340c1e7fbfcf78e3f925f
+  data.tar.gz: ea4347cfbae407def5d4e3e08dcfaf36e0b2df50
 SHA512:
-  metadata.gz: 2722df7ef800dd9e6420af9e0ecc34bac0e187ac651c63d62291bf6adf20694fbf1eda8b625a3a4a6144b7441b4c15e4e07c09c6ad8c6c247125a8d97b9fd7a7
-  data.tar.gz: d06729bceb72aa5ed54286112f7fce7d46e2e43e04a36b460cc3351e4bf5358509e6f91a4624b3df77ee23a8a6bb4e655454ed35f87940380222c3ddcce600fe
+  metadata.gz: 9fdf9dcd399513e6fcab32b505831207c9f346bc90c74385706890e141b49e61ffd8ca3b8fa2004e52087a9debf4659183646e8300b6db5174e31de0fad5dd6c
+  data.tar.gz: 9659e9842b6f24ef06947590ac048a9eb2a731f928e0a4b01b7248f73ba6325acad8ad3a0e72056d8bee10b9587812d22c71df02d0b882fc64e012178879f084

data/README.md

@@ -5,13 +5,39 @@
 [![Code Climate](https://img.shields.io/codeclimate/coverage/github/ezekg/theme-juice-cli.svg?style=flat-square)]()
 [![GitHub license](https://img.shields.io/github/license/ezekg/theme-juice-cli.svg?style=flat-square)](https://github.com/ezekg/theme-juice-cli/blob/master/LICENSE)
 
-What is it? Theme Juice is a WordPress development command line utility that allows you to scaffold out entire Vagrant development environments in seconds (using [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) as the VM), manage dependencies and build tools, and even handle deployments.
+## What is it?
+Theme Juice is a WordPress development command line utility that allows you to scaffold out entire Vagrant development environments in seconds (using [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) as the VM), manage dependencies and build tools, and even handle deployments.
+
+### But Why?
+This project sprung out of an annoyance for the current workflow associated with WordPress and development in general. Things like:
+* Local development. It's insanely hard (and intimidating!) for non-ops/CS engineers.
+* WAMP/LAMP sucks.
+* The local env setup process is monotonous. It's the same thing _over and over again_, aside from a couple variables here and there.
+* It seems as though every few months a new build tool comes out, so you end up with projects created within the range of just a year or 2 having _completely_ different build tools. Does this project use Grunt? Guard? Oh, I see, it's using Gulp! No thanks.
+* Dependency management for WordPress is terrible.
+* A decent Git workflow for WordPress is even more terrible. Bloated repositories, out of date plugins, out of date core. It's a nightmare.
+* Given all of that, projects are hard to maintain, especially across multiple environments. It's hard to onboard new team members. It just sucks.
+
+In order to remedy most of those, I created a little Rake script that automated things like scaffolding out a new development site and also aliasing a few of the build tools that I used. A couple months later, I extracted that out to a little gem so that it didn't have to sit inside of a `Rakefile` (mainly because it utilized the oh-so-efficient copy-and-paste update method).
+
+After using it for a few more months, adding features here and there, I realized how much it had changed my workflow. I was spending less time fighting the tools I wanted to use, and more time on our projects doing what I love (coding!). It sped up our workflow and made coding more enjoyable. The project really started to evolve into a true command line utility from there.
+
+Another month or so down the line, I wanted to move `tj` out of alpha and really give it the attention and structure it deserved. So I spent a few more months doing a complete rewrite, learning a ton along the way. I bought a few books like [Design Patterns in Ruby](http://designpatternsinruby.com/) and gradually built up my Ruby skills. One thing I really wanted to focus on was _convention over configuration_, because most people don't care about the details; they want a local development site _that just works_.
+
+Fast forward to now, and `tj` has become a staple for our WordPress development. It really has changed the way we do things. Enjoy.
 
 ## Installation
 * First, install [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) for local development.
-* Then, install [Composer](https://getcomposer.org/) and [WP-CLI](http://wp-cli.org/), and make sure they're executable.
+* Then, install these command line tools (most starter themes will use a combination of these):
+  * [Composer](https://getcomposer.org/)
+  * [NPM](https://www.npmjs.com/) ([Here's a good guide on properly installing NPM to not need `sudo`](http://www.johnpapa.net/how-to-use-npm-global-without-sudo-on-osx/))
+  * [Grunt-CLI](http://gruntjs.com/)
+  * [Gulp-CLI](http://gulpjs.com/)
+  * [Bower](http://bower.io/)
+  * [WP-CLI](http://wp-cli.org/)
+  * Make sure they're executable without `sudo`
 * Finally, install with: `gem install theme-juice`
-That`s it!
+* That's it!
 
 ## Windows users
 Since Windows doesn't support UTF-8 characters inside of the terminal, and is picky about colors, you'll have to run `tj` with a couple flags. What has worked for me on my Windows machine at home is to run all commands through [git-scm](http://git-scm.com/downloads) with the `--boring --no-landrush` flags.
@@ -28,12 +54,16 @@ In addition to that, `tj` uses the [OS gem](https://github.com/rdp/os) to sniff
 ## Config
 Because everybody likes to use different tools, you can create a `Juicefile` or `tj.yaml` config (with an optional preceding `.`) that will house all of your theme-specific commands. This allows you to use a streamlined set of commands that will act as aliases to your per-project configuration, as well as starter-theme specific information, such as deployment configuration, etc. For right now, we'll just stick to the `commands` section.
 
-If you're into [Grunt](https://github.com/gruntjs/grunt), then use it. Prefer [Guard](https://github.com/guard/guard)? Go right ahead. This is obviously relative to the starter theme you use, since you can't exactly use Grunt with a project that doesn't support it. Below is the config that comes baked into [our starter theme](https://github.com/ezekg/theme-juice-starter):
+If you're into [Grunt](https://github.com/gruntjs/grunt), then use it. Prefer [Gulp](https://github.com/gulpjs/gulp)? What about [Guard](https://github.com/guard/guard)? Go right ahead. It's compeletely up to you and your team. This is obviously relative to the starter theme you use, since you can't exactly use Grunt with a project that doesn't support it.
+
+Below is the config that comes baked into [our starter theme](https://github.com/ezekg/theme-juice-starter):
 
 ```yml
 commands:
   install:
     - composer install
+    - npm install
+    - bower install
     - grunt build
   watch:
     - grunt %args%
@@ -94,7 +124,7 @@ _Use `ENV` variables to set global flags. For example, by running `export TJ_VM_
 ### Creating a new development project:
 Use this to create a new project. It will automagically set up your VM, including a local development site at `http://<url>.dev` with WordPress installed and a fresh WP database. It will sync up your local site installation with the Vagrant VM, so you can organize your projects however you want. This task will also install VVV into your `vm-path` directory if it has not already been installed.
 ```bash
-tj create # Aliases: mk make new add
+tj create # Aliases: mk new
 ```
 
 #### Option flags:
@@ -116,7 +146,7 @@ tj create # Aliases: mk make new add
 ### Setting up an existing project:
 Use this to setup an existing local project within the development environment. You will go through the setup process to create the necessary files for the VM, including `vvv-hosts`, `vvv-nginx.conf`, DNS settings, and a fresh database (unless one already exists by the name chosen). This is essentially an alias for `create`, but with a few options being skipped.
 ```bash
-tj setup # Aliases: up prep init
+tj setup # Aliases: up init
 ```
 
 #### Option flags:
@@ -136,7 +166,7 @@ tj setup # Aliases: up prep init
 ### Deleting a project from the VM:
 Use this to remove a project from your development environment. This will only remove files that were generated by `tj`. including the database setup, development url, and shared directories. _It will not touch your local folders that were synced to the VM._
 ```bash
-tj delete # Aliases: rm remove trash teardown
+tj delete # Aliases: rm remove trash
 ```
 
 #### Option flags:
@@ -148,9 +178,8 @@ tj delete # Aliases: rm remove trash teardown
 | `[--vm-restart]`    | Bool   | Restart VM after deletion       |
 
 ### Managing deployment and migration (coming soon):
-Use this to easily manage your deployment and migration with [Capistrano](https://github.com/capistrano/capistrano) or whatever command is in your config. This is just a wrapper for your chosen command.
 ```bash
-tj deploy # Aliases: deployer server remote
+tj deploy # Aliases: server remote
 ```
 
 ### Listing all `tj` projects in the VM:
@@ -168,19 +197,19 @@ tj vm # Aliases: vagrant vvv
 ### Running installation for project:
 Uses `install` command within your config.
 ```bash
-tj install
+tj install # Aliases: build
 ```
 
 ### Watching and compiling assets:
 Use this to watch and compile assets with your preferred build tool, whether that be [Grunt](https://github.com/gruntjs/grunt), [Gulp](https://github.com/gulpjs/gulp), [Guard](https://github.com/guard/guard), or whatever. This is simply a wrapper for whatever command is in your config file.
 ```bash
-tj watch # Aliases: assets dev build
+tj watch # Aliases: dev
 ```
 
 ### Managing vendor dependencies:
 Use this to easily manage your dependencies with [Composer](https://github.com/composer/composer), or whatever command you set within your config.
 ```bash
-tj vendor # Aliases: dependencies deps
+tj vendor # Aliases: deps
 ```
 
 ### Locally executing WP-CLI inside your VM:
@@ -199,7 +228,7 @@ tj backup # Aliases: bk
 ### Distributing a package of your project:
 Uses `dist` command within your config.
 ```bash
-tj dist # Aliases: distrubute pack package
+tj dist # Aliases: zip package pkg
 ```
 
 ### Running your test suite:
@@ -209,7 +238,7 @@ tj test # Aliases: tests spec specs
 ```
 
 ## Can I add my starter theme, ________?
-Yes! Just update the `THEMES` constant inside [commands/create.rb](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/commands/create.rb#L7-L11) and make a pull request. I'll verify that it includes a `Juicefile`, and that everything looks solid. Until then (or if your theme is private), just run `tj new --theme https://your.repo/link/goes.here` to clone your theme.
+Yes! Just update the `THEMES` constant inside [commands/create.rb](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/commands/create.rb#L7-L11) and make a pull request. I'll verify that the theme includes a `Juicefile` (not required, but preferred to automate build steps), and that everything looks solid. Until then (or if your theme is private), just run `tj create --theme https://your.repo/link/goes.here` to clone your theme.
 
 ## Contributing
 1. First, create a _well documented_ [issue](https://github.com/ezekg/theme-juice-cli/issues) for your proposed feature/bug fix.

data/lib/theme-juice/cli.rb

@@ -36,20 +36,20 @@ module ThemeJuice
       end
     end
 
-    map %w[--version -v]             => :version
-    map %w[mk make new add]          => :create
-    map %w[up prep init]             => :setup
-    map %w[rm remove trash teardown] => :delete
-    map %w[ls projects apps sites]   => :list
-    map %w[build]                    => :install
-    map %w[assets dev]               => :watch
-    map %w[dependencies deps]        => :vendor
-    map %w[distrubute pack package]  => :dist
-    map %w[wordpress]                => :wp
-    map %w[bk]                       => :backup
-    map %w[tests spec specs]         => :test
-    map %w[deployer server remote]   => :deploy
-    map %w[vagrant vvv]              => :vm
+    map %w[--version -v]           => :version
+    map %w[mk new]                 => :create
+    map %w[up init]                => :setup
+    map %w[rm remove trash]        => :delete
+    map %w[ls projects apps sites] => :list
+    map %w[build]                  => :install
+    map %w[dev]                    => :watch
+    map %w[deps]                   => :vendor
+    map %w[zip package pkg]        => :dist
+    map %w[wordpress]              => :wp
+    map %w[bk]                     => :backup
+    map %w[tests spec specs]       => :test
+    map %w[server remote]          => :deploy
+    map %w[vagrant vvv]            => :vm
 
     class_option :vm_path,       :type => :string,  :default => nil, :desc => "Force path to VM"
     class_option :vm_ip,         :type => :string,  :default => nil, :desc => "Force IP address for VM"

data/lib/theme-juice/commands/create.rb

@@ -132,7 +132,7 @@ module ThemeJuice
           choice = @io.choose "Which starter theme would you like to use?", :blue, THEMES.keys
 
           case choice
-          when "theme-juice/theme-juice-starter"
+          when "theme-juice/trellis"
             @io.success "Awesome choice!"
           when "other"
             THEMES[choice] = @io.prompt "What is the repository URL for the starter theme that you would like to clone?"

data/lib/theme-juice/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ThemeJuice
-  VERSION = "0.7.13"
+  VERSION = "0.7.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-juice
 version: !ruby/object:Gem::Version
-  version: 0.7.13
+  version: 0.7.14
 platform: ruby
 authors:
 - Ezekiel Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -161,7 +161,7 @@ files:
 - lib/theme-juice/version.rb
 homepage: https://themejuice.it
 licenses:
-- GNU
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []