Automate Sublime Text configuration (geerlingguy#117)

* sublime text 3

* renamed variable

* sublime text 3

* Update default.config.yml

* PR geerlingguy#110: Update Sublime Text automation so it's a little simpler to configure.

* A couple cosmetic touchups.

* Add Sublime Markdown configuration and fix Package Control install.

* Add a few more Sublime preference files to make the editor work like I like it.

* More Sublime Text automation.

* Saner default for those who don't use Sublime.

* Add remaining tweaks to get Playbook idempotent with Sublime Text.

Co-authored-by: dspolleke <[email protected]>

Author: geerlingguy

README.md

@@ -28,7 +28,7 @@ This is a work in progress, and is mostly a means for me to document my current
 
      2. Source the new profile: `source ~/.zshrc`
      3. Install Ansible: `pip3 install ansible`
-  
+
   3. Clone this repository to your local drive.
   4. Run `$ ansible-galaxy install -r requirements.yml` inside this directory to install required Ansible roles.
   5. Run `ansible-playbook main.yml --ask-become-pass` inside this directory. Enter your account password when prompted.
@@ -66,40 +66,42 @@ Not everyone's development environment and preferred software configuration is t
 
 You can override any of the defaults configured in `default.config.yml` by creating a `config.yml` file and setting the overrides in that file. For example, you can customize the installed packages and apps with something like:
 
-    homebrew_installed_packages:
-      - cowsay
-      - git
-      - go
-    
-    mas_installed_apps:
-      - { id: 443987910, name: "1Password" }
-      - { id: 498486288, name: "Quick Resizer" }
-      - { id: 557168941, name: "Tweetbot" }
-      - { id: 497799835, name: "Xcode" }
-    
-    composer_packages:
-      - name: hirak/prestissimo
-      - name: drush/drush
-        version: '^8.1'
-    
-    gem_packages:
-      - name: bundler
-        state: latest
-    
-    npm_packages:
-      - name: webpack
-    
-    pip_packages:
-      - name: mkdocs
-    
-    configure_dock: true
-    dockitems_remove:
-      - Launchpad
-      - TV
-    dockitems_persist:
-      - name: "Sublime Text"
-        path: "/Applications/Sublime Text.app/"
-        pos: 5
+```yaml
+homebrew_installed_packages:
+  - cowsay
+  - git
+  - go
+
+mas_installed_apps:
+  - { id: 443987910, name: "1Password" }
+  - { id: 498486288, name: "Quick Resizer" }
+  - { id: 557168941, name: "Tweetbot" }
+  - { id: 497799835, name: "Xcode" }
+
+composer_packages:
+  - name: hirak/prestissimo
+  - name: drush/drush
+    version: '^8.1'
+
+gem_packages:
+  - name: bundler
+    state: latest
+
+npm_packages:
+  - name: webpack
+
+pip_packages:
+  - name: mkdocs
+
+configure_dock: true
+dockitems_remove:
+  - Launchpad
+  - TV
+dockitems_persist:
+  - name: "Sublime Text"
+    path: "/Applications/Sublime Text.app/"
+    pos: 5
+```
 
 Any variable can be overridden in `config.yml`; see the supporting roles' documentation for a complete list of available variables.
 
@@ -162,11 +164,12 @@ Finally, there are a few other preferences and settings added on for various app
 
 It's my hope that I can get the rest of these things wrapped up into Ansible playbooks soon, but for now, these steps need to be completed manually (assuming you already have Xcode and Ansible installed, and have run this playbook).
 
-  1. Install [Sublime Package Manager](http://sublime.wbond.net/installation).
-  2. Remap Caps Lock to Escape (requires macOS Sierra 10.12.1+).
-  3. Set trackpad tracking rate.
-  4. Set mouse tracking rate.
-  5. Configure extra Mail and/or Calendar accounts (e.g. Google, Exchange, etc.).
+  1. Set JJG-Term as the default Terminal theme (it's installed, but not set as default automatically).
+  3. Install all the apps that aren't yet in this setup (see below).
+  4. Remap Caps Lock to Escape (requires macOS Sierra 10.12.1+).
+  5. Set trackpad tracking rate.
+  6. Set mouse tracking rate.
+  7. Configure extra Mail and/or Calendar accounts (e.g. Google, Exchange, etc.).
 
 ### Configuration to be added:
 
@@ -192,7 +195,7 @@ Check out [Ansible for DevOps](https://www.ansiblefordevops.com/), which teaches
 
 ## Author
 
-[Jeff Geerling](https://www.jeffgeerling.com/), 2014 (originally inspired by [MWGriffin/ansible-playbooks](https://github.com/MWGriffin/ansible-playbooks)).
+This project was created by [Jeff Geerling](https://www.jeffgeerling.com/) (originally inspired by [MWGriffin/ansible-playbooks](https://github.com/MWGriffin/ansible-playbooks)).
 
 [badge-gh-actions]: https://github.com/geerlingguy/mac-dev-playbook/workflows/CI/badge.svg?event=push
 [link-gh-actions]: https://github.com/geerlingguy/mac-dev-playbook/actions?query=workflow%3ACI

default.config.yml

@@ -109,5 +109,23 @@ pip_packages: []
 #   state: present # present/absent/latest, default: present
 #   version: "0.16.3" # default: N/A
 
+# Set to 'true' to configure Sublime Text.
+configure_sublime: false
+sublime_base_path: '~/Library/Application Support/Sublime Text'
+sublime_config_path: "Packages/User"
+sublime_package_control:
+  - "DocBlockr"
+  - "Dockerfile Syntax Highlighting"
+  - "FileDiffs"
+  - "GitHub Flavored Markdown Preview"
+  - "Jinja2"
+  - "Package Control"
+  - "PHP-Twig"
+  - "Pretty JSON"
+  - "SublimeLinter"
+  - "SublimeLinter-contrib-yamllint"
+  - "TrailingSpaces"
+  - "WordCount"
+
 # Glob pattern to ansible task files to run after all other tasks are finished.
 post_provision_tasks: []