tagrity 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 676b3812ea21f514554472122fca65107c27a5c1998b9868ce5da719fca8b584
-  data.tar.gz: 29b26f0ca85cfbd6dcac1af677f298ea31687a793cfbb224d6dfa0f140a23d81
+  metadata.gz: 42e6594cf3699cc2f960b28ecb7d06b3ec2c75b8f39d9eb9d6296b6385bb5a52
+  data.tar.gz: 7bf5d6fd08a760d9f2c99a7e3419dec5580f0bd040a680cb9081ace9922ea25a
 SHA512:
-  metadata.gz: 360d9552c208f658a465a590a438a8d09f4f6ea2ca39be206ba643fec3e060eedd2e02232b7b8aa3c9b17786f43c677ce86bec1e5e54024ea45a8b62653d0e08
-  data.tar.gz: dd53f1bf80a33e857c93c317ffb960559939ce81627221415291b11630ca9239b8f673f8f2cfd1e4bc743d8369634cfc38a6a28bddf05347b809adb9025c4754
+  metadata.gz: b9d20591c5e50bd0d1e662511d1f51095bf91c862b2d1ba7bf38e5c6455a80bcbdcaab1b59831af4a6dcaee53fe74b6dfa04e9090b1a7d0cc9a2382c59b2fce2
+  data.tar.gz: c8ac398b851e39503f9a68d8c8655dadadbddaff7d5ff82ff5843ec555ac52ec586d6be39f0456440187742f31fb53343ab1605b14c7f6a4a4426eded189caf6

data/README.md

@@ -14,16 +14,82 @@ $ gem install tagrity
 tagrity start
 ```
 
-That's it! By default, tagrity will only index files tracked by git. You may wish to al
+That's it! It will monitor pwd and by default only index files tracked by git.
+
+To stop watching pwd, use
+
+```sh
+tagrity stop
+```
+
+To view directories being watched, use
+
+```sh
+tagrity status
+```
+
+## Configuration
+
+Configuration can be done through use of a `tagrity_config.yml` file that looks like the following:
+
+[`tagrity_config.yml`](https://github.com/RRethy/tagrity/blob/master/sample_config.yml)
+
+```yaml
+# which command to use to generate tags for a specific file extension
+# overrides default_command
+# commands must support --append, -f, -L
+# DEFAULT: empty
+extension_commands:
+  rb: ripper-tags
+  c: ctags
+  go: gotags
+
+# default command to generate tags
+# command must support --append, -f, -L
+# DEFAULT: ctags
+default_command: ctags
+
+# filename (relative to pwd) to generate tags into
+# DEFAULT: tags
+tagf: tags
+
+# list of extensions to exclusively generate tags for
+# this will take precendence over extensions_blacklist if it is non-empty
+# DEFAULT: []
+extensions_whitelist: [rb, c, h, js]
+
+# list of extensions to not generate tags for
+# this can will be ignored if extensions_whitelist is non-empty
+# DEFAULT: []
+extensions_blacklist: [erb, html, txt]
+
+# how to integrate with git
+# git_strategy: TRACKED | IGNORED | NA
+# TRACKED: only index files tracked by git
+# IGNORED: don't index files which are ignored by git
+# NA: don't use git, index all files under pwd
+#
+# DEFAULT: TRACKED
+git_strategy: TRACKED
+
+# 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
+# DEFAULT: []
+excluded_paths: [vendor, node_modules]
+```
+
+Tagrity will look for a global config file at `$XDG_CONFIG_HOME/tagrity/tagrity_config.yml` (usually this will be `~/.config/tagrity/tagrity_config.yml`). This can be overridden by a local config file by the same name under pwd.
 
 ## Usage
 
 ```
 Commands:
   tagrity help [COMMAND]  # Describe available commands or one specific command
-  tagrity start           # Start watching a directory (default to pwd)
+  tagrity logs            # Print the logs for pwd
+  tagrity start           # Start watching pwd
   tagrity status          # List running tagrity processes and the directories being watched
-  tagrity stop            # Stop watching a directory (default to pwd)
+  tagrity stop            # Stop watching pwd
 ```
 
 ### start
@@ -33,15 +99,10 @@ Usage:
   tagrity start
 
 Options:
-  [--dir=DIR]
-  [--fg], [--no-fg]
-  [--configfile=CONFIGFILE]
-  [--tagf=TAGF]
-  [--default-cmd=DEFAULT_CMD]
-  [--excluded-exts=one two three]
-  [--excluded-paths=one two three]
-
-Start watching a directory (default to pwd)
+  [--fg], [--no-fg]        # keep the tagrity process running in the foreground
+  [--fresh], [--no-fresh]  # index the whole codebase before watching the file system. This will be slow if the codebase is large.
+
+Start watching pwd
 ```
 
 ### stop
@@ -50,10 +111,7 @@ Start watching a directory (default to pwd)
 Usage:
   tagrity stop
 
-Options:
-  [--dir=DIR]
-
-Stop watching a directory (default to pwd)
+Stop watching pwd
 ```
 
 ### status
@@ -65,15 +123,22 @@ Usage:
 List running tagrity processes and the directories being watched
 ```
 
-## Development
+### logs
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+Usage:
+  tagrity logs
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Options:
+  [-n=N]  # the number of log lines to print
+          # Default: 10
+
+Print the logs for pwd
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tagrity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RRethy/tagrity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -81,13 +146,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Tagrity project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tagrity/blob/master/CODE_OF_CONDUCT.md).
-
-
-
-
-tagrity config to use (default to ~/.config/tagrity/config.yml if available).
-A config file is a yaml file with the following possible values.
-Some of these can be overridden with options, however the configfile
-provided via --configfile will override the global config file in
-~/.config/tagrity/config.yml
+Everyone interacting in the Tagrity project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/RRethy/tagrity/blob/master/CODE_OF_CONDUCT.md).

data/lib/tagrity/commands/status.rb

@@ -9,6 +9,8 @@ module Tagrity
             pid_file
           end
 
+          return if pid_files.empty?
+
           max_pid_len = pid_files.max do |a, b|
             a.pid.digits.count <=> b.pid.digits.count
           end.pid.digits.count

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/sample_config.yml

@@ -31,6 +31,7 @@ extensions_blacklist: [erb, html, txt]
 # TRACKED: only index files tracked by git
 # IGNORED: don't index files which are ignored by git
 # NA: don't use git, index all files under pwd
+#
 # DEFAULT: TRACKED
 git_strategy: TRACKED
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy