tagrity 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e7a19c450d56f1edfad77d0197b896a54bff22c1d93470f0f87ad73b39cad9
-  data.tar.gz: f4e895c3b71364b4aa2c19ec37ade02bc5e6d51501be21dd143058c89007b72c
+  metadata.gz: 108ca29640e9678892135b56715e996495c083991290da7b85417b46d9919515
+  data.tar.gz: bb470e250abdcbd3c8279e993e116214ef744b4511ffd0a36015263491bb1aa1
 SHA512:
-  metadata.gz: 9f8877beea1429b73905cb96334134636999a5f262d54633c70a0e6f6ab9f5d90d729b81755d81ea226a4f6f8e4ecbfa262ff34c5820cc8f4436a4c22550a712
-  data.tar.gz: 037517b1bde73d9b067c64925576033cf75f055eafe56574b839625cb190d32ec4e25107bcc9ad25d2ee2da7b99826656fe4cd9d5330ddd0f4130c8085b8b0a5
+  metadata.gz: d84b1309bde87b1e08d506c6fed445fe82be16ae7a0cbdedae184b552b5a3a54598982819914a3930b8b422d9147d50da9d0688538efabc4e4a4f5eb46a0a51a
+  data.tar.gz: 3aaffa2a8cf6dd66fcf85de6312cf3865f20a7688193479f1945f53cf8be936fe28f83c01d01f79ee9c3f8c715d44c773a37ce68f0639aab0046e158045ad029

data/Gemfile.lock

@@ -4,7 +4,6 @@ PATH
     tagrity (0.3.7)
       cli-ui (~> 1.3.0)
       listen (~> 3.2.1)
-      pry (~> 0.9.9)
       thor (~> 0.20)
 
 GEM
@@ -48,6 +47,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  pry (~> 0.9.9)
   rake (~> 13.0)
   ripper-tags (~> 0.8.0)
   rspec (~> 3.0)

data/README.md

@@ -16,9 +16,9 @@ $ gem install tagrity
 tagrity start
 ```
 
-That's it! It will monitor pwd and index any files which change. Check out [Configuration](#configuration) to restrict which files get indexed.
+That's it! It will monitor the current directory and generate tags for any files which change and are not ignored by git.
 
-To stop watching pwd, use
+To stop watching the current directory, use
 
 ```sh
 tagrity stop
@@ -30,6 +30,30 @@ To view directories being watched, use
 tagrity status
 ```
 
+## Less Quick Start
+
+When your computer is restarted, the process watching the directories will be killed. Add the following to your `~/.bashrc` (or `~/.zshrc`, etc.) to revive any killed processes automatically.
+
+```sh
+(tagrity revive &) &> /dev/null
+```
+
+To stop watching a directory that isn't the current working directory (but shows up in `tagrity status`), you can use:
+
+```sh
+tagrity stop --dir <path>
+```
+
+Where `<path>` is a relative or absolute path. You may be tempted to run `tagrity status` to get the pid and then kill it with `kill <pid>`. However, while this will work, `tagrity revive` will restart these processes (with different pids of course). `tagrity stop` will kill the process and stop `tagrity revive` from starting it up again.
+
+To get info on what tags are being generated, you can run:
+
+```sh
+tagrity logs
+```
+
+For a full set of subcommands, try `tagrity help`.
+
 ## Configuration
 
 Configuration can be done through use of a local `.tagrity_config.yml` file that looks like the following:
@@ -76,8 +100,7 @@ extensions_whitelist: [rb, c, h, js]
 extensions_blacklist: [erb, html, txt]
 
 # which paths (relative to pwd) to ignore
-# It's usually better to avoid this since tagrity integrates with git by
-# default using the strategy specified by git_strategy
+# this is usually not needed since tagrity doesn't index files ignored by git
 #
 # Default: []
 excluded_paths: [vendor, node_modules]
@@ -89,9 +112,11 @@ excluded_paths: [vendor, node_modules]
 Commands:
   tagrity help [COMMAND]  # Describe available commands or one specific command
   tagrity logs            # Print the logs for pwd
+  tagrity revive          # Restart any tagrity processes that died
   tagrity start           # Start watching pwd
   tagrity status          # List running tagrity processes and the directories being watched
-  tagrity stop            # Stop watching pwd
+  tagrity stop            # Stop watching a directory (default to pwd)
+  tagrity version         # print tagrity version
 ```
 
 ### start
@@ -113,7 +138,11 @@ Start watching pwd
 Usage:
   tagrity stop
 
-Stop watching pwd
+Options:
+  [--dir=DIR]  # directory to stop watching.
+               # Default: /Users/rethy/ruby/tagrity
+
+Stop watching a directory (default to pwd)
 ```
 
 ### status

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/sample_config.yml

@@ -33,8 +33,7 @@ extensions_whitelist: [rb, c, h, js]
 extensions_blacklist: [erb, html, txt]
 
 # which paths (relative to pwd) to ignore
-# It's usually better to avoid this since tagrity integrates with git by
-# default using the strategy specified by git_strategy
+# this is usually not needed since tagrity doesn't index files ignored by git
 #
 # Default: []
 excluded_paths: [vendor, node_modules]

data/tagrity.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "ripper-tags", "~> 0.8.0"
-  spec.add_dependency "pry", "~> 0.9.9"
+  spec.add_development_dependency "pry", "~> 0.9.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -115,7 +115,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.9
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -141,7 +141,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - bin/console
 - bin/setup
 - exe/tagrity

data/TODO.md

@@ -1,3 +0,0 @@
-# TODO
-
-* Document new changes for revive and stop