Skip to content

Commit d541654

Browse files
authored
[1.2.0] Add configurable tag sorting and simplify CLI update strategies (#12)
1 parent 0eb787c commit d541654

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2714
-1152
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
cd test_project
3434
bundle install
3535
FILES="$(cd .. && git ls-files 'lib/**/*.rb' | sed 's|^|../|')"
36-
bundle exec docscribe --dry $FILES -C ../docscribe.yml
36+
bundle exec docscribe $FILES -C ../docscribe.yml
3737
3838
- name: RuboCop (self‑check)
3939
run: bundle exec rubocop

.rubocop_todo.yml

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# This configuration was generated by
22
# `rubocop --auto-gen-config`
3-
# on 2026-03-17 21:48:54 UTC using RuboCop version 1.84.0.
3+
# on 2026-03-20 20:43:43 UTC using RuboCop version 1.84.0.
44
# The point is for the user to remove these configuration records
55
# one by one as the offenses are removed from the code base.
66
# Note that changes in the inspected code, or installation of new
@@ -13,12 +13,12 @@ Gemspec/DevelopmentDependencies:
1313
Exclude:
1414
- 'docscribe.gemspec'
1515

16-
# Offense count: 29
16+
# Offense count: 34
1717
# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
1818
Metrics/AbcSize:
19-
Max: 99
19+
Max: 113
2020

21-
# Offense count: 5
21+
# Offense count: 4
2222
# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
2323
# AllowedMethods: refine
2424
Metrics/BlockLength:
@@ -29,35 +29,35 @@ Metrics/BlockLength:
2929
Metrics/BlockNesting:
3030
Max: 4
3131

32-
# Offense count: 2
32+
# Offense count: 3
3333
# Configuration parameters: CountComments, CountAsOne.
3434
Metrics/ClassLength:
3535
Max: 307
3636

37-
# Offense count: 28
37+
# Offense count: 29
3838
# Configuration parameters: AllowedMethods, AllowedPatterns.
3939
Metrics/CyclomaticComplexity:
4040
Max: 41
4141

42-
# Offense count: 41
42+
# Offense count: 55
4343
# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
4444
Metrics/MethodLength:
45-
Max: 99
45+
Max: 122
4646

47-
# Offense count: 3
47+
# Offense count: 6
4848
# Configuration parameters: CountComments, CountAsOne.
4949
Metrics/ModuleLength:
50-
Max: 309
50+
Max: 393
5151

52-
# Offense count: 2
52+
# Offense count: 8
5353
# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
5454
Metrics/ParameterLists:
55-
Max: 7
55+
Max: 9
5656

57-
# Offense count: 22
57+
# Offense count: 23
5858
# Configuration parameters: AllowedMethods, AllowedPatterns.
5959
Metrics/PerceivedComplexity:
60-
Max: 36
60+
Max: 45
6161

6262
# Offense count: 9
6363
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
@@ -82,12 +82,12 @@ Naming/PredicateMethod:
8282
RSpec/DescribeClass:
8383
Enabled: false
8484

85-
# Offense count: 103
85+
# Offense count: 113
8686
# Configuration parameters: CountAsOne.
8787
RSpec/ExampleLength:
8888
Max: 32
8989

90-
# Offense count: 91
90+
# Offense count: 98
9191
RSpec/MultipleExpectations:
9292
Max: 6
9393

@@ -98,7 +98,7 @@ SortedMethodsByCall/Waterfall:
9898
Exclude:
9999
- 'lib/docscribe/parsing.rb'
100100

101-
# Offense count: 12
101+
# Offense count: 13
102102
# Configuration parameters: AllowedConstants.
103103
Style/Documentation:
104104
Exclude:
@@ -114,14 +114,16 @@ Style/Documentation:
114114
- 'lib/docscribe/config/filtering.rb'
115115
- 'lib/docscribe/config/loader.rb'
116116
- 'lib/docscribe/config/rbs.rb'
117+
- 'lib/docscribe/config/sorting.rb'
117118
- 'lib/docscribe/config/template.rb'
118119
- 'lib/docscribe/config/utils.rb'
119120

120-
# Offense count: 2
121+
# Offense count: 3
121122
# This cop supports safe autocorrection (--autocorrect).
122123
Style/IfUnlessModifier:
123124
Exclude:
124125
- 'lib/docscribe/config/filtering.rb'
126+
- 'lib/docscribe/inline_rewriter.rb'
125127
- 'lib/docscribe/inline_rewriter/doc_builder.rb'
126128

127129
# Offense count: 6
@@ -130,9 +132,9 @@ Style/SafeNavigationChainLength:
130132
Exclude:
131133
- 'lib/docscribe/inline_rewriter/doc_builder.rb'
132134

133-
# Offense count: 6
135+
# Offense count: 9
134136
# This cop supports safe autocorrection (--autocorrect).
135137
# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
136138
# URISchemes: http, https
137139
Layout/LineLength:
138-
Max: 130
140+
Max: 147

0 commit comments

Comments
 (0)