tagrity 0.1.11 → 0.1.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +86 -30
- data/lib/tagrity/commands/status.rb +2 -0
- data/lib/tagrity/version.rb +1 -1
- data/sample_config.yml +1 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 42e6594cf3699cc2f960b28ecb7d06b3ec2c75b8f39d9eb9d6296b6385bb5a52
|
4
|
+
data.tar.gz: 7bf5d6fd08a760d9f2c99a7e3419dec5580f0bd040a680cb9081ace9922ea25a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b9d20591c5e50bd0d1e662511d1f51095bf91c862b2d1ba7bf38e5c6455a80bcbdcaab1b59831af4a6dcaee53fe74b6dfa04e9090b1a7d0cc9a2382c59b2fce2
|
7
|
+
data.tar.gz: c8ac398b851e39503f9a68d8c8655dadadbddaff7d5ff82ff5843ec555ac52ec586d6be39f0456440187742f31fb53343ab1605b14c7f6a4a4426eded189caf6
|
data/README.md
CHANGED
@@ -14,16 +14,82 @@ $ gem install tagrity
|
|
14
14
|
tagrity start
|
15
15
|
```
|
16
16
|
|
17
|
-
That's it!
|
17
|
+
That's it! It will monitor pwd and by default only index files tracked by git.
|
18
|
+
|
19
|
+
To stop watching pwd, use
|
20
|
+
|
21
|
+
```sh
|
22
|
+
tagrity stop
|
23
|
+
```
|
24
|
+
|
25
|
+
To view directories being watched, use
|
26
|
+
|
27
|
+
```sh
|
28
|
+
tagrity status
|
29
|
+
```
|
30
|
+
|
31
|
+
## Configuration
|
32
|
+
|
33
|
+
Configuration can be done through use of a `tagrity_config.yml` file that looks like the following:
|
34
|
+
|
35
|
+
[`tagrity_config.yml`](https://github.com/RRethy/tagrity/blob/master/sample_config.yml)
|
36
|
+
|
37
|
+
```yaml
|
38
|
+
# which command to use to generate tags for a specific file extension
|
39
|
+
# overrides default_command
|
40
|
+
# commands must support --append, -f, -L
|
41
|
+
# DEFAULT: empty
|
42
|
+
extension_commands:
|
43
|
+
rb: ripper-tags
|
44
|
+
c: ctags
|
45
|
+
go: gotags
|
46
|
+
|
47
|
+
# default command to generate tags
|
48
|
+
# command must support --append, -f, -L
|
49
|
+
# DEFAULT: ctags
|
50
|
+
default_command: ctags
|
51
|
+
|
52
|
+
# filename (relative to pwd) to generate tags into
|
53
|
+
# DEFAULT: tags
|
54
|
+
tagf: tags
|
55
|
+
|
56
|
+
# list of extensions to exclusively generate tags for
|
57
|
+
# this will take precendence over extensions_blacklist if it is non-empty
|
58
|
+
# DEFAULT: []
|
59
|
+
extensions_whitelist: [rb, c, h, js]
|
60
|
+
|
61
|
+
# list of extensions to not generate tags for
|
62
|
+
# this can will be ignored if extensions_whitelist is non-empty
|
63
|
+
# DEFAULT: []
|
64
|
+
extensions_blacklist: [erb, html, txt]
|
65
|
+
|
66
|
+
# how to integrate with git
|
67
|
+
# git_strategy: TRACKED | IGNORED | NA
|
68
|
+
# TRACKED: only index files tracked by git
|
69
|
+
# IGNORED: don't index files which are ignored by git
|
70
|
+
# NA: don't use git, index all files under pwd
|
71
|
+
#
|
72
|
+
# DEFAULT: TRACKED
|
73
|
+
git_strategy: TRACKED
|
74
|
+
|
75
|
+
# which paths (relative to pwd) to ignore
|
76
|
+
# It's usually better to avoid this since tagrity integrates with git by
|
77
|
+
# default using the strategy specified by git_strategy
|
78
|
+
# DEFAULT: []
|
79
|
+
excluded_paths: [vendor, node_modules]
|
80
|
+
```
|
81
|
+
|
82
|
+
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.
|
18
83
|
|
19
84
|
## Usage
|
20
85
|
|
21
86
|
```
|
22
87
|
Commands:
|
23
88
|
tagrity help [COMMAND] # Describe available commands or one specific command
|
24
|
-
tagrity
|
89
|
+
tagrity logs # Print the logs for pwd
|
90
|
+
tagrity start # Start watching pwd
|
25
91
|
tagrity status # List running tagrity processes and the directories being watched
|
26
|
-
tagrity stop # Stop watching
|
92
|
+
tagrity stop # Stop watching pwd
|
27
93
|
```
|
28
94
|
|
29
95
|
### start
|
@@ -33,15 +99,10 @@ Usage:
|
|
33
99
|
tagrity start
|
34
100
|
|
35
101
|
Options:
|
36
|
-
[--
|
37
|
-
[--
|
38
|
-
|
39
|
-
|
40
|
-
[--default-cmd=DEFAULT_CMD]
|
41
|
-
[--excluded-exts=one two three]
|
42
|
-
[--excluded-paths=one two three]
|
43
|
-
|
44
|
-
Start watching a directory (default to pwd)
|
102
|
+
[--fg], [--no-fg] # keep the tagrity process running in the foreground
|
103
|
+
[--fresh], [--no-fresh] # index the whole codebase before watching the file system. This will be slow if the codebase is large.
|
104
|
+
|
105
|
+
Start watching pwd
|
45
106
|
```
|
46
107
|
|
47
108
|
### stop
|
@@ -50,10 +111,7 @@ Start watching a directory (default to pwd)
|
|
50
111
|
Usage:
|
51
112
|
tagrity stop
|
52
113
|
|
53
|
-
|
54
|
-
[--dir=DIR]
|
55
|
-
|
56
|
-
Stop watching a directory (default to pwd)
|
114
|
+
Stop watching pwd
|
57
115
|
```
|
58
116
|
|
59
117
|
### status
|
@@ -65,15 +123,22 @@ Usage:
|
|
65
123
|
List running tagrity processes and the directories being watched
|
66
124
|
```
|
67
125
|
|
68
|
-
|
126
|
+
### logs
|
69
127
|
|
70
|
-
|
128
|
+
```
|
129
|
+
Usage:
|
130
|
+
tagrity logs
|
71
131
|
|
72
|
-
|
132
|
+
Options:
|
133
|
+
[-n=N] # the number of log lines to print
|
134
|
+
# Default: 10
|
135
|
+
|
136
|
+
Print the logs for pwd
|
137
|
+
```
|
73
138
|
|
74
139
|
## Contributing
|
75
140
|
|
76
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
141
|
+
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.
|
77
142
|
|
78
143
|
## License
|
79
144
|
|
@@ -81,13 +146,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
81
146
|
|
82
147
|
## Code of Conduct
|
83
148
|
|
84
|
-
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/
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
tagrity config to use (default to ~/.config/tagrity/config.yml if available).
|
90
|
-
A config file is a yaml file with the following possible values.
|
91
|
-
Some of these can be overridden with options, however the configfile
|
92
|
-
provided via --configfile will override the global config file in
|
93
|
-
~/.config/tagrity/config.yml
|
149
|
+
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/version.rb
CHANGED
data/sample_config.yml
CHANGED