jazzy 0.15.3 → 0.15.5

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.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/Tests.yml +7 -7
  3. data/.rubocop.yml +119 -1
  4. data/CHANGELOG.md +55 -3
  5. data/CONTRIBUTING.md +1 -1
  6. data/Gemfile.lock +106 -88
  7. data/README.md +14 -2
  8. data/bin/sourcekitten +0 -0
  9. data/jazzy.gemspec +4 -2
  10. data/js/package-lock.json +10 -5
  11. data/lib/jazzy/config.rb +5 -9
  12. data/lib/jazzy/doc_builder.rb +6 -9
  13. data/lib/jazzy/doc_index.rb +12 -1
  14. data/lib/jazzy/docset_builder.rb +1 -1
  15. data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
  16. data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
  17. data/lib/jazzy/gem_version.rb +1 -1
  18. data/lib/jazzy/grouper.rb +25 -15
  19. data/lib/jazzy/jazzy_markdown.rb +1 -2
  20. data/lib/jazzy/podspec_documenter.rb +5 -6
  21. data/lib/jazzy/search_builder.rb +28 -0
  22. data/lib/jazzy/source_declaration/type.rb +4 -4
  23. data/lib/jazzy/source_declaration.rb +17 -3
  24. data/lib/jazzy/sourcekitten.rb +19 -23
  25. data/lib/jazzy/symbol_graph/constraint.rb +3 -2
  26. data/lib/jazzy/symbol_graph/graph.rb +2 -3
  27. data/lib/jazzy/symbol_graph/sym_node.rb +1 -1
  28. data/lib/jazzy/symbol_graph/symbol.rb +1 -2
  29. data/spec/integration_spec.rb +40 -39
  30. data/spec/realm-build.sh +2 -0
  31. metadata +48 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 28b6dc76090e7100563e04b5c46263a60220ad53923823c30dd975c6b06dbfda
4
- data.tar.gz: f11e0e48264fadac60cb5d3545126921e28053c7847b38969f51a4ba2c0fdaab
3
+ metadata.gz: 6512e08b5febcc111ae5af8a632ef2231de5fe4124b7f82d5644f439ff7db779
4
+ data.tar.gz: 74bf03412186f7638600bcb38b0fe3ccd7ed5237998273150573786f0414599b
5
5
  SHA512:
6
- metadata.gz: a045279154c9fa5078f9a7d75a34fecf965dfe2cf7bf036005ff1eeb42728b648a09f36bfdb47cfdd95ea7b2bcbbccd3ab88369c5056409d1bfb633813094154
7
- data.tar.gz: d92cca337441a296dce4753b3d90311a07eb1d325ec0029b5b873b4be2a28705078397d70008b765d19b63e7eb804ca3e02d4e42ec9cbb2cad53678213ce22ea
6
+ metadata.gz: fcc7c2761c0976374961ad38c834fa14ac75146f4d05d5d6be5d61c03714c4107bcfd93543235f5d4a4438819fa58f94a6bea4eca68df44904c08db958e919b3
7
+ data.tar.gz: c059374937484bbb302e71fb83db2fd83892ccc55ea6c354282fc97c29d68520a3e4c32bef52fdc99d5a010c278fbb638de8127383336e54b965dc2e383a8d4f
data/.github/workflows/Tests.yml CHANGED
@@ -10,10 +10,10 @@ jobs:
10
10
  danger_and_rubocop:
11
11
  runs-on: ubuntu-latest
12
12
  steps:
13
- - uses: actions/checkout@v4
13
+ - uses: actions/checkout@v7
14
14
  - uses: ruby/setup-ruby@v1
15
15
  with:
16
- ruby-version: 3.2
16
+ ruby-version: 3.3
17
17
  bundler-cache: true
18
18
  - name: Rubocop
19
19
  run: |
@@ -25,25 +25,25 @@ jobs:
25
25
  bundle exec danger --verbose
26
26
 
27
27
  spec:
28
- runs-on: macos-14
28
+ runs-on: xcode-27
29
29
  continue-on-error: true
30
30
  strategy:
31
31
  matrix:
32
32
  spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
33
33
  steps:
34
- - uses: actions/checkout@v4
34
+ - uses: actions/checkout@v7
35
35
  with:
36
36
  submodules: recursive
37
37
  persist-credentials: false
38
38
  - uses: maxim-lobanov/setup-xcode@v1
39
39
  with:
40
- xcode-version: '16.0'
40
+ xcode-version: '27.0.0'
41
41
  - uses: ruby/setup-ruby@v1
42
42
  with:
43
- ruby-version: 3.2
43
+ ruby-version: 3.3
44
44
  bundler-cache: true
45
45
  - name: Cache cocoapods
46
- uses: actions/cache@v4
46
+ uses: actions/cache@v5
47
47
  env:
48
48
  cache-name: cocoapods
49
49
  with:
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.66.1 ---------------------------------------------#
11
+ #- Pending Cops as of 1.91.0 ---------------------------------------------#
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,10 +32,22 @@ Lint/AmbiguousAssignment: # (new in 1.7)
28
32
  Enabled: true
29
33
  Lint/AmbiguousRange: # (new in 1.19)
30
34
  Enabled: true
35
+ Lint/ArgumentMismatch: # new in 1.90
36
+ Enabled: true
37
+ Lint/ArrayLiteralInRegexp: # new in 1.71
38
+ Enabled: true
31
39
  Lint/ConstantOverwrittenInRescue: # new in 1.31
32
40
  Enabled: true
41
+ Lint/ConstantReassignment: # new in 1.70
42
+ Enabled: true
43
+ Lint/CopDirectiveSyntax: # new in 1.72
44
+ Enabled: true
45
+ Lint/DataDefineOverride: # new in 1.85
46
+ Enabled: true
33
47
  Lint/DeprecatedConstants: # (new in 1.8)
34
48
  Enabled: true
49
+ Lint/DeprecatedReference: # new in 1.89
50
+ Enabled: true
35
51
  Lint/DuplicateBranch: # (new in 1.3)
36
52
  Enabled: true
37
53
  Lint/DuplicateMagicComment: # new in 1.37
@@ -40,12 +56,16 @@ Lint/DuplicateMatchPattern: # new in 1.50
40
56
  Enabled: true
41
57
  Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
42
58
  Enabled: true
59
+ Lint/DuplicateSetElement: # new in 1.67
60
+ Enabled: true
43
61
  Lint/EmptyBlock: # (new in 1.1)
44
62
  Enabled: true
45
63
  Lint/EmptyClass: # (new in 1.3)
46
64
  Enabled: true
47
65
  Lint/EmptyInPattern: # (new in 1.16)
48
66
  Enabled: true
67
+ Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
68
+ Enabled: true
49
69
  Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
50
70
  Enabled: true
51
71
  Lint/ItWithoutArgumentsInBlock: # new in 1.59
@@ -54,38 +74,64 @@ Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
54
74
  Enabled: true
55
75
  Lint/LiteralAssignmentInCondition: # new in 1.58
56
76
  Enabled: true
77
+ Lint/MisplacedMagicComment: # new in 1.91
78
+ Enabled: true
57
79
  Lint/MixedCaseRange: # new in 1.53
58
80
  Enabled: true
81
+ Lint/NameTypo: # new in 1.89
82
+ Enabled: true
59
83
  Lint/NonAtomicFileOperation: # new in 1.31
60
84
  Enabled: true
61
85
  Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
62
86
  Enabled: true
63
87
  Lint/NumberedParameterAssignment: # (new in 1.9)
64
88
  Enabled: true
89
+ Lint/NumericOperationWithConstantResult: # new in 1.69
90
+ Enabled: true
65
91
  Lint/OrAssignmentToConstant: # (new in 1.9)
66
92
  Enabled: true
67
93
  Lint/RedundantDirGlobSort: # (new in 1.8)
68
94
  Enabled: true
69
95
  Lint/RedundantRegexpQuantifiers: # new in 1.53
70
96
  Enabled: true
97
+ Lint/RedundantTypeConversion: # new in 1.72
98
+ Enabled: true
71
99
  Lint/RefinementImportMethods: # new in 1.27
72
100
  Enabled: true
73
101
  Lint/RequireRangeParentheses: # new in 1.32
74
102
  Enabled: true
75
103
  Lint/RequireRelativeSelfPath: # new in 1.22
76
104
  Enabled: true
105
+ Lint/SharedMutableDefault: # new in 1.70
106
+ Enabled: true
107
+ Lint/SuperArgumentMismatch: # new in 1.90
108
+ Enabled: true
109
+ Lint/SuppressedExceptionInNumberConversion: # new in 1.72
110
+ Enabled: true
77
111
  Lint/SymbolConversion: # (new in 1.9)
78
112
  Enabled: true
79
113
  Lint/ToEnumArguments: # (new in 1.1)
80
114
  Enabled: true
81
115
  Lint/TripleQuotes: # (new in 1.9)
82
116
  Enabled: true
117
+ Lint/UnescapedBracketInRegexp: # new in 1.68
118
+ Enabled: true
83
119
  Lint/UnexpectedBlockArity: # (new in 1.5)
84
120
  Enabled: true
85
121
  Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
86
122
  Enabled: true
123
+ Lint/UnreachablePatternBranch: # new in 1.85
124
+ Enabled: true
125
+ Lint/UselessConstantScoping: # new in 1.72
126
+ Enabled: true
127
+ Lint/UselessDefaultValueArgument: # new in 1.76
128
+ Enabled: true
129
+ Lint/UselessDefined: # new in 1.69
130
+ Enabled: true
87
131
  Lint/UselessNumericOperation: # new in 1.66
88
132
  Enabled: true
133
+ Lint/UselessOr: # new in 1.76
134
+ Enabled: true
89
135
  Lint/UselessRescue: # new in 1.43
90
136
  Enabled: true
91
137
  Lint/UselessRuby2Keywords: # new in 1.23
@@ -96,28 +142,50 @@ Naming/BlockForwarding: # new in 1.24
96
142
  Enabled: true
97
143
  Naming/InclusiveLanguage: # (new in 1.18)
98
144
  Enabled: true
145
+ Naming/PredicateMethod: # new in 1.76
146
+ Enabled: true
99
147
  Security/CompoundHash: # new in 1.28
100
148
  Enabled: true
149
+ Style/BitwisePredicate: # new in 1.68
150
+ Enabled: true
151
+ Style/CombinableDefined: # new in 1.68
152
+ Enabled: true
153
+ Style/ComparableBetween: # new in 1.74
154
+ Enabled: true
101
155
  Style/ConcatArrayLiterals: # new in 1.41
102
156
  Enabled: true
103
157
  Security/IoMethods: # new in 1.22
104
158
  Enabled: true
159
+ Style/AmbiguousEndlessMethodDefinition: # new in 1.68
160
+ Enabled: true
105
161
  Style/ArgumentsForwarding: # (new in 1.1)
106
162
  Enabled: true
107
163
  Style/ArrayIntersect: # new in 1.40
108
164
  Enabled: true
165
+ Style/ArrayIntersectWithSingleElement: # new in 1.81
166
+ Enabled: true
109
167
  Style/CollectionCompact: # (new in 1.2)
110
168
  Enabled: true
169
+ Style/CollectionQuerying: # new in 1.77
170
+ Enabled: true
111
171
  Style/ComparableClamp: # new in 1.44
112
172
  Enabled: true
113
173
  Style/DataInheritance: # new in 1.49
114
174
  Enabled: true
175
+ Style/DigChain: # new in 1.69
176
+ Enabled: true
177
+ Style/DirectiveScope: # new in 1.90
178
+ Enabled: true
115
179
  Style/DirEmpty: # new in 1.48
116
180
  Enabled: true
117
181
  Style/DocumentDynamicEvalDefinition: # (new in 1.1)
118
182
  Enabled: true
183
+ Style/EmptyClassDefinition: # new in 1.84
184
+ Enabled: true
119
185
  Style/EmptyHeredoc: # new in 1.32
120
186
  Enabled: true
187
+ Style/EmptyStringInsideInterpolation: # new in 1.76
188
+ Enabled: true
121
189
  Style/EndlessMethod: # (new in 1.8)
122
190
  Enabled: true
123
191
  Style/EnvHome: # new in 1.29
@@ -128,34 +196,56 @@ Style/FetchEnvVar: # new in 1.28
128
196
  Enabled: true
129
197
  Style/FileEmpty: # new in 1.48
130
198
  Enabled: true
199
+ Style/FileNull: # new in 1.69
200
+ Enabled: true
201
+ Style/FileOpen: # new in 1.85
202
+ Enabled: true
131
203
  Style/FileRead: # new in 1.24
132
204
  Enabled: true
205
+ Style/FileTouch: # new in 1.69
206
+ Enabled: true
133
207
  Style/FileWrite: # new in 1.24
134
208
  Enabled: true
135
209
  Style/HashConversion: # (new in 1.10)
136
210
  Enabled: true
137
211
  Style/HashExcept: # (new in 1.7)
138
212
  Enabled: true
213
+ Style/HashFetchChain: # new in 1.75
214
+ Enabled: true
215
+ Style/HashSlice: # new in 1.71
216
+ Enabled: true
139
217
  Style/IfWithBooleanLiteralBranches: # (new in 1.9)
140
218
  Enabled: true
141
219
  Style/InPatternThen: # (new in 1.16)
142
220
  Enabled: true
221
+ Style/ItAssignment: # new in 1.70
222
+ Enabled: true
223
+ Style/ItBlockParameter: # new in 1.75
224
+ Enabled: true
225
+ Style/KeywordArgumentsMerging: # new in 1.68
226
+ Enabled: true
143
227
  Style/MagicCommentFormat: # new in 1.35
144
228
  Enabled: true
145
229
  Style/MapCompactWithConditionalBlock: # new in 1.30
146
230
  Enabled: true
147
231
  Style/MapIntoArray: # new in 1.63
148
232
  Enabled: true
233
+ Style/MapJoin: # new in 1.85
234
+ Enabled: true
149
235
  Style/MapToHash: # new in 1.24
150
236
  Enabled: true
151
237
  Style/MapToSet: # new in 1.42
152
238
  Enabled: true
153
239
  Style/MinMaxComparison: # new in 1.42
154
240
  Enabled: true
241
+ Style/ModuleMemberExistenceCheck: # new in 1.82
242
+ Enabled: true
155
243
  Style/MultilineInPatternThen: # (new in 1.16)
156
244
  Enabled: true
157
245
  Style/NegatedIfElseCondition: # (new in 1.2)
158
246
  Enabled: true
247
+ Style/NegativeArrayIndex: # new in 1.84
248
+ Enabled: true
159
249
  Style/NestedFileDirname: # new in 1.26
160
250
  Enabled: true
161
251
  Style/NilLambda: # (new in 1.3)
@@ -170,12 +260,20 @@ Style/OpenStructUse: # new in 1.23
170
260
  Enabled: true
171
261
  Style/OperatorMethodCall: # new in 1.37
172
262
  Enabled: true
263
+ Style/PartitionInsteadOfDoubleSelect: # new in 1.85
264
+ Enabled: true
265
+ Style/PredicateWithKind: # new in 1.85
266
+ Enabled: true
173
267
  Style/QuotedSymbols: # (new in 1.16)
174
268
  Enabled: true
269
+ Style/ReduceToHash: # new in 1.85
270
+ Enabled: true
175
271
  Style/RedundantArgument: # (new in 1.4)
176
272
  Enabled: true
177
273
  Style/RedundantArrayConstructor: # new in 1.52
178
274
  Enabled: true
275
+ Style/RedundantArrayFlatten: # new in 1.76
276
+ Enabled: true
179
277
  Style/RedundantConstantBase: # new in 1.40
180
278
  Enabled: true
181
279
  Style/RedundantCurrentDirectoryInPath: # new in 1.53
@@ -186,6 +284,8 @@ Style/RedundantEach: # new in 1.38
186
284
  Enabled: true
187
285
  Style/RedundantFilterChain: # new in 1.52
188
286
  Enabled: true
287
+ Style/RedundantFormat: # new in 1.72
288
+ Enabled: true
189
289
  Style/RedundantHeredocDelimiterQuotes: # new in 1.45
190
290
  Enabled: true
191
291
  Style/RedundantInitialize: # new in 1.27
@@ -194,6 +294,8 @@ Style/RedundantInterpolationUnfreeze: # new in 1.66
194
294
  Enabled: true
195
295
  Style/RedundantLineContinuation: # new in 1.49
196
296
  Enabled: true
297
+ Style/RedundantMinMaxBy: # new in 1.85
298
+ Enabled: true
197
299
  Style/RedundantRegexpArgument: # new in 1.53
198
300
  Enabled: true
199
301
  Style/RedundantRegexpConstructor: # new in 1.52
@@ -204,6 +306,14 @@ Style/RedundantStringEscape: # new in 1.37
204
306
  Enabled: true
205
307
  Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
206
308
  Enabled: true
309
+ Style/ReverseFind: # new in 1.84
310
+ Enabled: true
311
+ Style/SafeNavigationChainLength: # new in 1.68
312
+ Enabled: true
313
+ Style/SelectByKind: # new in 1.85
314
+ Enabled: true
315
+ Style/SelectByRange: # new in 1.85
316
+ Enabled: true
207
317
  Style/SelectByRegexp: # new in 1.22
208
318
  Enabled: true
209
319
  Style/SendWithLiteralMethodName: # new in 1.64
@@ -218,6 +328,10 @@ Style/SuperWithArgsParentheses: # new in 1.58
218
328
  Enabled: true
219
329
  Style/SwapValues: # (new in 1.1)
220
330
  Enabled: true
331
+ Style/TallyMethod: # new in 1.85
332
+ Enabled: true
333
+ Style/TimeNow: # new in 1.90
334
+ Enabled: true
221
335
  Style/YAMLFileRead: # new in 1.53
222
336
  Enabled: true
223
337
 
@@ -318,6 +432,10 @@ Style/RegexpLiteral:
318
432
  Style/AccessorGrouping:
319
433
  Enabled: false
320
434
 
435
+ # Too restrictive
436
+ Style/OneClassPerFile:
437
+ Enabled: false
438
+
321
439
  # Avoid mandatory wide indentation
322
440
  Layout/MultilineMethodCallIndentation:
323
441
  EnforcedStyle: indented
data/CHANGELOG.md CHANGED
@@ -1,4 +1,56 @@
1
- ## Master
1
+ ## 0.15.5
2
+
3
+ ##### Breaking
4
+
5
+ * None.
6
+
7
+ ##### Enhancements
8
+
9
+ * Generate docs using SwiftPM 6.4
10
+ [John Fairhurst](https://github.com/johnfairh)
11
+
12
+ * Support mustache 1.1.3
13
+ [John Fairhurst](https://github.com/johnfairh)
14
+ [#1435](https://github.com/realm/jazzy/issues/1435)
15
+
16
+ ##### Bug Fixes
17
+
18
+ * None.
19
+
20
+ ## 0.15.4
21
+
22
+ ##### Breaking
23
+
24
+ * None.
25
+
26
+ ##### Enhancements
27
+
28
+ * Allow `custom_categories` to specify a regex for a child.
29
+ [Enrico Zannini](https://github.com/Enricoza)
30
+ [#688](https://github.com/realm/jazzy/issues/688)
31
+
32
+ * Update Javascript: KaTeX 0.16.25
33
+ [John Fairhurst](https://github.com/johnfairh)
34
+
35
+ ##### Bug Fixes
36
+
37
+ * Don't call extension members that do not need documentation
38
+ 'undocumented'.
39
+ [John Fairhurst](https://github.com/johnfairh)
40
+
41
+ * Work around activesupport vs. concurrent-ruby crash.
42
+ [John Fairhurst](https://github.com/johnfairh)
43
+ [#1414](https://github.com/realm/jazzy/issues/1414)
44
+
45
+ * Better identify default implementations.
46
+ [John Fairhurst](https://github.com/johnfairh)
47
+ [#1420](https://github.com/realm/jazzy/issues/1420)
48
+
49
+ * Suppress warning on extensions providing default implementations.
50
+ [John Fairhurst](https://github.com/johnfairh)
51
+ [#1396](https://github.com/realm/jazzy/issues/1396)
52
+
53
+ ## 0.15.3
2
54
 
3
55
  ##### Breaking
4
56
 
@@ -10,8 +62,8 @@
10
62
 
11
63
  ##### Bug Fixes
12
64
 
13
- * Don't crash when the Swift 6 compiler reports educational
14
- notes.
65
+ * Don't crash in SourceKitten when the Swift 6 compiler reports
66
+ educational notes.
15
67
  [John Fairhurst](https://github.com/johnfairh)
16
68
  [#1399](https://github.com/realm/jazzy/issues/1399)
17
69
 
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 16.0 installed to build the integration specs.
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