sublime_text_kit 11.0.0 → 11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1edd436349eaa5af3d9a56ba765ba547e42d2a50f512e0e2e58b27fe0727a652
-  data.tar.gz: 76c23a4bfc6aa007d0a2f09c7c2ce374d9080ca6c714799a624d22a2aebffbf0
+  metadata.gz: f09a97c9c7bd65b2e03cbcd38b5d7eea709ee4a253e6be57ac3101d948f7a3df
+  data.tar.gz: 4eb97c05c9d833826fcab6ddb812fa33ca94a9b595d991066247250dcfc0682c
 SHA512:
-  metadata.gz: 2b72e4c50adce16c70a3d08f2004afe3bca0e2e617127277829990fd666a506c5b89436a46bc64cc697cf4fae9d72502565a04102f9cbbc7787d0c9b790e1fcd
-  data.tar.gz: 5d2e45a08e168f6d2377b70496e0b1c64b2cc2472524d793263699a5842a18c8cace41a58ef2f523020240810925ad2df316539e40f7599be4729373ed163052
+  metadata.gz: e7035860e908e521ec4445ceaa7bb8d3dcfa10974aa6885dba538c214e8a8c531550c596556c9e3d9d13bd181116c8ec2a4a4c9f075e5c8dea8125daccdf5289
+  data.tar.gz: '0385887b44d98e5742e5b8a1a277a518886d119700ba76b2d143349dfc4db8a7973ea94f7e76e23918e6c1c45ab0d920861fce3000645997d21a4382e0582729'

data/README.adoc

@@ -12,18 +12,19 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 image::https://circleci.com/gh/bkuhlmann/sublime_text_kit.svg?style=svg[Circle CI Status]
 
 Sublime Text Kit is a command line interface for managing Sublime Text metadata for multiple
-projects, sessions, etc. It's also great for generating the metadata you need, while avoiding manual
-labor, from existing projects.
+projects, sessions, snippets, etc. This allows you to avoiding manual maintenance of your workspace
+so you can stay focused on your own work.
 
 toc::[]
 
 == Features
 
-* Provides project metadata (i.e. `.sublime-project` and `.sublime-workspace` files) management for
-  project switching via the `CONTROL+COMMAND+P` shortcut.
-* Rebuilds project history (Project -> Recent Projects) from existing project files (assumes project
-  metadata is in a directory) so one can easily toggle between up-to-date project information via
-  the `CONTROL+COMMAND+P` shortcut.
+* Manages project metadata (`.sublime-project` and `.sublime-workspace` files).
+* Manages session metadata so you can quickly toggle between projects via the `CONTROL+COMMAND+p`
+  shortcut.
+* Prints all of your custom snippets in either
+  link:https://daringfireball.net/projects/markdown[Markdown] or
+  link:https://asciidoctor.org[ASCII Doc] format.
 
 == Requirements
 
@@ -49,10 +50,10 @@ From the command line, type: `sublime_text_kit`
 USAGE:
   -c, --config ACTION                      Manage gem configuration. Actions: edit or view.
   -h, --help                               Show this message.
-  -m, --metadata ACTION                    Manage metadata. Actions: create, delete, or recreate.
-  -S, --session                            Rebuild session.
-  -s, --snippets [FORMAT]                  View snippets. Default: markdown. Formats: markdown or ascii_doc.
-  -u, --update                             Update metadata and session based on current settings.
+  -m, --metadata ACTION                    Manage project metadata. Actions: create, delete, or recreate.
+  -S, --session                            Rebuild session metadata.
+  -s, --snippets [FORMAT]                  View snippets. Default: ascii_doc. Formats: markdown or ascii_doc.
+  -u, --update                             Update project and session metadata based on current settings.
   -v, --version                            Show gem version.
 ....
 
@@ -67,26 +68,26 @@ An example configuration could be:
 [source,yaml]
 ----
 :project_roots:
-  - "~/Engineering/Contributions"
+  - "~/Engineering/Organizations"
   - "~/Engineering/OSS"
 :metadata_dir: "~/Dropbox/Cache/Sublime"
 :snippets_format: :ascii_doc
 ----
 
-Feel free to take this configuration, modify, and save as your own custom `+configuration.yml+`.
+Feel free to take this configuration, modify, and save as your own.
 
-The project roots define the root level directories where project folders are located. When project
-metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the metadata file
-will be the same name as that of the project folder. All project metadata, regardless of root
-location, is written to the same metadata directory. If using the example settings shown above and
-assuming the following directory structure exists…
+The `project_roots` key defines the root level directories where your project folders are located.
+When project metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the
+metadata file will be the same name as the project folder. All project metadata, regardless of root
+location, is written to the same metadata directory as defined by the `metadata_dir` key. If using
+the example settings shown above and assuming the following directory structure exists…
 
 ....
 ~/Engineering/OSS/example
 ~/Engineering/OSS/sublime_text_kit
 ....
 
-…the project metadata will be created in the workspace directory as follows:
+...project metadata will be created in the `metadata_dir` as follows:
 
 ....
 ~/Dropbox/Cache/Sublime/example.sublime-project
@@ -95,25 +96,33 @@ assuming the following directory structure exists…
 ~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-workspace
 ....
 
+The `snippets_format` key allows you define what format to print your snippets as. The default
+format is Markdown but you can switch to ASCII Doc too. You can always override your default
+configuration by specifying the format from the command line: `sublime_text_kit -s ascii_doc`. For
+example, this is how link:https://www.alchemists.io/projects/sublime_text_setup/#_snippets[snippets
+documentation] is genereted for the
+link:https://www.alchemists.io/projects/sublime_text_setup[Sublime Text Setup] project.
+
 === Workflow
 
 The following demonstrates a default Sublime Text setup:
 
-. Run: `sublime_text_kit --config --edit` (define Sublime Text Kit settings for project roots and
-  metadata directory).
-. Shutdown Sublime Text (i.e. `CONTROL+Q`).
-. Run: `sublime_text_kit --metadata create` (creates project metadata and rebuilds the session
-  metadata so Sublime Text has a complete project history from which to jump through via the
-  `CONTROL+COMMMAND+P` shortcut).
-. Launch Sublime Text and use the `CONTROL+COMMAND+P` keyboard shortcut to toggle between
-  projects. Notice that you can (fuzzy type) project names to jump between them.
-. Breeze through your project workload with ease. 🎉
+1. Start by defining your configuration: `sublime_text_kit --config edit`.
+1. Shutdown Sublime Text (i.e. `COMMAND+q`).
+1. Run `sublime_text_kit --update` which will create project metadata and rebuild session metadata
+   so Sublime Text has a complete project history from which to switch between via the
+   `CONTROL+COMMMAND+p` shortcut.
+1. Launch Sublime Text and use the `CONTROL+COMMAND+p` keyboard shortcut to toggle between projects.
+   Notice that you can (fuzzy type) project names to jump between them.
+1. Navigate through your project workload with ease. 🎉
 
 === Troubleshooting
 
-* When rebuilding workspaces, ensure Sublime Text is shutdown or changes won’t be applied.
-* When rebuilding workspaces, ensure workspace_dir (as defined via settings.yml) points to a
-  directory containing `.sublime-project` and `.sublime-workspace` files.
+* When rebuilding your session, ensure Sublime Text is shut down or changes might not be applied
+  properly.
+* When rebuilding project metadata, ensure the `metadata_dir` -- as defined via your configuration
+  -- points to an existing directory which can contain `.sublime-project` and `.sublime-workspace`
+  files.
 
 == Development
 

data/lib/sublime_text_kit/cli/actions/snippets.rb

@@ -19,13 +19,15 @@ module SublimeTextKit
           kind = configuration.snippets_format
           printers.fetch(kind).call
         rescue KeyError
-          logger.error { "Invalid snippet format: #{kind}." }
+          logger.error { "Invalid snippet format (must be a symbol): #{kind}. Use: #{formats}." }
         end
 
         private
 
         attr_reader :printers, :container
 
+        def formats = printers.keys.map(&:inspect).join(" or ")
+
         def configuration = container[__method__]
 
         def logger = container[__method__]

data/lib/sublime_text_kit/cli/parsers/core.rb

@@ -44,14 +44,14 @@ module SublimeTextKit
             "-m",
             "--metadata ACTION",
             %i[create delete recreate],
-            "Manage metadata. Actions: create, delete, or recreate."
+            "Manage project metadata. Actions: create, delete, or recreate."
           ) do |action|
             configuration.action_metadata = action
           end
         end
 
         def add_session
-          client.on "-S", "--session", "Rebuild session." do
+          client.on "-S", "--session", "Rebuild session metadata." do
             configuration.action_session = true
           end
         end
@@ -70,7 +70,11 @@ module SublimeTextKit
         end
 
         def add_update
-          client.on "-u", "--update", "Update metadata and session based on current settings." do
+          client.on(
+            "-u",
+            "--update",
+            "Update project and session metadata based on current settings."
+          ) do
             configuration.action_update = true
           end
         end

data/lib/sublime_text_kit/identity.rb

@@ -5,7 +5,7 @@ module SublimeTextKit
   module Identity
     NAME = "sublime_text_kit"
     LABEL = "Sublime Text Kit"
-    VERSION = "11.0.0"
+    VERSION = "11.0.1"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     SUMMARY = "A command line interface for managing Sublime Text metadata."
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sublime_text_kit
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.0.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container