Skip to content

Commit 6df391c

Browse files
authored
Release 0.14.0 and update gems (#1274)
1 parent 5c9d5bd commit 6df391c

File tree

5 files changed

+61
-55
lines changed

5 files changed

+61
-55
lines changed

.rubocop.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ AllCops:
77
SuggestExtensions: false
88
TargetRubyVersion: 2.6
99

10-
#- Pending Cops as of 1.18.3 ---------------------------------------------#
10+
#- Pending Cops as of 1.19.0 ---------------------------------------------#
1111

1212
Gemspec/DateAssignment: # (new in 1.10)
1313
Enabled: true
1414
Layout/SpaceBeforeBrackets: # (new in 1.7)
1515
Enabled: true
1616
Lint/AmbiguousAssignment: # (new in 1.7)
1717
Enabled: true
18+
Lint/AmbiguousRange: # (new in 1.19)
19+
Enabled: true
1820
Lint/DeprecatedConstants: # (new in 1.8)
1921
Enabled: true
2022
Lint/DuplicateBranch: # (new in 1.3)
@@ -75,6 +77,8 @@ Style/QuotedSymbols: # (new in 1.16)
7577
Enabled: true
7678
Style/RedundantArgument: # (new in 1.4)
7779
Enabled: true
80+
Style/RedundantSelfAssignmentBranch: # (new in 1.19)
81+
Enabled: true
7882
Style/StringChars: # (new in 1.12)
7983
Enabled: true
8084
Style/SwapValues: # (new in 1.1)

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Master
1+
## 0.14.0
22

33
##### Breaking
44

Gemfile.lock

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
jazzy (0.13.7)
4+
jazzy (0.14.0)
55
cocoapods (~> 1.5)
66
mustache (~> 1.1)
77
open4 (~> 1.3)
@@ -37,10 +37,10 @@ GEM
3737
clintegracon (0.7.0)
3838
colored (~> 1.2)
3939
diffy
40-
cocoapods (1.10.1)
40+
cocoapods (1.10.2)
4141
addressable (~> 2.6)
4242
claide (>= 1.0.2, < 2.0)
43-
cocoapods-core (= 1.10.1)
43+
cocoapods-core (= 1.10.2)
4444
cocoapods-deintegrate (>= 1.0.3, < 2.0)
4545
cocoapods-downloader (>= 1.4.0, < 2.0)
4646
cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -55,7 +55,7 @@ GEM
5555
nap (~> 1.0)
5656
ruby-macho (~> 1.4)
5757
xcodeproj (>= 1.19.0, < 2.0)
58-
cocoapods-core (1.10.1)
58+
cocoapods-core (1.10.2)
5959
activesupport (> 5.0, < 6)
6060
addressable (~> 2.6)
6161
algoliasearch (~> 1.0)
@@ -69,7 +69,7 @@ GEM
6969
cocoapods-downloader (1.4.0)
7070
cocoapods-plugins (1.0.0)
7171
nap
72-
cocoapods-search (1.0.0)
72+
cocoapods-search (1.0.1)
7373
cocoapods-trunk (1.5.0)
7474
nap (>= 0.8, < 2.0)
7575
netrc (~> 0.11)
@@ -98,14 +98,15 @@ GEM
9898
escape (0.0.4)
9999
ethon (0.14.0)
100100
ffi (>= 1.15.0)
101-
faraday (1.5.0)
101+
faraday (1.7.0)
102102
faraday-em_http (~> 1.0)
103103
faraday-em_synchrony (~> 1.0)
104104
faraday-excon (~> 1.1)
105105
faraday-httpclient (~> 1.0.1)
106106
faraday-net_http (~> 1.0)
107107
faraday-net_http_persistent (~> 1.1)
108108
faraday-patron (~> 1.0)
109+
faraday-rack (~> 1.0)
109110
multipart-post (>= 1.2, < 3)
110111
ruby2_keywords (>= 0.0.4)
111112
faraday-em_http (1.0.0)
@@ -115,13 +116,14 @@ GEM
115116
faraday (>= 0.8)
116117
faraday-httpclient (1.0.1)
117118
faraday-net_http (1.0.1)
118-
faraday-net_http_persistent (1.1.0)
119+
faraday-net_http_persistent (1.2.0)
119120
faraday-patron (1.0.0)
121+
faraday-rack (1.0.0)
120122
ffi (1.15.3)
121123
fourflusher (2.3.1)
122124
fuzzy_match (2.0.4)
123125
gh_inspector (1.1.3)
124-
git (1.9.0)
126+
git (1.9.1)
125127
rchardet (~> 1.8)
126128
hashdiff (1.0.1)
127129
httpclient (2.8.3)
@@ -149,32 +151,32 @@ GEM
149151
sawyer (~> 0.8.0, >= 0.5.3)
150152
open4 (1.3.4)
151153
parallel (1.20.1)
152-
parser (3.0.1.1)
154+
parser (3.0.2.0)
153155
ast (~> 2.4.1)
154156
prettybacon (0.0.2)
155157
bacon (~> 1.2)
156158
public_suffix (4.0.6)
157159
rainbow (3.0.0)
158-
rake (13.0.4)
160+
rake (13.0.6)
159161
rchardet (1.8.0)
160162
redcarpet (3.5.1)
161163
regexp_parser (2.1.1)
162164
rexml (3.2.5)
163165
rouge (3.26.0)
164-
rubocop (1.18.3)
166+
rubocop (1.19.0)
165167
parallel (~> 1.10)
166168
parser (>= 3.0.0.0)
167169
rainbow (>= 2.2.2, < 4.0)
168170
regexp_parser (>= 1.8, < 3.0)
169171
rexml
170-
rubocop-ast (>= 1.7.0, < 2.0)
172+
rubocop-ast (>= 1.9.1, < 2.0)
171173
ruby-progressbar (~> 1.7)
172174
unicode-display_width (>= 1.4.0, < 3.0)
173-
rubocop-ast (1.7.0)
175+
rubocop-ast (1.10.0)
174176
parser (>= 3.0.1.1)
175177
ruby-macho (1.4.0)
176178
ruby-progressbar (1.11.0)
177-
ruby2_keywords (0.0.4)
179+
ruby2_keywords (0.0.5)
178180
sassc (2.4.0)
179181
ffi (~> 1.9)
180182
sawyer (0.8.2)
@@ -189,13 +191,13 @@ GEM
189191
tzinfo (1.2.9)
190192
thread_safe (~> 0.1)
191193
unicode-display_width (2.0.0)
192-
webmock (3.13.0)
193-
addressable (>= 2.3.6)
194+
webmock (3.14.0)
195+
addressable (>= 2.8.0)
194196
crack (>= 0.3.2)
195197
hashdiff (>= 0.4.0, < 2.0.0)
196198
xcinvoke (0.3.0)
197199
liferaft (~> 0.0.6)
198-
xcodeproj (1.20.0)
200+
xcodeproj (1.21.0)
199201
CFPropertyList (>= 2.3.3, < 4.0)
200202
atomos (~> 0.1.3)
201203
claide (>= 1.0.2, < 2.0)

lib/jazzy/config.rb

+35-35
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ def hide_objc?
154154
config_attr :hide_declarations,
155155
command_line: '--hide-declarations [objc|swift] ',
156156
description: 'Hide declarations in the specified language. Given that ' \
157-
'generating Swift docs only generates Swift declarations, ' \
158-
'this is useful for hiding a specific interface for ' \
159-
'either Objective-C or mixed Objective-C and Swift ' \
160-
'projects.',
157+
'generating Swift docs only generates Swift declarations, ' \
158+
'this is useful for hiding a specific interface for ' \
159+
'either Objective-C or mixed Objective-C and Swift ' \
160+
'projects.',
161161
default: ''
162162

163163
config_attr :keep_property_attributes,
@@ -174,7 +174,7 @@ def hide_objc?
174174
config_attr :build_tool_arguments,
175175
command_line: ['-b', '--build-tool-arguments arg1,arg2,…argN', Array],
176176
description: 'Arguments to forward to xcodebuild, swift build, or ' \
177-
'sourcekitten.',
177+
'sourcekitten.',
178178
default: []
179179

180180
alias_config_attr :xcodebuild_arguments, :build_tool_arguments,
@@ -196,7 +196,7 @@ def hide_objc?
196196
config_attr :excluded_files,
197197
command_line: ['-e', '--exclude filepath1,filepath2,…filepathN', Array],
198198
description: 'Source file pathnames to be excluded from documentation. '\
199-
'Supports wildcards.',
199+
'Supports wildcards.',
200200
default: [],
201201
parse: ->(files) do
202202
Array(files).map { |f| expand_glob_path(f).to_s }
@@ -205,7 +205,7 @@ def hide_objc?
205205
config_attr :included_files,
206206
command_line: ['-i', '--include filepath1,filepath2,…filepathN', Array],
207207
description: 'Source file pathnames to be included in documentation. '\
208-
'Supports wildcards.',
208+
'Supports wildcards.',
209209
default: [],
210210
parse: ->(files) do
211211
Array(files).map { |f| expand_glob_path(f).to_s }
@@ -229,9 +229,9 @@ def hide_objc?
229229
config_attr :swift_build_tool,
230230
command_line: "--swift-build-tool #{SWIFT_BUILD_TOOLS.join(' | ')}",
231231
description: 'Control whether Jazzy uses Swift Package Manager, '\
232-
'xcodebuild, or swift-symbolgraph to build the module '\
233-
'to be documented. By default it uses xcodebuild if '\
234-
'there is a .xcodeproj file in the source directory.',
232+
'xcodebuild, or swift-symbolgraph to build the module '\
233+
'to be documented. By default it uses xcodebuild if '\
234+
'there is a .xcodeproj file in the source directory.',
235235
parse: ->(tool) do
236236
return tool.to_sym if SWIFT_BUILD_TOOLS.include?(tool)
237237

@@ -260,13 +260,13 @@ def hide_objc?
260260
config_attr :version,
261261
command_line: '--module-version VERSION',
262262
description: 'Version string to use as part of the default docs '\
263-
'title and inside the docset.',
263+
'title and inside the docset.',
264264
default: '1.0'
265265

266266
config_attr :title,
267267
command_line: '--title TITLE',
268268
description: 'Title to display at the top of each page, overriding the '\
269-
'default generated from module name and version.',
269+
'default generated from module name and version.',
270270
default: ''
271271

272272
config_attr :copyright,
@@ -291,16 +291,16 @@ def hide_objc?
291291
config_attr :podspec,
292292
command_line: '--podspec FILEPATH',
293293
description: 'A CocoaPods Podspec that describes the Swift library to '\
294-
'document',
294+
'document',
295295
parse: ->(ps) { PodspecDocumenter.create_podspec(Pathname(ps)) if ps },
296296
default: Dir['*.podspec{,.json}'].first
297297

298298
config_attr :pod_sources,
299299
command_line: ['--pod-sources url1,url2,…urlN', Array],
300300
description: 'A list of sources to find pod dependencies. Used only '\
301-
'with --podspec when the podspec contains references to '\
302-
'privately hosted pods. You must include the default pod '\
303-
'source if public pods are also used.',
301+
'with --podspec when the podspec contains references to '\
302+
'privately hosted pods. You must include the default pod '\
303+
'source if public pods are also used.',
304304
default: []
305305

306306
config_attr :docset_icon,
@@ -322,7 +322,7 @@ def hide_objc?
322322
config_attr :dash_url,
323323
command_line: ['-d', '--dash_url URL'],
324324
description: 'Location of the dash XML feed '\
325-
'e.g. https://realm.io/docsets/realm.xml)',
325+
'e.g. https://realm.io/docsets/realm.xml)',
326326
parse: ->(d) { URI(d) }
327327

328328
SOURCE_HOSTS = %w[github gitlab bitbucket].freeze
@@ -365,13 +365,13 @@ def hide_objc?
365365
config_attr :docset_playground_url,
366366
command_line: '--docset-playground-url URL',
367367
description: 'URL of an interactive playground to demonstrate the '\
368-
'framework, linked to from the docset.'
368+
'framework, linked to from the docset.'
369369

370370
# ──────── Doc generation options ────────
371371
config_attr :disable_search,
372372
command_line: '--disable-search',
373373
description: 'Avoid generating a search index. '\
374-
'Search is available in some themes.',
374+
'Search is available in some themes.',
375375
default: false
376376

377377
config_attr :skip_documentation,
@@ -391,7 +391,7 @@ def hide_objc?
391391
config_attr :skip_undocumented,
392392
command_line: '--[no-]skip-undocumented',
393393
description: "Don't document declarations that have no documentation "\
394-
'comments.',
394+
'comments.',
395395
default: false
396396

397397
config_attr :hide_documentation_coverage,
@@ -401,21 +401,21 @@ def hide_objc?
401401

402402
config_attr :custom_categories,
403403
description: 'Custom navigation categories to replace the standard '\
404-
"'Classes', 'Protocols', etc. Types not explicitly named "\
405-
'in a custom category appear in generic groups at the '\
406-
'end. Example: https://git.io/v4Bcp',
404+
"'Classes', 'Protocols', etc. Types not explicitly named "\
405+
'in a custom category appear in generic groups at the '\
406+
'end. Example: https://git.io/v4Bcp',
407407
default: []
408408

409409
config_attr :custom_categories_unlisted_prefix,
410410
description: "Prefix for navigation section names that aren't "\
411-
'explicitly listed in `custom_categories`.',
411+
'explicitly listed in `custom_categories`.',
412412
default: 'Other '
413413

414414
config_attr :hide_unlisted_documentation,
415415
command_line: '--[no-]hide-unlisted-documentation',
416416
description: "Don't include documentation in the sidebar from the "\
417-
"`documentation` config value that aren't explicitly "\
418-
'listed in `custom_categories`.',
417+
"`documentation` config value that aren't explicitly "\
418+
'listed in `custom_categories`.',
419419
default: false
420420

421421
config_attr :custom_head,
@@ -429,9 +429,9 @@ def hide_objc?
429429
config_attr :theme_directory,
430430
command_line: "--theme [#{BUILTIN_THEMES.join(' | ')} | DIRPATH]",
431431
description: "Which theme to use. Specify either 'apple' (default), "\
432-
'one of the other built-in theme names, or the path to '\
433-
'your mustache templates and other assets for a custom '\
434-
'theme.',
432+
'one of the other built-in theme names, or the path to '\
433+
'your mustache templates and other assets for a custom '\
434+
'theme.',
435435
default: 'apple',
436436
parse: ->(t) do
437437
if BUILTIN_THEMES.include?(t)
@@ -444,9 +444,9 @@ def hide_objc?
444444
config_attr :use_safe_filenames,
445445
command_line: '--use-safe-filenames',
446446
description: 'Replace unsafe characters in filenames with an encoded '\
447-
'representation. This will reduce human readability of '\
448-
'some URLs, but may be necessary for projects that '\
449-
'expose filename-unfriendly functions such as /(_:_:)',
447+
'representation. This will reduce human readability of '\
448+
'some URLs, but may be necessary for projects that '\
449+
'expose filename-unfriendly functions such as /(_:_:)',
450450
default: false
451451

452452
config_attr :template_directory,
@@ -466,14 +466,14 @@ def hide_objc?
466466
config_attr :undocumented_text,
467467
command_line: '--undocumented-text UNDOCUMENTED_TEXT',
468468
description: 'Default text for undocumented symbols. The default '\
469-
'is "Undocumented", put "" if no text is required',
469+
'is "Undocumented", put "" if no text is required',
470470
default: 'Undocumented'
471471

472472
config_attr :separate_global_declarations,
473473
command_line: '--[no-]separate-global-declarations',
474474
description: 'Create separate pages for all global declarations '\
475-
"(classes, structures, enums etc.) even if they don't "\
476-
'have children.',
475+
"(classes, structures, enums etc.) even if they don't "\
476+
'have children.',
477477
default: false
478478

479479
# rubocop:enable Layout/ArgumentAlignment

lib/jazzy/gem_version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
22

33
module Jazzy
4-
VERSION = '0.13.7' unless defined? Jazzy::VERSION
4+
VERSION = '0.14.0' unless defined? Jazzy::VERSION
55
end

0 commit comments

Comments
 (0)