yard-junk 0.0.8 → 0.0.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +1 -1
- data/Changelog.md +9 -0
- data/Gemfile.lock +74 -50
- data/exe/yard-junk +3 -3
- data/lib/yard-junk/command_line.rb +2 -2
- data/lib/yard-junk/janitor/html_reporter.rb +1 -0
- data/lib/yard-junk/janitor/yard_options.rb +2 -2
- data/lib/yard-junk/janitor.rb +1 -1
- data/lib/yard-junk/logger/message.rb +1 -1
- data/lib/yard-junk/logger.rb +0 -1
- data/lib/yard-junk/version.rb +1 -1
- data/yard-junk.gemspec +3 -2
- metadata +19 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8dc5833695a57df20de4e0c4d6abad22785d9b254963779094170508b40d51f2
|
4
|
+
data.tar.gz: 81951e69c67feb19443227ac24b383334bef26e539e2f3aba827846d57bc68a5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 48f246b038763af91fe9bf4c58d6fcf48feaa935bfd824e59b4cbb8388b57dc02eaa31d456bc53f80cc80e92d64fd8a90fe2d52d5b5ab31367974fbedffb231f
|
7
|
+
data.tar.gz: 209adc9d8ca61d08d1a7c1e112e075f093fc49edd27b74a36c4b40488686c155c43ba2dc1265e73d255b675c51909b5931169d5f6de23a6449b75ff12882d37f
|
data/.github/workflows/ci.yml
CHANGED
data/Changelog.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
# Yard-Junk changelog
|
2
2
|
|
3
|
+
## 0.0.10 -- 2024-09-08
|
4
|
+
|
5
|
+
* Update to support newer Rubies (by [@pboling](https://github.com/pboling) at [#42](https://github.com/zverok/yard-junk/pull/42))
|
6
|
+
* Drop support for Ruby < 2.7
|
7
|
+
|
8
|
+
## 0.0.9 -- 2020-12-05
|
9
|
+
|
10
|
+
* Avoid deprecation warnings ([640bc355d](https://github.com/zverok/yard-junk/commit/640bc355d156e892348b80210fc034af25e196cf))
|
11
|
+
|
3
12
|
## 0.0.8 -- 2020-11-12
|
4
13
|
|
5
14
|
* Support Ruby 2.7 (and hopefully 3.0)
|
data/Gemfile.lock
CHANGED
@@ -1,72 +1,96 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
yard-junk (0.0.
|
4
|
+
yard-junk (0.0.10)
|
5
5
|
backports (>= 3.18)
|
6
|
+
ostruct
|
6
7
|
rainbow
|
7
8
|
yard
|
8
9
|
|
9
10
|
GEM
|
10
11
|
remote: https://rubygems.org/
|
11
12
|
specs:
|
12
|
-
ast (2.4.
|
13
|
-
backports (3.
|
14
|
-
diff-lcs (1.
|
15
|
-
docile (1.1
|
16
|
-
fakefs (
|
17
|
-
|
18
|
-
|
19
|
-
|
13
|
+
ast (2.4.2)
|
14
|
+
backports (3.25.0)
|
15
|
+
diff-lcs (1.5.1)
|
16
|
+
docile (1.4.1)
|
17
|
+
fakefs (2.5.0)
|
18
|
+
io-console (0.7.2)
|
19
|
+
io-console (0.7.2-java)
|
20
|
+
irb (1.14.0)
|
21
|
+
rdoc (>= 4.0.0)
|
22
|
+
reline (>= 0.4.2)
|
23
|
+
jar-dependencies (0.4.1)
|
24
|
+
json (2.7.2)
|
25
|
+
json (2.7.2-java)
|
26
|
+
kramdown (2.4.0)
|
20
27
|
rexml
|
21
|
-
|
22
|
-
|
28
|
+
language_server-protocol (3.17.0.3)
|
29
|
+
ostruct (0.6.0)
|
30
|
+
parallel (1.26.3)
|
31
|
+
parser (3.3.5.0)
|
23
32
|
ast (~> 2.4.1)
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
33
|
+
racc
|
34
|
+
psych (5.1.2)
|
35
|
+
stringio
|
36
|
+
psych (5.1.2-java)
|
37
|
+
jar-dependencies (>= 0.1.7)
|
38
|
+
racc (1.8.1)
|
39
|
+
racc (1.8.1-java)
|
40
|
+
rainbow (3.1.1)
|
41
|
+
rake (13.2.1)
|
42
|
+
rdoc (6.7.0)
|
43
|
+
psych (>= 4.0.0)
|
44
|
+
regexp_parser (2.9.2)
|
45
|
+
reline (0.5.10)
|
46
|
+
io-console (~> 0.5)
|
47
|
+
rexml (3.3.7)
|
48
|
+
rspec (3.13.0)
|
49
|
+
rspec-core (~> 3.13.0)
|
50
|
+
rspec-expectations (~> 3.13.0)
|
51
|
+
rspec-mocks (~> 3.13.0)
|
52
|
+
rspec-core (3.13.1)
|
53
|
+
rspec-support (~> 3.13.0)
|
54
|
+
rspec-expectations (3.13.2)
|
35
55
|
diff-lcs (>= 1.2.0, < 2.0)
|
36
|
-
rspec-support (~> 3.
|
37
|
-
rspec-its (1.
|
56
|
+
rspec-support (~> 3.13.0)
|
57
|
+
rspec-its (1.3.0)
|
38
58
|
rspec-core (>= 3.0.0)
|
39
59
|
rspec-expectations (>= 3.0.0)
|
40
|
-
rspec-mocks (3.
|
60
|
+
rspec-mocks (3.13.1)
|
41
61
|
diff-lcs (>= 1.2.0, < 2.0)
|
42
|
-
rspec-support (~> 3.
|
43
|
-
rspec-support (3.
|
44
|
-
rubocop (1.
|
62
|
+
rspec-support (~> 3.13.0)
|
63
|
+
rspec-support (3.13.1)
|
64
|
+
rubocop (1.66.1)
|
65
|
+
json (~> 2.3)
|
66
|
+
language_server-protocol (>= 3.17.0)
|
45
67
|
parallel (~> 1.10)
|
46
|
-
parser (>=
|
68
|
+
parser (>= 3.3.0.2)
|
47
69
|
rainbow (>= 2.2.2, < 4.0)
|
48
|
-
regexp_parser (>=
|
49
|
-
|
50
|
-
rubocop-ast (>= 1.1.1)
|
70
|
+
regexp_parser (>= 2.4, < 3.0)
|
71
|
+
rubocop-ast (>= 1.32.2, < 2.0)
|
51
72
|
ruby-progressbar (~> 1.7)
|
52
|
-
unicode-display_width (>=
|
53
|
-
rubocop-ast (1.
|
54
|
-
parser (>=
|
55
|
-
rubocop-rspec (
|
56
|
-
rubocop (~> 1.
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
73
|
+
unicode-display_width (>= 2.4.0, < 3.0)
|
74
|
+
rubocop-ast (1.32.3)
|
75
|
+
parser (>= 3.3.1.0)
|
76
|
+
rubocop-rspec (3.0.4)
|
77
|
+
rubocop (~> 1.61)
|
78
|
+
ruby-progressbar (1.13.0)
|
79
|
+
ruby2_keywords (0.0.5)
|
80
|
+
rubygems-tasks (0.2.6)
|
81
|
+
irb (~> 1.0)
|
82
|
+
rake (>= 10.0.0)
|
83
|
+
saharspec (0.0.10)
|
62
84
|
ruby2_keywords
|
63
|
-
simplecov (0.
|
64
|
-
docile (~> 1.1
|
65
|
-
|
66
|
-
|
67
|
-
simplecov-html (0.
|
68
|
-
|
69
|
-
|
85
|
+
simplecov (0.22.0)
|
86
|
+
docile (~> 1.1)
|
87
|
+
simplecov-html (~> 0.11)
|
88
|
+
simplecov_json_formatter (~> 0.1)
|
89
|
+
simplecov-html (0.12.3)
|
90
|
+
simplecov_json_formatter (0.1.4)
|
91
|
+
stringio (3.1.1)
|
92
|
+
unicode-display_width (2.5.0)
|
93
|
+
yard (0.9.37)
|
70
94
|
|
71
95
|
PLATFORMS
|
72
96
|
java
|
@@ -87,4 +111,4 @@ DEPENDENCIES
|
|
87
111
|
yard-junk!
|
88
112
|
|
89
113
|
BUNDLED WITH
|
90
|
-
|
114
|
+
2.4.22
|
data/exe/yard-junk
CHANGED
@@ -14,7 +14,7 @@ OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
|
|
14
14
|
opts.banner = 'Usage: yard-junk [formatters]'
|
15
15
|
opts.separator ''
|
16
16
|
opts.separator 'Formatters'
|
17
|
-
opts.separator '(you can use several at once, for example --text to print in console '\
|
17
|
+
opts.separator '(you can use several at once, for example --text to print in console ' \
|
18
18
|
'and --html to save HTML report somewhere)'
|
19
19
|
opts.separator 'Default is: text formatter, printing to STDOUT.'
|
20
20
|
opts.separator ''
|
@@ -32,13 +32,13 @@ OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
|
|
32
32
|
opts.separator 'Other options'
|
33
33
|
|
34
34
|
opts.on('-f', '--path PATTERN1,PATTERN2,PATTERN3',
|
35
|
-
'Limit output only to this files. '\
|
35
|
+
'Limit output only to this files. ' \
|
36
36
|
'Can be path to file or folder, or glob pattern') do |patterns|
|
37
37
|
options[:pathes] = patterns.split(',')
|
38
38
|
end
|
39
39
|
|
40
40
|
opts.on('-s', '--sanity',
|
41
|
-
'Sanity check for docs: just catch mistyped tags and similar stuff. '\
|
41
|
+
'Sanity check for docs: just catch mistyped tags and similar stuff. ' \
|
42
42
|
'On large codebases, MUCH faster than full check.') do
|
43
43
|
options[:mode] = :sanity
|
44
44
|
end
|
@@ -9,13 +9,13 @@ module YardJunk
|
|
9
9
|
opts.separator 'YardJunk plugin options'
|
10
10
|
|
11
11
|
opts.on('--junk-log-format [FMT]',
|
12
|
-
'YardJunk::Logger format string, by default '\
|
12
|
+
'YardJunk::Logger format string, by default ' \
|
13
13
|
"#{Logger::Message::DEFAULT_FORMAT.inspect}") do |format|
|
14
14
|
Logger.instance.format = format
|
15
15
|
end
|
16
16
|
|
17
17
|
opts.on('--junk-log-ignore [TYPE1,TYPE2,...]',
|
18
|
-
'YardJunk::Logger message types to ignore, by default '\
|
18
|
+
'YardJunk::Logger message types to ignore, by default ' \
|
19
19
|
"#{Logger::DEFAULT_IGNORE.map(&:inspect).join(', ')}") do |ignore|
|
20
20
|
Logger.instance.ignore = ignore.to_s.split(',')
|
21
21
|
end
|
@@ -15,7 +15,7 @@ module YardJunk
|
|
15
15
|
@extra_files = internal.options.files
|
16
16
|
end
|
17
17
|
|
18
|
-
def set_files(*files)
|
18
|
+
def set_files(*files)
|
19
19
|
# TODO: REALLY fragile :(
|
20
20
|
@files, @extra_files = files.partition { |f| f =~ /\.(rb|c|cxx|cpp|rake)/ }
|
21
21
|
self
|
@@ -34,7 +34,7 @@ module YardJunk
|
|
34
34
|
|
35
35
|
def to_a
|
36
36
|
(@options + @files)
|
37
|
-
.tap { |res| res.
|
37
|
+
.tap { |res| res.push('-', *@extra_files) unless @extra_files.empty? }
|
38
38
|
end
|
39
39
|
|
40
40
|
# The easiest way to think like Yardoc is to become Yardoc, you know.
|
data/lib/yard-junk/janitor.rb
CHANGED
@@ -39,7 +39,7 @@ module YardJunk
|
|
39
39
|
reporter.section('Errors', 'severe code or formatting problems', errors)
|
40
40
|
reporter.section('Problems', 'mistyped tags or other typos in documentation', problems)
|
41
41
|
|
42
|
-
reporter.stats(stats)
|
42
|
+
reporter.stats(**stats)
|
43
43
|
reporter.finalize
|
44
44
|
end
|
45
45
|
|
data/lib/yard-junk/logger.rb
CHANGED
data/lib/yard-junk/version.rb
CHANGED
data/yard-junk.gemspec
CHANGED
@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
|
|
5
5
|
s.version = YardJunk::VERSION
|
6
6
|
s.authors = ['Victor Shepelev']
|
7
7
|
s.email = 'zverok.offline@gmail.com'
|
8
|
-
s.homepage = 'https://github.com/zverok/
|
8
|
+
s.homepage = 'https://github.com/zverok/yard-junk'
|
9
9
|
|
10
10
|
s.summary = 'Get rid of the junk in your YARD docs'
|
11
11
|
s.description = <<-EOF
|
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
|
|
13
13
|
EOF
|
14
14
|
s.licenses = ['MIT']
|
15
15
|
|
16
|
-
s.required_ruby_version = '>= 2.
|
16
|
+
s.required_ruby_version = '>= 2.7.0'
|
17
17
|
|
18
18
|
s.files = `git ls-files`.split($RS).reject do |file|
|
19
19
|
file =~ /^(?:
|
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
|
|
37
37
|
s.add_dependency 'did_you_mean' if RUBY_VERSION < '2.3'
|
38
38
|
s.add_dependency 'backports', '>= 3.18'
|
39
39
|
s.add_dependency 'rainbow'
|
40
|
+
s.add_dependency 'ostruct'
|
40
41
|
|
41
42
|
s.add_development_dependency 'rubocop'
|
42
43
|
s.add_development_dependency 'rspec', '>= 3'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-junk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.10
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Victor Shepelev
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-09-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: yard
|
@@ -52,6 +52,20 @@ dependencies:
|
|
52
52
|
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: ostruct
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
55
69
|
- !ruby/object:Gem::Dependency
|
56
70
|
name: rubocop
|
57
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -238,7 +252,7 @@ files:
|
|
238
252
|
- lib/yard-junk/rake.rb
|
239
253
|
- lib/yard-junk/version.rb
|
240
254
|
- yard-junk.gemspec
|
241
|
-
homepage: https://github.com/zverok/
|
255
|
+
homepage: https://github.com/zverok/yard-junk
|
242
256
|
licenses:
|
243
257
|
- MIT
|
244
258
|
metadata: {}
|
@@ -250,14 +264,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
250
264
|
requirements:
|
251
265
|
- - ">="
|
252
266
|
- !ruby/object:Gem::Version
|
253
|
-
version: 2.
|
267
|
+
version: 2.7.0
|
254
268
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
255
269
|
requirements:
|
256
270
|
- - ">="
|
257
271
|
- !ruby/object:Gem::Version
|
258
272
|
version: '0'
|
259
273
|
requirements: []
|
260
|
-
rubygems_version: 3.
|
274
|
+
rubygems_version: 3.4.10
|
261
275
|
signing_key:
|
262
276
|
specification_version: 4
|
263
277
|
summary: Get rid of the junk in your YARD docs
|