tocer 7.2.0 → 8.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/README.md +13 -12
- data/lib/tocer/builder.rb +1 -0
- data/lib/tocer/cli.rb +2 -1
- data/lib/tocer/identity.rb +1 -1
- data/lib/tocer/runner.rb +1 -0
- metadata +38 -53
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ea42cdc0824b21e3fddfc8e1c6fc7d15de6773500882ae97b15433e67f5f6f89
|
4
|
+
data.tar.gz: 8561da9d5368e33dd25e6f0d596e0dcab8784005dae4b8a1448ba97532540148
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 90a1409a816338bb6e3c071b63db5711febe61c35c6e665f96429bbcc85a6c4658ed3f4b4b78411989ee74310c139dfe63e20eeee0843d8d79460bd7c90173d7
|
7
|
+
data.tar.gz: f7a2120c11dedf12d1c55f394d02faa16f4957f066ed75a71a04e51387fbbcb578dd780ddfe1a3051203991b7c900551114845f471f6c7a4b17341a9806a7f79
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data.tar.gz.sig
CHANGED
Binary file
|
data/README.md
CHANGED
@@ -41,8 +41,8 @@ Markdown files.
|
|
41
41
|
|
42
42
|
## Requirements
|
43
43
|
|
44
|
-
|
45
|
-
|
44
|
+
1. A UNIX-based system.
|
45
|
+
1. [Ruby 2.6.x](https://www.ruby-lang.org).
|
46
46
|
|
47
47
|
## Setup
|
48
48
|
|
@@ -97,7 +97,8 @@ Examples](https://github.com/bkuhlmann/runcom#examples) for project specific usa
|
|
97
97
|
The default configuration is as follows:
|
98
98
|
|
99
99
|
:label: "## Table of Contents"
|
100
|
-
:includes:
|
100
|
+
:includes:
|
101
|
+
- "README.md"
|
101
102
|
|
102
103
|
Feel free to take this default configuration, modify, and save as your own custom
|
103
104
|
`configuration.yml`.
|
@@ -109,24 +110,24 @@ The `configuration.yml` file can be configured as follows:
|
|
109
110
|
|
110
111
|
There are multiple ways the include list can be defined. Here are some examples:
|
111
112
|
|
112
|
-
# Use an empty array to ignore all files (a key with
|
113
|
+
# Use an empty array to ignore all files (a key with no value would work too).
|
113
114
|
:includes: []
|
114
115
|
|
115
116
|
# Use an array of wildcards for groups of files with similar extensions:
|
116
117
|
:includes:
|
117
|
-
- *.md
|
118
|
-
- *.mkd
|
119
|
-
- *.markdown
|
118
|
+
- "*.md"
|
119
|
+
- "*.mkd"
|
120
|
+
- "*.markdown"
|
120
121
|
|
121
122
|
# Use a mix of wild cards and relative names/paths to customized as necessary:
|
122
123
|
:includes:
|
123
|
-
- README.md
|
124
|
-
- docs/*.md
|
125
|
-
- *.markdown
|
124
|
+
- "README.md"
|
125
|
+
- "docs/*.md"
|
126
|
+
- "*.markdown"
|
126
127
|
|
127
128
|
# Use a recursive glob to traverse and update all sub-directories:
|
128
129
|
:includes:
|
129
|
-
- **/*.md
|
130
|
+
- "**/*.md"
|
130
131
|
|
131
132
|
## Tests
|
132
133
|
|
@@ -136,7 +137,7 @@ To test, run:
|
|
136
137
|
|
137
138
|
## Versioning
|
138
139
|
|
139
|
-
Read [Semantic Versioning](
|
140
|
+
Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
|
140
141
|
|
141
142
|
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
|
142
143
|
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
|
data/lib/tocer/builder.rb
CHANGED
data/lib/tocer/cli.rb
CHANGED
@@ -12,7 +12,7 @@ module Tocer
|
|
12
12
|
package_name Identity.version_label
|
13
13
|
|
14
14
|
def self.configuration
|
15
|
-
Runcom::
|
15
|
+
Runcom::Config.new Identity.name, defaults: {
|
16
16
|
label: "## Table of Contents",
|
17
17
|
includes: ["README.md"]
|
18
18
|
}
|
@@ -44,6 +44,7 @@ module Tocer
|
|
44
44
|
files = runner.files
|
45
45
|
|
46
46
|
return if files.empty?
|
47
|
+
|
47
48
|
runner.run
|
48
49
|
|
49
50
|
say "Processed table of contents for:"
|
data/lib/tocer/identity.rb
CHANGED
data/lib/tocer/runner.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tocer
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 8.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
@@ -29,7 +29,7 @@ cert_chain:
|
|
29
29
|
4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
|
30
30
|
b4jw5t40FKyNUvLPPXYAvQALBtk=
|
31
31
|
-----END CERTIFICATE-----
|
32
|
-
date:
|
32
|
+
date: 2019-01-01 00:00:00.000000000 Z
|
33
33
|
dependencies:
|
34
34
|
- !ruby/object:Gem::Dependency
|
35
35
|
name: refinements
|
@@ -37,28 +37,28 @@ dependencies:
|
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '6.0'
|
41
41
|
type: :runtime
|
42
42
|
prerelease: false
|
43
43
|
version_requirements: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '6.0'
|
48
48
|
- !ruby/object:Gem::Dependency
|
49
49
|
name: runcom
|
50
50
|
requirement: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '
|
54
|
+
version: '4.0'
|
55
55
|
type: :runtime
|
56
56
|
prerelease: false
|
57
57
|
version_requirements: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version: '
|
61
|
+
version: '4.0'
|
62
62
|
- !ruby/object:Gem::Dependency
|
63
63
|
name: thor
|
64
64
|
requirement: !ruby/object:Gem::Requirement
|
@@ -130,159 +130,145 @@ dependencies:
|
|
130
130
|
- !ruby/object:Gem::Version
|
131
131
|
version: '0.1'
|
132
132
|
- !ruby/object:Gem::Dependency
|
133
|
-
name:
|
134
|
-
requirement: !ruby/object:Gem::Requirement
|
135
|
-
requirements:
|
136
|
-
- - "~>"
|
137
|
-
- !ruby/object:Gem::Version
|
138
|
-
version: '1.0'
|
139
|
-
type: :development
|
140
|
-
prerelease: false
|
141
|
-
version_requirements: !ruby/object:Gem::Requirement
|
142
|
-
requirements:
|
143
|
-
- - "~>"
|
144
|
-
- !ruby/object:Gem::Version
|
145
|
-
version: '1.0'
|
146
|
-
- !ruby/object:Gem::Dependency
|
147
|
-
name: gemsmith
|
133
|
+
name: guard-rspec
|
148
134
|
requirement: !ruby/object:Gem::Requirement
|
149
135
|
requirements:
|
150
136
|
- - "~>"
|
151
137
|
- !ruby/object:Gem::Version
|
152
|
-
version: '
|
138
|
+
version: '4.7'
|
153
139
|
type: :development
|
154
140
|
prerelease: false
|
155
141
|
version_requirements: !ruby/object:Gem::Requirement
|
156
142
|
requirements:
|
157
143
|
- - "~>"
|
158
144
|
- !ruby/object:Gem::Version
|
159
|
-
version: '
|
145
|
+
version: '4.7'
|
160
146
|
- !ruby/object:Gem::Dependency
|
161
|
-
name:
|
147
|
+
name: hirb
|
162
148
|
requirement: !ruby/object:Gem::Requirement
|
163
149
|
requirements:
|
164
150
|
- - "~>"
|
165
151
|
- !ruby/object:Gem::Version
|
166
|
-
version: '
|
152
|
+
version: '0.7'
|
167
153
|
type: :development
|
168
154
|
prerelease: false
|
169
155
|
version_requirements: !ruby/object:Gem::Requirement
|
170
156
|
requirements:
|
171
157
|
- - "~>"
|
172
158
|
- !ruby/object:Gem::Version
|
173
|
-
version: '
|
159
|
+
version: '0.7'
|
174
160
|
- !ruby/object:Gem::Dependency
|
175
|
-
name:
|
161
|
+
name: pry
|
176
162
|
requirement: !ruby/object:Gem::Requirement
|
177
163
|
requirements:
|
178
164
|
- - "~>"
|
179
165
|
- !ruby/object:Gem::Version
|
180
|
-
version: '
|
166
|
+
version: '0.10'
|
181
167
|
type: :development
|
182
168
|
prerelease: false
|
183
169
|
version_requirements: !ruby/object:Gem::Requirement
|
184
170
|
requirements:
|
185
171
|
- - "~>"
|
186
172
|
- !ruby/object:Gem::Version
|
187
|
-
version: '
|
173
|
+
version: '0.10'
|
188
174
|
- !ruby/object:Gem::Dependency
|
189
|
-
name:
|
175
|
+
name: pry-byebug
|
190
176
|
requirement: !ruby/object:Gem::Requirement
|
191
177
|
requirements:
|
192
178
|
- - "~>"
|
193
179
|
- !ruby/object:Gem::Version
|
194
|
-
version: '
|
180
|
+
version: '3.5'
|
195
181
|
type: :development
|
196
182
|
prerelease: false
|
197
183
|
version_requirements: !ruby/object:Gem::Requirement
|
198
184
|
requirements:
|
199
185
|
- - "~>"
|
200
186
|
- !ruby/object:Gem::Version
|
201
|
-
version: '
|
187
|
+
version: '3.5'
|
202
188
|
- !ruby/object:Gem::Dependency
|
203
|
-
name:
|
189
|
+
name: rake
|
204
190
|
requirement: !ruby/object:Gem::Requirement
|
205
191
|
requirements:
|
206
192
|
- - "~>"
|
207
193
|
- !ruby/object:Gem::Version
|
208
|
-
version: '
|
194
|
+
version: '12.3'
|
209
195
|
type: :development
|
210
196
|
prerelease: false
|
211
197
|
version_requirements: !ruby/object:Gem::Requirement
|
212
198
|
requirements:
|
213
199
|
- - "~>"
|
214
200
|
- !ruby/object:Gem::Version
|
215
|
-
version: '
|
201
|
+
version: '12.3'
|
216
202
|
- !ruby/object:Gem::Dependency
|
217
|
-
name:
|
203
|
+
name: reek
|
218
204
|
requirement: !ruby/object:Gem::Requirement
|
219
205
|
requirements:
|
220
206
|
- - "~>"
|
221
207
|
- !ruby/object:Gem::Version
|
222
|
-
version: '
|
208
|
+
version: '5.0'
|
223
209
|
type: :development
|
224
210
|
prerelease: false
|
225
211
|
version_requirements: !ruby/object:Gem::Requirement
|
226
212
|
requirements:
|
227
213
|
- - "~>"
|
228
214
|
- !ruby/object:Gem::Version
|
229
|
-
version: '
|
215
|
+
version: '5.0'
|
230
216
|
- !ruby/object:Gem::Dependency
|
231
|
-
name:
|
217
|
+
name: rspec
|
232
218
|
requirement: !ruby/object:Gem::Requirement
|
233
219
|
requirements:
|
234
220
|
- - "~>"
|
235
221
|
- !ruby/object:Gem::Version
|
236
|
-
version: '
|
222
|
+
version: '3.8'
|
237
223
|
type: :development
|
238
224
|
prerelease: false
|
239
225
|
version_requirements: !ruby/object:Gem::Requirement
|
240
226
|
requirements:
|
241
227
|
- - "~>"
|
242
228
|
- !ruby/object:Gem::Version
|
243
|
-
version: '
|
229
|
+
version: '3.8'
|
244
230
|
- !ruby/object:Gem::Dependency
|
245
|
-
name:
|
231
|
+
name: rubocop
|
246
232
|
requirement: !ruby/object:Gem::Requirement
|
247
233
|
requirements:
|
248
234
|
- - "~>"
|
249
235
|
- !ruby/object:Gem::Version
|
250
|
-
version: '
|
236
|
+
version: '0.62'
|
251
237
|
type: :development
|
252
238
|
prerelease: false
|
253
239
|
version_requirements: !ruby/object:Gem::Requirement
|
254
240
|
requirements:
|
255
241
|
- - "~>"
|
256
242
|
- !ruby/object:Gem::Version
|
257
|
-
version: '
|
243
|
+
version: '0.62'
|
258
244
|
- !ruby/object:Gem::Dependency
|
259
|
-
name: rspec
|
245
|
+
name: rubocop-rspec
|
260
246
|
requirement: !ruby/object:Gem::Requirement
|
261
247
|
requirements:
|
262
248
|
- - "~>"
|
263
249
|
- !ruby/object:Gem::Version
|
264
|
-
version: '
|
250
|
+
version: '1.30'
|
265
251
|
type: :development
|
266
252
|
prerelease: false
|
267
253
|
version_requirements: !ruby/object:Gem::Requirement
|
268
254
|
requirements:
|
269
255
|
- - "~>"
|
270
256
|
- !ruby/object:Gem::Version
|
271
|
-
version: '
|
257
|
+
version: '1.30'
|
272
258
|
- !ruby/object:Gem::Dependency
|
273
|
-
name:
|
259
|
+
name: simplecov
|
274
260
|
requirement: !ruby/object:Gem::Requirement
|
275
261
|
requirements:
|
276
262
|
- - "~>"
|
277
263
|
- !ruby/object:Gem::Version
|
278
|
-
version: '0.
|
264
|
+
version: '0.13'
|
279
265
|
type: :development
|
280
266
|
prerelease: false
|
281
267
|
version_requirements: !ruby/object:Gem::Requirement
|
282
268
|
requirements:
|
283
269
|
- - "~>"
|
284
270
|
- !ruby/object:Gem::Version
|
285
|
-
version: '0.
|
271
|
+
version: '0.13'
|
286
272
|
- !ruby/object:Gem::Dependency
|
287
273
|
name: wirb
|
288
274
|
requirement: !ruby/object:Gem::Requirement
|
@@ -335,15 +321,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
335
321
|
requirements:
|
336
322
|
- - "~>"
|
337
323
|
- !ruby/object:Gem::Version
|
338
|
-
version: '2.
|
324
|
+
version: '2.6'
|
339
325
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
340
326
|
requirements:
|
341
327
|
- - ">="
|
342
328
|
- !ruby/object:Gem::Version
|
343
329
|
version: '0'
|
344
330
|
requirements: []
|
345
|
-
|
346
|
-
rubygems_version: 2.7.6
|
331
|
+
rubygems_version: 3.0.2
|
347
332
|
signing_key:
|
348
333
|
specification_version: 4
|
349
334
|
summary: A command line interface for generating table of contents for Markdown files.
|
metadata.gz.sig
CHANGED
Binary file
|