watson-ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca27dbddaa8f1c118cb988a0798bcac865a47c38
-  data.tar.gz: 1c474e7962dff2e93839f30bc3513cd27dd63153
+  metadata.gz: b11a43edd74df47a900897873268d38b056c10f4
+  data.tar.gz: 95bccd69492466cbf64102bc946d957520781c5b
 SHA512:
-  metadata.gz: 28d381b26c4216d36e987f5dd619ea78b0acd998e24b86df36376f68ab5283a3f53acac6141a2f913812064a1e5eb9721c618cc73673f70809f2f39f2d943efa
-  data.tar.gz: 60bb4d26b816e0f2276624984d01e60cd139a36feb94c8800e89948e4a2d7dab019a61a797cb22524c3591d569c5440853b1781b630ea6e7a0dfa46bd4a7259f
+  metadata.gz: 3ca841a102298b44102bc684d6e161df044c42233f28d8c7f1a39378a8e0850aa7a926b40d4f125f76ea1525c0897c2cc439f607ab5f2c9f169d14d516170b2a
+  data.tar.gz: e978dac203b6b8f4c9e7bb75011f5cc0ac824efcf9b1a34613b6f90815b6bc40a278129ab154cf260bbd0761a58c5fee895633477bd94b99556186cbfb888d13

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    watson-ruby (1.3.0)
+    watson-ruby (1.4.0)
       json
 
 GEM

data/README.md

@@ -56,17 +56,17 @@ Usage: watson [OPTION]...
 Running watson with no arguments will parse with settings in RC file
 If no RC file exists, default RC file will be created
 
-   -c, --context-lines          number of lines of context to provide with posted issue
-   -d, --dirs                   list of directories to search in
-   -f, --files                  list of files to search in
-   -h, --help                   print help
-   -i, --ignore                 list of files, directories, or types to ignore
-   -p, --parse-depth            depth to recursively parse directories
-   -r, --remote                 list / create tokens for Bitbucket/Github
-   -s, --show                   whether to show [all, clean, dirty] files
-   -t, --tags                   list of tags to search for
-   -u, --update                 update remote repos with current issues
-   -v, --version                print watson version and info
+   -c, --context-depth   number of lines of context to provide with posted issue
+   -d, --dirs            list of directories to search in
+   -f, --files           list of files to search in
+   --format              set output format for watson [print, json, unite, silent]
+   -h, --help            print help
+   -i, --ignore          list of files, directories, or types to ignore
+   -p, --parse-depth     depth to recursively parse directories
+   -r, --remote          list / create tokens for Bitbucket/GitHub
+   -t, --tags            list of tags to search for
+   -u, --update          update remote repos with current issues
+   -v, --version         print watson version and info
 
 Any number of files, tags, dirs, and ignores can be listed after flag
 Ignored files should be space separated
@@ -96,6 +96,21 @@ This parameter specifies which files watson should parse through.
 It should be followed by a space separated list of files that should be parsed.  
 
 
+### --format [PRINT, JSON, UNITE, SILENT]
+This parameter specifies how watson should output the issues that it finds.  
+If passed with `print`, the regular printing will occur, either to Unix less or STDOUT (depending on system).  
+If passed with `json`, the output will be in the form of JSON, and will be stored in `.watsonresults`.  
+
+- This particular option is useful if attempting to intergrate watson into other tools / platforms.
+
+If passed with `unite`, the output will be compatible with the vim unite plugin (more details soon)  
+
+If passed with `silent`, watson will have no output.  
+
+- This particular option is useful if remote posting to GitHub or Bitbucket is desired without the visual component of watson.  
+- For example, you could set up a **git commit hook** to post issues to GitHub/Bitbucket, but avoid the giant print out every time.
+
+
 ### -h, --help
 This parameter displays the list of avaliable options for watson.  
 

data/lib/watson/command.rb

@@ -180,13 +180,14 @@ module Watson
          -c, --context-depth   number of lines of context to provide with posted issue
          -d, --dirs            list of directories to search in
          -f, --files           list of files to search in
+         --format              set output format for watson [print, json, unite, silent]
          -h, --help            print help
          -i, --ignore          list of files, directories, or types to ignore
          -p, --parse-depth     depth to recursively parse directories
          -r, --remote          list / create tokens for Bitbucket/GitHub
          -t, --tags            list of tags to search for
          -u, --update          update remote repos with current issues
-         -v, --version      print watson version and info
+         -v, --version         print watson version and info
 
       Any number of files, tags, dirs, and ignores can be listed after flag
       Ignored files should be space separated
@@ -495,6 +496,8 @@ module Watson
           Watson::Formatters::JsonFormatter
         when 'unite'
           Watson::Formatters::UniteFormatter
+        when 'silent'
+          Watson::Formatters::SilentFormatter
         else
           Watson::Formatters::DefaultFormatter
       end

data/lib/watson/formatters.rb

@@ -3,4 +3,5 @@ module Watson::Formatters
   autoload :DefaultFormatter, 'watson/formatters/default_formatter'
   autoload :JsonFormatter, 'watson/formatters/json_formatter'
   autoload :UniteFormatter, 'watson/formatters/unite_formatter'
+  autoload :SilentFormatter, 'watson/formatters/silent_formatter'
 end

data/lib/watson/formatters/silent_formatter.rb

@@ -0,0 +1,10 @@
+module Watson::Formatters
+  # [review] - All other formatters inherit from BaseFormatter
+  # but since the only thing silent does differently is not print
+  # the results, inheriting from DefaultFormatter simplifies things
+  # We don't have to worry about cprint/print_status/ect
+  class SilentFormatter < DefaultFormatter
+    def run(structure)
+    end
+  end
+end

data/lib/watson/version.rb

@@ -1,3 +1,3 @@
 module Watson
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watson-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - nhmood
@@ -77,6 +77,7 @@ files:
 - lib/watson/formatters/base_formatter.rb
 - lib/watson/formatters/default_formatter.rb
 - lib/watson/formatters/json_formatter.rb
+- lib/watson/formatters/silent_formatter.rb
 - lib/watson/formatters/unite_formatter.rb
 - lib/watson/fs.rb
 - lib/watson/github.rb