jazzy 0.15.3 → 0.15.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/Tests.yml +4 -4
- data/.rubocop.yml +71 -1
- data/CHANGELOG.md +36 -3
- data/CONTRIBUTING.md +1 -1
- data/Gemfile.lock +82 -64
- data/README.md +13 -1
- data/jazzy.gemspec +2 -0
- data/js/package-lock.json +10 -5
- data/lib/jazzy/doc_builder.rb +2 -2
- data/lib/jazzy/doc_index.rb +12 -1
- data/lib/jazzy/docset_builder.rb +1 -1
- data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
- data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/grouper.rb +25 -15
- data/lib/jazzy/podspec_documenter.rb +2 -0
- data/lib/jazzy/source_declaration/type.rb +3 -2
- data/lib/jazzy/source_declaration.rb +16 -1
- data/lib/jazzy/sourcekitten.rb +13 -11
- data/lib/jazzy/symbol_graph/constraint.rb +3 -2
- data/lib/jazzy/symbol_graph/graph.rb +1 -1
- data/lib/jazzy/symbol_graph/sym_node.rb +1 -1
- metadata +37 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f99a69babed72b2f5c277beca7068ef6d49e6367251f36e4630352fd40929c73
|
4
|
+
data.tar.gz: 025bcd88cacf17a6627c2fc4c3f341a46db8da83324cf45c50ec21a98c1b129a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4f986fca818444ab04ccc43f9c0c601412a06fea9eec0e7443a7467f8716fd53b7abc5064c48cdc9c390162bd6ebae441e9b90de2b91fb1a363d47b9439e44c2
|
7
|
+
data.tar.gz: 9093d563676ddb2b6de9de7b654b55f41cfd63c36e86529d7d5588b05cf00c648b2b7fe11fa66cb726dd6e6d8fa5476c11b311eba8bf275bcfce20014d6e3925
|
data/.github/workflows/Tests.yml
CHANGED
@@ -13,7 +13,7 @@ jobs:
|
|
13
13
|
- uses: actions/checkout@v4
|
14
14
|
- uses: ruby/setup-ruby@v1
|
15
15
|
with:
|
16
|
-
ruby-version: 3.
|
16
|
+
ruby-version: 3.3
|
17
17
|
bundler-cache: true
|
18
18
|
- name: Rubocop
|
19
19
|
run: |
|
@@ -25,7 +25,7 @@ jobs:
|
|
25
25
|
bundle exec danger --verbose
|
26
26
|
|
27
27
|
spec:
|
28
|
-
runs-on: macos-
|
28
|
+
runs-on: macos-15
|
29
29
|
continue-on-error: true
|
30
30
|
strategy:
|
31
31
|
matrix:
|
@@ -37,10 +37,10 @@ jobs:
|
|
37
37
|
persist-credentials: false
|
38
38
|
- uses: maxim-lobanov/setup-xcode@v1
|
39
39
|
with:
|
40
|
-
xcode-version: '
|
40
|
+
xcode-version: '26.1.0-beta'
|
41
41
|
- uses: ruby/setup-ruby@v1
|
42
42
|
with:
|
43
|
-
ruby-version: 3.
|
43
|
+
ruby-version: 3.3
|
44
44
|
bundler-cache: true
|
45
45
|
- name: Cache cocoapods
|
46
46
|
uses: actions/cache@v4
|
data/.rubocop.yml
CHANGED
@@ -8,16 +8,20 @@ AllCops:
|
|
8
8
|
SuggestExtensions: false
|
9
9
|
TargetRubyVersion: 2.6
|
10
10
|
|
11
|
-
#- Pending Cops as of 1.
|
11
|
+
#- Pending Cops as of 1.81.1 ---------------------------------------------#
|
12
12
|
|
13
13
|
Gemspec/AddRuntimeDependency: # new in 1.65
|
14
14
|
Enabled: true
|
15
|
+
Gemspec/AttributeAssignment: # new in 1.77
|
16
|
+
Enabled: true
|
15
17
|
Gemspec/DeprecatedAttributeAssignment: # new in 1.30
|
16
18
|
Enabled: true
|
17
19
|
Gemspec/DevelopmentDependencies: # new in 1.44
|
18
20
|
Enabled: false
|
19
21
|
Gemspec/RequireMFA: # new in 1.23
|
20
22
|
Enabled: true
|
23
|
+
Layout/EmptyLinesAfterModuleInclusion: # new in 1.79
|
24
|
+
Enabled: true
|
21
25
|
Layout/LineContinuationLeadingSpace: # new in 1.31
|
22
26
|
Enabled: false
|
23
27
|
Layout/LineContinuationSpacing: # new in 1.31
|
@@ -28,8 +32,14 @@ Lint/AmbiguousAssignment: # (new in 1.7)
|
|
28
32
|
Enabled: true
|
29
33
|
Lint/AmbiguousRange: # (new in 1.19)
|
30
34
|
Enabled: true
|
35
|
+
Lint/ArrayLiteralInRegexp: # new in 1.71
|
36
|
+
Enabled: true
|
31
37
|
Lint/ConstantOverwrittenInRescue: # new in 1.31
|
32
38
|
Enabled: true
|
39
|
+
Lint/ConstantReassignment: # new in 1.70
|
40
|
+
Enabled: true
|
41
|
+
Lint/CopDirectiveSyntax: # new in 1.72
|
42
|
+
Enabled: true
|
33
43
|
Lint/DeprecatedConstants: # (new in 1.8)
|
34
44
|
Enabled: true
|
35
45
|
Lint/DuplicateBranch: # (new in 1.3)
|
@@ -40,12 +50,16 @@ Lint/DuplicateMatchPattern: # new in 1.50
|
|
40
50
|
Enabled: true
|
41
51
|
Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
|
42
52
|
Enabled: true
|
53
|
+
Lint/DuplicateSetElement: # new in 1.67
|
54
|
+
Enabled: true
|
43
55
|
Lint/EmptyBlock: # (new in 1.1)
|
44
56
|
Enabled: true
|
45
57
|
Lint/EmptyClass: # (new in 1.3)
|
46
58
|
Enabled: true
|
47
59
|
Lint/EmptyInPattern: # (new in 1.16)
|
48
60
|
Enabled: true
|
61
|
+
Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
|
62
|
+
Enabled: true
|
49
63
|
Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
|
50
64
|
Enabled: true
|
51
65
|
Lint/ItWithoutArgumentsInBlock: # new in 1.59
|
@@ -62,30 +76,48 @@ Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
|
|
62
76
|
Enabled: true
|
63
77
|
Lint/NumberedParameterAssignment: # (new in 1.9)
|
64
78
|
Enabled: true
|
79
|
+
Lint/NumericOperationWithConstantResult: # new in 1.69
|
80
|
+
Enabled: true
|
65
81
|
Lint/OrAssignmentToConstant: # (new in 1.9)
|
66
82
|
Enabled: true
|
67
83
|
Lint/RedundantDirGlobSort: # (new in 1.8)
|
68
84
|
Enabled: true
|
69
85
|
Lint/RedundantRegexpQuantifiers: # new in 1.53
|
70
86
|
Enabled: true
|
87
|
+
Lint/RedundantTypeConversion: # new in 1.72
|
88
|
+
Enabled: true
|
71
89
|
Lint/RefinementImportMethods: # new in 1.27
|
72
90
|
Enabled: true
|
73
91
|
Lint/RequireRangeParentheses: # new in 1.32
|
74
92
|
Enabled: true
|
75
93
|
Lint/RequireRelativeSelfPath: # new in 1.22
|
76
94
|
Enabled: true
|
95
|
+
Lint/SharedMutableDefault: # new in 1.70
|
96
|
+
Enabled: true
|
97
|
+
Lint/SuppressedExceptionInNumberConversion: # new in 1.72
|
98
|
+
Enabled: true
|
77
99
|
Lint/SymbolConversion: # (new in 1.9)
|
78
100
|
Enabled: true
|
79
101
|
Lint/ToEnumArguments: # (new in 1.1)
|
80
102
|
Enabled: true
|
81
103
|
Lint/TripleQuotes: # (new in 1.9)
|
82
104
|
Enabled: true
|
105
|
+
Lint/UnescapedBracketInRegexp: # new in 1.68
|
106
|
+
Enabled: true
|
83
107
|
Lint/UnexpectedBlockArity: # (new in 1.5)
|
84
108
|
Enabled: true
|
85
109
|
Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
|
86
110
|
Enabled: true
|
111
|
+
Lint/UselessConstantScoping: # new in 1.72
|
112
|
+
Enabled: true
|
113
|
+
Lint/UselessDefaultValueArgument: # new in 1.76
|
114
|
+
Enabled: true
|
115
|
+
Lint/UselessDefined: # new in 1.69
|
116
|
+
Enabled: true
|
87
117
|
Lint/UselessNumericOperation: # new in 1.66
|
88
118
|
Enabled: true
|
119
|
+
Lint/UselessOr: # new in 1.76
|
120
|
+
Enabled: true
|
89
121
|
Lint/UselessRescue: # new in 1.43
|
90
122
|
Enabled: true
|
91
123
|
Lint/UselessRuby2Keywords: # new in 1.23
|
@@ -96,28 +128,46 @@ Naming/BlockForwarding: # new in 1.24
|
|
96
128
|
Enabled: true
|
97
129
|
Naming/InclusiveLanguage: # (new in 1.18)
|
98
130
|
Enabled: true
|
131
|
+
Naming/PredicateMethod: # new in 1.76
|
132
|
+
Enabled: true
|
99
133
|
Security/CompoundHash: # new in 1.28
|
100
134
|
Enabled: true
|
135
|
+
Style/BitwisePredicate: # new in 1.68
|
136
|
+
Enabled: true
|
137
|
+
Style/CombinableDefined: # new in 1.68
|
138
|
+
Enabled: true
|
139
|
+
Style/ComparableBetween: # new in 1.74
|
140
|
+
Enabled: true
|
101
141
|
Style/ConcatArrayLiterals: # new in 1.41
|
102
142
|
Enabled: true
|
103
143
|
Security/IoMethods: # new in 1.22
|
104
144
|
Enabled: true
|
145
|
+
Style/AmbiguousEndlessMethodDefinition: # new in 1.68
|
146
|
+
Enabled: true
|
105
147
|
Style/ArgumentsForwarding: # (new in 1.1)
|
106
148
|
Enabled: true
|
107
149
|
Style/ArrayIntersect: # new in 1.40
|
108
150
|
Enabled: true
|
151
|
+
Style/ArrayIntersectWithSingleElement: # new in 1.81
|
152
|
+
Enabled: true
|
109
153
|
Style/CollectionCompact: # (new in 1.2)
|
110
154
|
Enabled: true
|
155
|
+
Style/CollectionQuerying: # new in 1.77
|
156
|
+
Enabled: true
|
111
157
|
Style/ComparableClamp: # new in 1.44
|
112
158
|
Enabled: true
|
113
159
|
Style/DataInheritance: # new in 1.49
|
114
160
|
Enabled: true
|
161
|
+
Style/DigChain: # new in 1.69
|
162
|
+
Enabled: true
|
115
163
|
Style/DirEmpty: # new in 1.48
|
116
164
|
Enabled: true
|
117
165
|
Style/DocumentDynamicEvalDefinition: # (new in 1.1)
|
118
166
|
Enabled: true
|
119
167
|
Style/EmptyHeredoc: # new in 1.32
|
120
168
|
Enabled: true
|
169
|
+
Style/EmptyStringInsideInterpolation: # new in 1.76
|
170
|
+
Enabled: true
|
121
171
|
Style/EndlessMethod: # (new in 1.8)
|
122
172
|
Enabled: true
|
123
173
|
Style/EnvHome: # new in 1.29
|
@@ -128,18 +178,32 @@ Style/FetchEnvVar: # new in 1.28
|
|
128
178
|
Enabled: true
|
129
179
|
Style/FileEmpty: # new in 1.48
|
130
180
|
Enabled: true
|
181
|
+
Style/FileNull: # new in 1.69
|
182
|
+
Enabled: true
|
131
183
|
Style/FileRead: # new in 1.24
|
132
184
|
Enabled: true
|
185
|
+
Style/FileTouch: # new in 1.69
|
186
|
+
Enabled: true
|
133
187
|
Style/FileWrite: # new in 1.24
|
134
188
|
Enabled: true
|
135
189
|
Style/HashConversion: # (new in 1.10)
|
136
190
|
Enabled: true
|
137
191
|
Style/HashExcept: # (new in 1.7)
|
138
192
|
Enabled: true
|
193
|
+
Style/HashFetchChain: # new in 1.75
|
194
|
+
Enabled: true
|
195
|
+
Style/HashSlice: # new in 1.71
|
196
|
+
Enabled: true
|
139
197
|
Style/IfWithBooleanLiteralBranches: # (new in 1.9)
|
140
198
|
Enabled: true
|
141
199
|
Style/InPatternThen: # (new in 1.16)
|
142
200
|
Enabled: true
|
201
|
+
Style/ItAssignment: # new in 1.70
|
202
|
+
Enabled: true
|
203
|
+
Style/ItBlockParameter: # new in 1.75
|
204
|
+
Enabled: true
|
205
|
+
Style/KeywordArgumentsMerging: # new in 1.68
|
206
|
+
Enabled: true
|
143
207
|
Style/MagicCommentFormat: # new in 1.35
|
144
208
|
Enabled: true
|
145
209
|
Style/MapCompactWithConditionalBlock: # new in 1.30
|
@@ -176,6 +240,8 @@ Style/RedundantArgument: # (new in 1.4)
|
|
176
240
|
Enabled: true
|
177
241
|
Style/RedundantArrayConstructor: # new in 1.52
|
178
242
|
Enabled: true
|
243
|
+
Style/RedundantArrayFlatten: # new in 1.76
|
244
|
+
Enabled: true
|
179
245
|
Style/RedundantConstantBase: # new in 1.40
|
180
246
|
Enabled: true
|
181
247
|
Style/RedundantCurrentDirectoryInPath: # new in 1.53
|
@@ -186,6 +252,8 @@ Style/RedundantEach: # new in 1.38
|
|
186
252
|
Enabled: true
|
187
253
|
Style/RedundantFilterChain: # new in 1.52
|
188
254
|
Enabled: true
|
255
|
+
Style/RedundantFormat: # new in 1.72
|
256
|
+
Enabled: true
|
189
257
|
Style/RedundantHeredocDelimiterQuotes: # new in 1.45
|
190
258
|
Enabled: true
|
191
259
|
Style/RedundantInitialize: # new in 1.27
|
@@ -204,6 +272,8 @@ Style/RedundantStringEscape: # new in 1.37
|
|
204
272
|
Enabled: true
|
205
273
|
Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
|
206
274
|
Enabled: true
|
275
|
+
Style/SafeNavigationChainLength: # new in 1.68
|
276
|
+
Enabled: true
|
207
277
|
Style/SelectByRegexp: # new in 1.22
|
208
278
|
Enabled: true
|
209
279
|
Style/SendWithLiteralMethodName: # new in 1.64
|
data/CHANGELOG.md
CHANGED
@@ -1,4 +1,37 @@
|
|
1
|
-
##
|
1
|
+
## 0.15.4
|
2
|
+
|
3
|
+
##### Breaking
|
4
|
+
|
5
|
+
* None.
|
6
|
+
|
7
|
+
##### Enhancements
|
8
|
+
|
9
|
+
* Allow `custom_categories` to specify a regex for a child.
|
10
|
+
[Enrico Zannini](https://github.com/Enricoza)
|
11
|
+
[#688](https://github.com/realm/jazzy/issues/688)
|
12
|
+
|
13
|
+
* Update Javascript: KaTeX 0.16.25
|
14
|
+
[John Fairhurst](https://github.com/johnfairh)
|
15
|
+
|
16
|
+
##### Bug Fixes
|
17
|
+
|
18
|
+
* Don't call extension members that do not need documentation
|
19
|
+
'undocumented'.
|
20
|
+
[John Fairhurst](https://github.com/johnfairh)
|
21
|
+
|
22
|
+
* Work around activesupport vs. concurrent-ruby crash.
|
23
|
+
[John Fairhurst](https://github.com/johnfairh)
|
24
|
+
[#1414](https://github.com/realm/jazzy/issues/1414)
|
25
|
+
|
26
|
+
* Better identify default implementations.
|
27
|
+
[John Fairhurst](https://github.com/johnfairh)
|
28
|
+
[#1420](https://github.com/realm/jazzy/issues/1420)
|
29
|
+
|
30
|
+
* Suppress warning on extensions providing default implementations.
|
31
|
+
[John Fairhurst](https://github.com/johnfairh)
|
32
|
+
[#1396](https://github.com/realm/jazzy/issues/1396)
|
33
|
+
|
34
|
+
## 0.15.3
|
2
35
|
|
3
36
|
##### Breaking
|
4
37
|
|
@@ -10,8 +43,8 @@
|
|
10
43
|
|
11
44
|
##### Bug Fixes
|
12
45
|
|
13
|
-
* Don't crash when the Swift 6 compiler reports
|
14
|
-
notes.
|
46
|
+
* Don't crash in SourceKitten when the Swift 6 compiler reports
|
47
|
+
educational notes.
|
15
48
|
[John Fairhurst](https://github.com/johnfairh)
|
16
49
|
[#1399](https://github.com/realm/jazzy/issues/1399)
|
17
50
|
|
data/CONTRIBUTING.md
CHANGED
@@ -49,7 +49,7 @@ git push
|
|
49
49
|
You'll need push access to the integration specs repo to do this. You can
|
50
50
|
request access from one of the maintainers when filing your PR.
|
51
51
|
|
52
|
-
You must have Xcode
|
52
|
+
You must have Xcode 26.1 beta 1 installed to build the integration specs.
|
53
53
|
|
54
54
|
## Making changes to SourceKitten
|
55
55
|
|
data/Gemfile.lock
CHANGED
@@ -9,8 +9,10 @@ GIT
|
|
9
9
|
PATH
|
10
10
|
remote: .
|
11
11
|
specs:
|
12
|
-
jazzy (0.15.
|
12
|
+
jazzy (0.15.4)
|
13
|
+
activesupport (>= 5.0, < 8)
|
13
14
|
cocoapods (~> 1.5)
|
15
|
+
logger
|
14
16
|
mustache (~> 1.1)
|
15
17
|
open4 (~> 1.3)
|
16
18
|
redcarpet (~> 3.4)
|
@@ -27,8 +29,9 @@ GEM
|
|
27
29
|
base64
|
28
30
|
nkf
|
29
31
|
rexml
|
30
|
-
activesupport (7.2.
|
32
|
+
activesupport (7.2.2.2)
|
31
33
|
base64
|
34
|
+
benchmark (>= 0.3)
|
32
35
|
bigdecimal
|
33
36
|
concurrent-ruby (~> 1.0, >= 1.3.1)
|
34
37
|
connection_pool (>= 2.2.5)
|
@@ -43,20 +46,21 @@ GEM
|
|
43
46
|
algoliasearch (1.27.5)
|
44
47
|
httpclient (~> 2.8, >= 2.8.3)
|
45
48
|
json (>= 1.5.1)
|
46
|
-
ast (2.4.
|
49
|
+
ast (2.4.3)
|
47
50
|
atomos (0.1.3)
|
48
51
|
bacon (1.2.0)
|
49
|
-
base64 (0.
|
50
|
-
|
52
|
+
base64 (0.3.0)
|
53
|
+
benchmark (0.4.1)
|
54
|
+
bigdecimal (3.3.1)
|
51
55
|
claide (1.1.0)
|
52
56
|
claide-plugins (0.9.2)
|
53
57
|
cork
|
54
58
|
nap
|
55
59
|
open4 (~> 1.3)
|
56
|
-
cocoapods (1.
|
60
|
+
cocoapods (1.16.2)
|
57
61
|
addressable (~> 2.8)
|
58
62
|
claide (>= 1.0.2, < 2.0)
|
59
|
-
cocoapods-core (= 1.
|
63
|
+
cocoapods-core (= 1.16.2)
|
60
64
|
cocoapods-deintegrate (>= 1.0.3, < 2.0)
|
61
65
|
cocoapods-downloader (>= 2.1, < 3.0)
|
62
66
|
cocoapods-plugins (>= 1.0.0, < 2.0)
|
@@ -70,8 +74,8 @@ GEM
|
|
70
74
|
molinillo (~> 0.8.0)
|
71
75
|
nap (~> 1.0)
|
72
76
|
ruby-macho (>= 2.3.0, < 3.0)
|
73
|
-
xcodeproj (>= 1.
|
74
|
-
cocoapods-core (1.
|
77
|
+
xcodeproj (>= 1.27.0, < 2.0)
|
78
|
+
cocoapods-core (1.16.2)
|
75
79
|
activesupport (>= 5.0, < 8)
|
76
80
|
addressable (~> 2.8)
|
77
81
|
algoliasearch (~> 1.0)
|
@@ -91,102 +95,114 @@ GEM
|
|
91
95
|
netrc (~> 0.11)
|
92
96
|
cocoapods-try (1.2.0)
|
93
97
|
colored2 (3.1.2)
|
94
|
-
concurrent-ruby (1.3.
|
95
|
-
connection_pool (2.4
|
98
|
+
concurrent-ruby (1.3.5)
|
99
|
+
connection_pool (2.5.4)
|
96
100
|
cork (0.3.0)
|
97
101
|
colored2 (~> 3.1)
|
98
102
|
crack (1.0.0)
|
99
103
|
bigdecimal
|
100
104
|
rexml
|
101
|
-
danger (9.5.
|
105
|
+
danger (9.5.3)
|
106
|
+
base64 (~> 0.2)
|
102
107
|
claide (~> 1.0)
|
103
108
|
claide-plugins (>= 0.9.2)
|
104
|
-
colored2 (
|
109
|
+
colored2 (>= 3.1, < 5)
|
105
110
|
cork (~> 0.1)
|
106
111
|
faraday (>= 0.9.0, < 3.0)
|
107
112
|
faraday-http-cache (~> 2.0)
|
108
|
-
git (
|
109
|
-
kramdown (
|
113
|
+
git (>= 1.13, < 3.0)
|
114
|
+
kramdown (>= 2.5.1, < 3.0)
|
110
115
|
kramdown-parser-gfm (~> 1.0)
|
111
116
|
octokit (>= 4.0)
|
112
|
-
|
113
|
-
|
114
|
-
|
117
|
+
pstore (~> 0.1)
|
118
|
+
terminal-table (>= 1, < 5)
|
119
|
+
diffy (3.4.4)
|
120
|
+
drb (2.2.3)
|
115
121
|
escape (0.0.4)
|
116
|
-
ethon (0.
|
122
|
+
ethon (0.15.0)
|
117
123
|
ffi (>= 1.15.0)
|
118
|
-
faraday (2.
|
119
|
-
faraday-net_http (>= 2.0, < 3.
|
124
|
+
faraday (2.14.0)
|
125
|
+
faraday-net_http (>= 2.0, < 3.5)
|
120
126
|
json
|
121
127
|
logger
|
122
128
|
faraday-http-cache (2.5.1)
|
123
129
|
faraday (>= 0.8)
|
124
|
-
faraday-net_http (3.
|
125
|
-
net-http
|
126
|
-
ffi (1.17.
|
130
|
+
faraday-net_http (3.4.1)
|
131
|
+
net-http (>= 0.5.0)
|
132
|
+
ffi (1.17.2)
|
127
133
|
fourflusher (2.3.1)
|
128
134
|
fuzzy_match (2.0.4)
|
129
135
|
gh_inspector (1.1.3)
|
130
|
-
git (
|
136
|
+
git (2.3.3)
|
137
|
+
activesupport (>= 5.0)
|
131
138
|
addressable (~> 2.8)
|
139
|
+
process_executer (~> 1.1)
|
132
140
|
rchardet (~> 1.8)
|
133
|
-
hashdiff (1.
|
134
|
-
httpclient (2.
|
135
|
-
|
141
|
+
hashdiff (1.2.1)
|
142
|
+
httpclient (2.9.0)
|
143
|
+
mutex_m
|
144
|
+
i18n (1.14.7)
|
136
145
|
concurrent-ruby (~> 1.0)
|
137
|
-
json (2.
|
138
|
-
kramdown (2.
|
139
|
-
rexml
|
146
|
+
json (2.15.1)
|
147
|
+
kramdown (2.5.1)
|
148
|
+
rexml (>= 3.3.9)
|
140
149
|
kramdown-parser-gfm (1.1.0)
|
141
150
|
kramdown (~> 2.0)
|
142
|
-
language_server-protocol (3.17.0.
|
151
|
+
language_server-protocol (3.17.0.5)
|
143
152
|
liferaft (0.0.6)
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
153
|
+
lint_roller (1.1.0)
|
154
|
+
logger (1.7.0)
|
155
|
+
mini_portile2 (2.8.9)
|
156
|
+
minitest (5.26.0)
|
157
|
+
mocha (2.7.1)
|
148
158
|
ruby2_keywords (>= 0.0.5)
|
149
159
|
mocha-on-bacon (0.2.3)
|
150
160
|
mocha (>= 0.13.0)
|
151
161
|
molinillo (0.8.0)
|
152
162
|
mustache (1.1.1)
|
153
|
-
|
163
|
+
mutex_m (0.3.0)
|
164
|
+
nanaimo (0.4.0)
|
154
165
|
nap (1.1.0)
|
155
|
-
net-http (0.
|
166
|
+
net-http (0.6.0)
|
156
167
|
uri
|
157
168
|
netrc (0.11.0)
|
158
169
|
nkf (0.2.0)
|
159
|
-
octokit (
|
170
|
+
octokit (10.0.0)
|
160
171
|
faraday (>= 1, < 3)
|
161
172
|
sawyer (~> 0.9)
|
162
173
|
open4 (1.3.4)
|
163
|
-
parallel (1.
|
164
|
-
parser (3.3.
|
174
|
+
parallel (1.27.0)
|
175
|
+
parser (3.3.9.0)
|
165
176
|
ast (~> 2.4.1)
|
166
177
|
racc
|
167
178
|
prettybacon (0.0.2)
|
168
179
|
bacon (~> 1.2)
|
180
|
+
prism (1.6.0)
|
181
|
+
process_executer (1.3.0)
|
182
|
+
pstore (0.2.0)
|
169
183
|
public_suffix (4.0.7)
|
170
184
|
racc (1.8.1)
|
171
185
|
rainbow (3.1.1)
|
172
|
-
rake (13.
|
173
|
-
rchardet (1.
|
174
|
-
redcarpet (3.6.
|
175
|
-
regexp_parser (2.
|
176
|
-
rexml (3.
|
177
|
-
rouge (4.
|
178
|
-
rubocop (1.
|
186
|
+
rake (13.3.0)
|
187
|
+
rchardet (1.10.0)
|
188
|
+
redcarpet (3.6.1)
|
189
|
+
regexp_parser (2.11.3)
|
190
|
+
rexml (3.4.4)
|
191
|
+
rouge (4.6.1)
|
192
|
+
rubocop (1.81.1)
|
179
193
|
json (~> 2.3)
|
180
|
-
language_server-protocol (
|
194
|
+
language_server-protocol (~> 3.17.0.2)
|
195
|
+
lint_roller (~> 1.1.0)
|
181
196
|
parallel (~> 1.10)
|
182
197
|
parser (>= 3.3.0.2)
|
183
198
|
rainbow (>= 2.2.2, < 4.0)
|
184
|
-
regexp_parser (>= 2.
|
185
|
-
rubocop-ast (>= 1.
|
199
|
+
regexp_parser (>= 2.9.3, < 3.0)
|
200
|
+
rubocop-ast (>= 1.47.1, < 2.0)
|
186
201
|
ruby-progressbar (~> 1.7)
|
187
|
-
unicode-display_width (>= 2.4.0, <
|
188
|
-
rubocop-ast (1.
|
189
|
-
parser (>= 3.3.
|
202
|
+
unicode-display_width (>= 2.4.0, < 4.0)
|
203
|
+
rubocop-ast (1.47.1)
|
204
|
+
parser (>= 3.3.7.2)
|
205
|
+
prism (~> 1.4)
|
190
206
|
ruby-macho (2.5.1)
|
191
207
|
ruby-progressbar (1.13.0)
|
192
208
|
ruby2_keywords (0.0.5)
|
@@ -195,29 +211,31 @@ GEM
|
|
195
211
|
sawyer (0.9.2)
|
196
212
|
addressable (>= 2.3.5)
|
197
213
|
faraday (>= 0.17.3, < 3)
|
198
|
-
securerandom (0.
|
214
|
+
securerandom (0.4.1)
|
199
215
|
sqlite3 (1.7.3)
|
200
216
|
mini_portile2 (~> 2.8.0)
|
201
|
-
terminal-table (
|
202
|
-
unicode-display_width (>= 1.1.1, <
|
203
|
-
typhoeus (1.
|
204
|
-
ethon (>= 0.9.0)
|
217
|
+
terminal-table (4.0.0)
|
218
|
+
unicode-display_width (>= 1.1.1, < 4)
|
219
|
+
typhoeus (1.5.0)
|
220
|
+
ethon (>= 0.9.0, < 0.16.0)
|
205
221
|
tzinfo (2.0.6)
|
206
222
|
concurrent-ruby (~> 1.0)
|
207
|
-
unicode-display_width (2.
|
208
|
-
|
209
|
-
|
223
|
+
unicode-display_width (3.2.0)
|
224
|
+
unicode-emoji (~> 4.1)
|
225
|
+
unicode-emoji (4.1.0)
|
226
|
+
uri (1.0.4)
|
227
|
+
webmock (3.25.1)
|
210
228
|
addressable (>= 2.8.0)
|
211
229
|
crack (>= 0.3.2)
|
212
230
|
hashdiff (>= 0.4.0, < 2.0.0)
|
213
231
|
xcinvoke (0.3.0)
|
214
232
|
liferaft (~> 0.0.6)
|
215
|
-
xcodeproj (1.
|
233
|
+
xcodeproj (1.27.0)
|
216
234
|
CFPropertyList (>= 2.3.3, < 4.0)
|
217
235
|
atomos (~> 0.1.3)
|
218
236
|
claide (>= 1.0.2, < 2.0)
|
219
237
|
colored2 (~> 3.1)
|
220
|
-
nanaimo (~> 0.
|
238
|
+
nanaimo (~> 0.4.0)
|
221
239
|
rexml (>= 3.3.6, < 4.0)
|
222
240
|
|
223
241
|
PLATFORMS
|
data/README.md
CHANGED
@@ -453,7 +453,19 @@ like _Classes_ and _Structures_ corresponding to programming-language concepts,
|
|
453
453
|
as well as _Guides_ if `--documentation` is set.
|
454
454
|
|
455
455
|
You can customize the categories and their contents using `custom_categories` in
|
456
|
-
the config file
|
456
|
+
the config file. `custom_categories` is an array of objects. Each category must contain two properties:
|
457
|
+
- `name`: A string with the name you want to give to this category
|
458
|
+
- `children`: An array used to specify the root level declarations that you want to add to
|
459
|
+
this category.
|
460
|
+
|
461
|
+
Each child, then, can be one of the following:
|
462
|
+
- A string, containing either the exact name of one root level declaration you want to
|
463
|
+
match, or the fully qualified name (`ModuleName.DeclarationName`)
|
464
|
+
- An object, containing the property:
|
465
|
+
- `regex`: a string which will be used to match multiple root level declarations from
|
466
|
+
all of the modules.
|
467
|
+
|
468
|
+
See the ReSwift [docs](https://reswift.github.io/ReSwift/) and
|
457
469
|
[config file](https://github.com/ReSwift/ReSwift/blob/e94737282850fa038b625b4e351d1608a3d02cee/.jazzy.json)
|
458
470
|
for an example.
|
459
471
|
|
data/jazzy.gemspec
CHANGED
@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
|
|
18
18
|
spec.files = `git ls-files`.split($/)
|
19
19
|
spec.executables << 'jazzy'
|
20
20
|
|
21
|
+
spec.add_dependency 'activesupport', '>= 5.0', '< 8'
|
21
22
|
spec.add_dependency 'cocoapods', '~> 1.5'
|
23
|
+
spec.add_dependency 'logger'
|
22
24
|
spec.add_dependency 'mustache', '~> 1.1'
|
23
25
|
spec.add_dependency 'open4', '~> 1.3'
|
24
26
|
spec.add_dependency 'redcarpet', '~> 3.4'
|
data/js/package-lock.json
CHANGED
@@ -19,6 +19,7 @@
|
|
19
19
|
"version": "8.3.0",
|
20
20
|
"resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz",
|
21
21
|
"integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==",
|
22
|
+
"license": "MIT",
|
22
23
|
"engines": {
|
23
24
|
"node": ">= 12"
|
24
25
|
}
|
@@ -27,6 +28,7 @@
|
|
27
28
|
"version": "1.3.4",
|
28
29
|
"resolved": "https://registry.npmjs.org/corejs-typeahead/-/corejs-typeahead-1.3.4.tgz",
|
29
30
|
"integrity": "sha512-4SAc1UWszc05IyG9te1JHSeLas5WUWKmKAB8m9E6AAmHCpYhdSaySkblVSIUwQG2FR5uAsaeHbKM+pkEP7SiNw==",
|
31
|
+
"license": "MIT",
|
30
32
|
"dependencies": {
|
31
33
|
"jquery": ">=1.11"
|
32
34
|
}
|
@@ -34,16 +36,18 @@
|
|
34
36
|
"node_modules/jquery": {
|
35
37
|
"version": "3.7.1",
|
36
38
|
"resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.1.tgz",
|
37
|
-
"integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg=="
|
39
|
+
"integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==",
|
40
|
+
"license": "MIT"
|
38
41
|
},
|
39
42
|
"node_modules/katex": {
|
40
|
-
"version": "0.16.
|
41
|
-
"resolved": "https://registry.npmjs.org/katex/-/katex-0.16.
|
42
|
-
"integrity": "sha512-
|
43
|
+
"version": "0.16.25",
|
44
|
+
"resolved": "https://registry.npmjs.org/katex/-/katex-0.16.25.tgz",
|
45
|
+
"integrity": "sha512-woHRUZ/iF23GBP1dkDQMh1QBad9dmr8/PAwNA54VrSOVYgI12MAcE14TqnDdQOdzyEonGzMepYnqBMYdsoAr8Q==",
|
43
46
|
"funding": [
|
44
47
|
"https://opencollective.com/katex",
|
45
48
|
"https://github.com/sponsors/katex"
|
46
49
|
],
|
50
|
+
"license": "MIT",
|
47
51
|
"dependencies": {
|
48
52
|
"commander": "^8.3.0"
|
49
53
|
},
|
@@ -54,7 +58,8 @@
|
|
54
58
|
"node_modules/lunr": {
|
55
59
|
"version": "2.3.9",
|
56
60
|
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
|
57
|
-
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="
|
61
|
+
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
|
62
|
+
"license": "MIT"
|
58
63
|
}
|
59
64
|
}
|
60
65
|
}
|
data/lib/jazzy/doc_builder.rb
CHANGED
@@ -407,7 +407,7 @@ module Jazzy
|
|
407
407
|
uid = (mark.name || 'Unnamed').to_s
|
408
408
|
if mark_names_counts.key?(uid)
|
409
409
|
mark_names_counts[uid] += 1
|
410
|
-
uid +=
|
410
|
+
uid += mark_names_counts[uid].to_s
|
411
411
|
else
|
412
412
|
mark_names_counts[uid] = 1
|
413
413
|
end
|
@@ -464,7 +464,7 @@ module Jazzy
|
|
464
464
|
}
|
465
465
|
end
|
466
466
|
|
467
|
-
return breadcrumbs if breadcrumbs.
|
467
|
+
return breadcrumbs if breadcrumbs.one?
|
468
468
|
|
469
469
|
# Add the module name to the outer type if not clear from context
|
470
470
|
if docs_path[1].ambiguous_module_name?(docs_path[0].name)
|