jazzy 0.13.4 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/Tests.yml +52 -0
- data/.rubocop.yml +123 -24
- data/CHANGELOG.md +103 -0
- data/CONTRIBUTING.md +5 -5
- data/Dangerfile +11 -8
- data/Gemfile +3 -1
- data/Gemfile.lock +91 -69
- data/README.md +85 -13
- data/Rakefile +19 -13
- data/bin/jazzy +3 -2
- data/bin/sourcekitten +0 -0
- data/jazzy.gemspec +8 -6
- data/js/package-lock.json +30 -25
- data/js/package.json +3 -3
- data/lib/jazzy.rb +2 -0
- data/lib/jazzy/config.rb +124 -70
- data/lib/jazzy/doc.rb +3 -1
- data/lib/jazzy/doc_builder.rb +75 -81
- data/lib/jazzy/docset_builder.rb +3 -1
- data/lib/jazzy/documentation_generator.rb +6 -2
- data/lib/jazzy/executable.rb +3 -0
- data/lib/jazzy/extensions/bitbucket/img/bitbucket.svg +11 -0
- data/lib/jazzy/{themes/apple/assets → extensions/github}/img/gh.png +0 -0
- data/lib/jazzy/extensions/gitlab/img/gitlab.svg +23 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
- 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 +3 -1
- data/lib/jazzy/highlighter.rb +5 -3
- data/lib/jazzy/jazzy_markdown.rb +101 -30
- data/lib/jazzy/podspec_documenter.rb +14 -16
- data/lib/jazzy/search_builder.rb +4 -3
- data/lib/jazzy/source_declaration.rb +24 -5
- data/lib/jazzy/source_declaration/access_control_level.rb +7 -5
- data/lib/jazzy/source_declaration/type.rb +33 -1
- data/lib/jazzy/source_document.rb +8 -5
- data/lib/jazzy/source_host.rb +111 -0
- data/lib/jazzy/source_mark.rb +8 -6
- data/lib/jazzy/source_module.rb +6 -6
- data/lib/jazzy/sourcekitten.rb +105 -79
- data/lib/jazzy/stats.rb +4 -2
- data/lib/jazzy/symbol_graph.rb +95 -0
- data/lib/jazzy/symbol_graph/constraint.rb +98 -0
- data/lib/jazzy/symbol_graph/ext_node.rb +116 -0
- data/lib/jazzy/symbol_graph/graph.rb +195 -0
- data/lib/jazzy/symbol_graph/relationship.rb +42 -0
- data/lib/jazzy/symbol_graph/sym_node.rb +163 -0
- data/lib/jazzy/symbol_graph/symbol.rb +222 -0
- data/lib/jazzy/themes/apple/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +101 -4
- data/lib/jazzy/themes/apple/assets/img/spinner.gif +0 -0
- data/lib/jazzy/themes/apple/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +74 -0
- data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/apple/assets/js/lunr.min.js +6 -0
- data/lib/jazzy/themes/apple/assets/js/typeahead.jquery.js +1694 -0
- data/lib/jazzy/themes/apple/templates/doc.mustache +35 -0
- data/lib/jazzy/themes/apple/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/apple/templates/header.mustache +10 -3
- data/lib/jazzy/themes/apple/templates/task.mustache +4 -4
- data/lib/jazzy/themes/fullwidth/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +11 -2
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js +4 -0
- data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/fullwidth/assets/js/lunr.min.js +3 -3
- data/lib/jazzy/themes/fullwidth/templates/doc.mustache +30 -0
- data/lib/jazzy/themes/fullwidth/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/fullwidth/templates/header.mustache +5 -5
- data/lib/jazzy/themes/fullwidth/templates/task.mustache +4 -4
- data/lib/jazzy/themes/jony/assets/css/highlight.css.scss +63 -59
- data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +34 -2
- data/lib/jazzy/themes/jony/assets/js/jazzy.js +4 -0
- data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/jony/templates/doc.mustache +30 -0
- data/lib/jazzy/themes/jony/templates/footer.mustache +1 -1
- data/lib/jazzy/themes/jony/templates/header.mustache +5 -5
- data/lib/jazzy/themes/jony/templates/task.mustache +4 -4
- data/spec/integration_spec.rb +54 -42
- data/spec/spec_helper.rb +3 -1
- data/spec/spec_helper/pre_flight.rb +2 -0
- metadata +43 -19
- data/.circleci/config.yml +0 -83
- data/lib/jazzy/themes/fullwidth/assets/img/gh.png +0 -0
- data/lib/jazzy/themes/jony/assets/img/gh.png +0 -0
- data/spec/sourcekitten_spec.rb +0 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f6b0e2553b3b64a0b692c79a6d62735a8f2e35d3322fe371bd926f050a8b0850
|
4
|
+
data.tar.gz: df8dd3fb4e80e0c9e69db6ec7f0337c5c9687a90a130bc899748ab789ee56d61
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b6d2956ca649999f8802d00c59fadd0b5e608a9f46a553c1b5c54cb9d49962d69336fcfe822bde691409770412bf484da4f73cf8405720dbfe24aa6096a9ca60
|
7
|
+
data.tar.gz: 036cb12b85c127721690e88295ac68ed5b25dee219c7c87f5933a20d4e2a285fa75acbc4496a97637f09ca07b4caee193aca783ee73ffdd110a9a02fbe064f00
|
@@ -0,0 +1,52 @@
|
|
1
|
+
name: Tests
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [master]
|
6
|
+
pull_request:
|
7
|
+
branches: ['*']
|
8
|
+
|
9
|
+
jobs:
|
10
|
+
danger_and_rubocop:
|
11
|
+
runs-on: ubuntu-latest
|
12
|
+
steps:
|
13
|
+
- uses: actions/checkout@v2
|
14
|
+
- uses: ruby/setup-ruby@v1
|
15
|
+
with:
|
16
|
+
ruby-version: 2.6
|
17
|
+
bundler-cache: true
|
18
|
+
- name: Danger
|
19
|
+
env:
|
20
|
+
DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
21
|
+
run: |
|
22
|
+
bundle exec danger --verbose
|
23
|
+
- name: Rubocop
|
24
|
+
run: |
|
25
|
+
bundle exec rake rubocop
|
26
|
+
|
27
|
+
spec:
|
28
|
+
runs-on: macos-11
|
29
|
+
continue-on-error: true
|
30
|
+
strategy:
|
31
|
+
matrix:
|
32
|
+
spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
|
33
|
+
env:
|
34
|
+
DEVELOPER_DIR: /Applications/Xcode_12.5.app/Contents/Developer
|
35
|
+
steps:
|
36
|
+
- uses: actions/checkout@v2
|
37
|
+
with:
|
38
|
+
submodules: recursive
|
39
|
+
- uses: ruby/setup-ruby@v1
|
40
|
+
with:
|
41
|
+
ruby-version: 2.6
|
42
|
+
bundler-cache: true
|
43
|
+
- name: Cache cocoapods
|
44
|
+
uses: actions/cache@v2
|
45
|
+
env:
|
46
|
+
cache-name: cocoapods
|
47
|
+
with:
|
48
|
+
path: ~/.cocoapods
|
49
|
+
key: ${{ matrix.spec }}-${{ env.cache-name }}
|
50
|
+
- name: Test
|
51
|
+
run: |
|
52
|
+
bundle exec rake ${{ matrix.spec }}
|
data/.rubocop.yml
CHANGED
@@ -1,16 +1,92 @@
|
|
1
1
|
AllCops:
|
2
|
-
Include:
|
3
|
-
- ./Rakefile
|
4
|
-
- ./Gemfile
|
5
|
-
- ./*.gemspec
|
6
2
|
Exclude:
|
7
3
|
- ./spec/integration_specs/**/*
|
8
4
|
- ./vendor/**/*
|
9
5
|
- ./tmp/**/*
|
6
|
+
- ./SourceKitten/**/*
|
7
|
+
SuggestExtensions: false
|
8
|
+
TargetRubyVersion: 2.6
|
9
|
+
|
10
|
+
#- Pending Cops as of 1.19.0 ---------------------------------------------#
|
11
|
+
|
12
|
+
Gemspec/DateAssignment: # (new in 1.10)
|
13
|
+
Enabled: true
|
14
|
+
Layout/SpaceBeforeBrackets: # (new in 1.7)
|
15
|
+
Enabled: true
|
16
|
+
Lint/AmbiguousAssignment: # (new in 1.7)
|
17
|
+
Enabled: true
|
18
|
+
Lint/AmbiguousRange: # (new in 1.19)
|
19
|
+
Enabled: true
|
20
|
+
Lint/DeprecatedConstants: # (new in 1.8)
|
21
|
+
Enabled: true
|
22
|
+
Lint/DuplicateBranch: # (new in 1.3)
|
23
|
+
Enabled: true
|
24
|
+
Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
|
25
|
+
Enabled: true
|
26
|
+
Lint/EmptyBlock: # (new in 1.1)
|
27
|
+
Enabled: true
|
28
|
+
Lint/EmptyClass: # (new in 1.3)
|
29
|
+
Enabled: true
|
30
|
+
Lint/EmptyInPattern: # (new in 1.16)
|
31
|
+
Enabled: true
|
32
|
+
Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
|
33
|
+
Enabled: true
|
34
|
+
Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
|
35
|
+
Enabled: true
|
36
|
+
Lint/NumberedParameterAssignment: # (new in 1.9)
|
37
|
+
Enabled: true
|
38
|
+
Lint/OrAssignmentToConstant: # (new in 1.9)
|
39
|
+
Enabled: true
|
40
|
+
Lint/RedundantDirGlobSort: # (new in 1.8)
|
41
|
+
Enabled: true
|
42
|
+
Lint/SymbolConversion: # (new in 1.9)
|
43
|
+
Enabled: true
|
44
|
+
Lint/ToEnumArguments: # (new in 1.1)
|
45
|
+
Enabled: true
|
46
|
+
Lint/TripleQuotes: # (new in 1.9)
|
47
|
+
Enabled: true
|
48
|
+
Lint/UnexpectedBlockArity: # (new in 1.5)
|
49
|
+
Enabled: true
|
50
|
+
Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
|
51
|
+
Enabled: true
|
52
|
+
Naming/InclusiveLanguage: # (new in 1.18)
|
53
|
+
Enabled: true
|
54
|
+
Style/ArgumentsForwarding: # (new in 1.1)
|
55
|
+
Enabled: true
|
56
|
+
Style/CollectionCompact: # (new in 1.2)
|
57
|
+
Enabled: true
|
58
|
+
Style/DocumentDynamicEvalDefinition: # (new in 1.1)
|
59
|
+
Enabled: true
|
60
|
+
Style/EndlessMethod: # (new in 1.8)
|
61
|
+
Enabled: true
|
62
|
+
Style/HashConversion: # (new in 1.10)
|
63
|
+
Enabled: true
|
64
|
+
Style/HashExcept: # (new in 1.7)
|
65
|
+
Enabled: true
|
66
|
+
Style/IfWithBooleanLiteralBranches: # (new in 1.9)
|
67
|
+
Enabled: true
|
68
|
+
Style/InPatternThen: # (new in 1.16)
|
69
|
+
Enabled: true
|
70
|
+
Style/MultilineInPatternThen: # (new in 1.16)
|
71
|
+
Enabled: true
|
72
|
+
Style/NegatedIfElseCondition: # (new in 1.2)
|
73
|
+
Enabled: true
|
74
|
+
Style/NilLambda: # (new in 1.3)
|
75
|
+
Enabled: true
|
76
|
+
Style/QuotedSymbols: # (new in 1.16)
|
77
|
+
Enabled: true
|
78
|
+
Style/RedundantArgument: # (new in 1.4)
|
79
|
+
Enabled: true
|
80
|
+
Style/RedundantSelfAssignmentBranch: # (new in 1.19)
|
81
|
+
Enabled: true
|
82
|
+
Style/StringChars: # (new in 1.12)
|
83
|
+
Enabled: true
|
84
|
+
Style/SwapValues: # (new in 1.1)
|
85
|
+
Enabled: true
|
10
86
|
|
11
87
|
# At the moment not ready to be used
|
12
88
|
# https://github.com/bbatsov/rubocop/issues/947
|
13
|
-
Documentation:
|
89
|
+
Style/Documentation:
|
14
90
|
Enabled: false
|
15
91
|
|
16
92
|
#- Jazzy -----------------------------------------------------------------#
|
@@ -31,39 +107,40 @@ Metrics/BlockLength:
|
|
31
107
|
Style/NumericPredicate:
|
32
108
|
Enabled: false
|
33
109
|
|
34
|
-
Layout/
|
110
|
+
Layout/HeredocIndentation:
|
35
111
|
Enabled: false
|
36
112
|
|
37
113
|
# We adopted raise instead of fail.
|
38
|
-
SignalException:
|
114
|
+
Style/SignalException:
|
39
115
|
EnforcedStyle: only_raise
|
40
116
|
|
41
117
|
# They are idiomatic
|
42
|
-
AssignmentInCondition:
|
118
|
+
Lint/AssignmentInCondition:
|
43
119
|
Enabled: false
|
44
120
|
|
45
121
|
# Allow backticks
|
46
|
-
AsciiComments:
|
122
|
+
Style/AsciiComments:
|
47
123
|
Enabled: false
|
48
124
|
|
49
125
|
# Indentation clarifies logic branches in implementations
|
50
|
-
IfUnlessModifier:
|
126
|
+
Style/IfUnlessModifier:
|
51
127
|
Enabled: false
|
52
128
|
|
53
129
|
# No enforced convention here.
|
54
|
-
SingleLineBlockParams:
|
130
|
+
Style/SingleLineBlockParams:
|
55
131
|
Enabled: false
|
56
132
|
|
57
133
|
# We only add the comment when needed.
|
58
|
-
Encoding:
|
134
|
+
Style/Encoding:
|
59
135
|
Enabled: false
|
60
136
|
|
61
137
|
# Having these make it easier to *not* forget to add one when adding a new
|
62
138
|
# value and you can simply copy the previous line.
|
63
|
-
|
139
|
+
Style/TrailingCommaInArrayLiteral:
|
64
140
|
EnforcedStyleForMultiline: comma
|
65
|
-
|
66
|
-
|
141
|
+
Style/TrailingCommaInHashLiteral:
|
142
|
+
EnforcedStyleForMultiline: comma
|
143
|
+
Style/TrailingCommaInArguments:
|
67
144
|
EnforcedStyleForMultiline: comma
|
68
145
|
|
69
146
|
Style/SpecialGlobalVars:
|
@@ -78,40 +155,62 @@ Style/TrailingUnderscoreVariable:
|
|
78
155
|
|
79
156
|
# For lambdas nested within certain expressions, this rule forces either ugly
|
80
157
|
# parens or curly braces that violate the "do/end for multiline blocks" rule.
|
81
|
-
Lambda:
|
158
|
+
Style/Lambda:
|
82
159
|
Enabled: false
|
83
160
|
|
84
161
|
# Disallowing indented "when" clauses destroys readability when using the
|
85
162
|
# single-line "when/then" style.
|
86
|
-
CaseIndentation:
|
163
|
+
Layout/CaseIndentation:
|
87
164
|
Enabled: false
|
88
165
|
|
89
166
|
# These are both subjective judgements that depend on the situation, and are
|
90
167
|
# not appropriate as absolute rules.
|
91
|
-
GuardClause:
|
168
|
+
Style/GuardClause:
|
92
169
|
Enabled: false
|
93
|
-
Next:
|
170
|
+
Style/Next:
|
94
171
|
Enabled: false
|
95
172
|
|
96
|
-
|
173
|
+
# Avoid the least-readable varieties of regular expressions.
|
174
|
+
Style/RegexpLiteral:
|
97
175
|
EnforcedStyle: mixed
|
98
176
|
|
177
|
+
# Sometimes easier to read either way
|
178
|
+
Style/AccessorGrouping:
|
179
|
+
Enabled: false
|
180
|
+
|
181
|
+
# Avoid mandatory wide indentation
|
182
|
+
Layout/MultilineMethodCallIndentation:
|
183
|
+
EnforcedStyle: indented
|
184
|
+
Layout/LineEndStringConcatenationIndentation:
|
185
|
+
Enabled: true
|
186
|
+
EnforcedStyle: indented
|
187
|
+
|
188
|
+
# Avoid false positives with `Pathname`
|
189
|
+
Style/StringConcatenation:
|
190
|
+
Mode: conservative
|
191
|
+
|
192
|
+
# Compatibility with earlier Rubocops
|
193
|
+
Metrics/CyclomaticComplexity:
|
194
|
+
Max: 10
|
195
|
+
Metrics/PerceivedComplexity:
|
196
|
+
Max: 10
|
197
|
+
|
99
198
|
#- Jazzy specs -----------------------------------------------------------#
|
100
199
|
|
101
200
|
# Allow for `should.match /regexp/`.
|
102
|
-
AmbiguousRegexpLiteral:
|
201
|
+
Lint/AmbiguousRegexpLiteral:
|
103
202
|
Exclude:
|
104
203
|
- spec/**/*
|
105
204
|
|
106
205
|
# Allow `object.should == object` syntax.
|
107
|
-
Void:
|
206
|
+
Lint/Void:
|
108
207
|
Exclude:
|
109
208
|
- spec/**/*
|
110
209
|
|
111
|
-
ClassAndModuleChildren:
|
210
|
+
Style/ClassAndModuleChildren:
|
112
211
|
Exclude:
|
113
212
|
- spec/**/*
|
114
213
|
|
115
|
-
|
214
|
+
Lint/BinaryOperatorWithIdenticalOperands:
|
116
215
|
Exclude:
|
117
216
|
- spec/**/*
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,106 @@
|
|
1
|
+
## 0.14.0
|
2
|
+
|
3
|
+
##### Breaking
|
4
|
+
|
5
|
+
* Require at least Ruby 2.6.3.
|
6
|
+
|
7
|
+
##### Enhancements
|
8
|
+
|
9
|
+
* Support DocC-style autolinks and callouts in markdown.
|
10
|
+
[John Fairhurst](https://github.com/johnfairh)
|
11
|
+
|
12
|
+
* Add `--source-host` option to support projects hosted on GitLab and
|
13
|
+
Bitbucket as well as GitHub. Options `--source-host-url` and
|
14
|
+
`--source-host-files-url` and new Mustache tags replace the 'github' versions
|
15
|
+
which remain as back-compatibility aliases.
|
16
|
+
[John Fairhurst](https://github.com/johnfairh)
|
17
|
+
[#314](https://github.com/realm/jazzy/issues/314)
|
18
|
+
|
19
|
+
* Add `rel="noopener"` to all `target="_blank"` links.
|
20
|
+
[JP Simard](https://github.com/jpsim)
|
21
|
+
|
22
|
+
##### Bug Fixes
|
23
|
+
|
24
|
+
* Fix source-host line number references in Swift symbolgraph mode, and
|
25
|
+
in ObjC mode for references to one-line declarations.
|
26
|
+
[John Fairhurst](https://github.com/johnfairh)
|
27
|
+
|
28
|
+
* Fix crash with `` ` ` `` in markdown.
|
29
|
+
[John Fairhurst](https://github.com/johnfairh)
|
30
|
+
[#1270](https://github.com/realm/jazzy/issues/1270)
|
31
|
+
|
32
|
+
* Fix symbolgraph mode with Xcode 13.
|
33
|
+
[John Fairhurst](https://github.com/johnfairh)
|
34
|
+
|
35
|
+
## 0.13.7
|
36
|
+
|
37
|
+
The next release of Jazzy will require a minimum of Ruby 2.6.
|
38
|
+
|
39
|
+
##### Breaking
|
40
|
+
|
41
|
+
* None.
|
42
|
+
|
43
|
+
##### Enhancements
|
44
|
+
|
45
|
+
* Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9,
|
46
|
+
KaTeX 0.13.5.
|
47
|
+
[John Fairhurst](https://github.com/johnfairh)
|
48
|
+
|
49
|
+
* Support the markdown [footnotes](https://www.markdownguide.org/extended-syntax/#footnotes) extension in all themes.
|
50
|
+
[John Fairhurst](https://github.com/johnfairh)
|
51
|
+
[#1246](https://github.com/realm/jazzy/issues/1246)
|
52
|
+
|
53
|
+
##### Bug Fixes
|
54
|
+
|
55
|
+
* Fix parameter doc comments in Swift symbolgraph mode.
|
56
|
+
[John Fairhurst](https://github.com/johnfairh)
|
57
|
+
[#1244](https://github.com/realm/jazzy/issues/1244)
|
58
|
+
|
59
|
+
## 0.13.6
|
60
|
+
|
61
|
+
##### Breaking
|
62
|
+
|
63
|
+
* None.
|
64
|
+
|
65
|
+
##### Enhancements
|
66
|
+
|
67
|
+
* Support documentation generation from `.swiftmodule` binaries using
|
68
|
+
`--swift-build-tool symbolgraph` with Swift 5.3.
|
69
|
+
[John Fairhurst](https://github.com/johnfairh)
|
70
|
+
|
71
|
+
##### Bug Fixes
|
72
|
+
|
73
|
+
* Always bypass codesigning when building Xcode projects.
|
74
|
+
[John Fairhurst](https://github.com/johnfairh)
|
75
|
+
[#1183](https://github.com/realm/jazzy/issues/1183)
|
76
|
+
|
77
|
+
## 0.13.5
|
78
|
+
|
79
|
+
##### Breaking
|
80
|
+
|
81
|
+
* None.
|
82
|
+
|
83
|
+
##### Enhancements
|
84
|
+
|
85
|
+
* Add search function to `apple` theme.
|
86
|
+
[Giles Payne](https://github.com/komakai)
|
87
|
+
[#726](https://github.com/realm/jazzy/issues/726)
|
88
|
+
|
89
|
+
* Add option `--[no-]separate-global-declarations` to always create separate
|
90
|
+
documentation pages for top-level declarations as well as classes,
|
91
|
+
structures, enums etc. even if they don't have members. As part of this,
|
92
|
+
improve the main page declaration in all modes.
|
93
|
+
[Nikolay Volosatov](https://github.com/bamx23)
|
94
|
+
[John Fairhurst](https://github.com/johnfairh)
|
95
|
+
|
96
|
+
##### Bug Fixes
|
97
|
+
|
98
|
+
* Style fixes for `apple` and `jony` themes to codeblocks inside lists and
|
99
|
+
links.
|
100
|
+
[John Fairhurst](https://github.com/johnfairh)
|
101
|
+
[#818](https://github.com/realm/jazzy/issues/818)
|
102
|
+
[#1177](https://github.com/realm/jazzy/issues/1177)
|
103
|
+
|
1
104
|
## 0.13.4
|
2
105
|
|
3
106
|
##### Breaking
|
data/CONTRIBUTING.md
CHANGED
@@ -13,12 +13,12 @@ the `CHANGELOG.md` file.
|
|
13
13
|
|
14
14
|
We follow the same syntax as CocoaPods' CHANGELOG.md:
|
15
15
|
|
16
|
-
1. One Markdown unnumbered list item
|
17
|
-
2.
|
16
|
+
1. One Markdown unnumbered list item describing the change.
|
17
|
+
2. Two trailing spaces on the last line describing the change.
|
18
18
|
3. A list of Markdown hyperlinks to the contributors to the change. One entry
|
19
|
-
per line
|
19
|
+
per line (and there's usually just one contributor).
|
20
20
|
4. A list of Markdown hyperlinks to the issues the change addresses. One entry
|
21
|
-
per line
|
21
|
+
per line (and there's usually just one hyperlink). Don't link to PRs here.
|
22
22
|
5. All CHANGELOG.md content is hard-wrapped at 80 characters.
|
23
23
|
|
24
24
|
## Updating the integration specs
|
@@ -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 12.5 installed to build the integration specs.
|
53
53
|
|
54
54
|
## Making changes to SourceKitten
|
55
55
|
|
data/Dangerfile
CHANGED
@@ -1,13 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Warn when there is a big PR
|
2
|
-
warn(
|
4
|
+
warn('Big PR') if git.lines_of_code > 500
|
3
5
|
|
4
6
|
# Don't let testing shortcuts get into master by accident
|
5
|
-
(git.modified_files + git.added_files - %w
|
7
|
+
(git.modified_files + git.added_files - %w[Dangerfile]).each do |file|
|
6
8
|
next unless File.file?(file)
|
9
|
+
|
7
10
|
contents = File.read(file)
|
8
11
|
if file.start_with?('spec')
|
9
|
-
|
10
|
-
|
12
|
+
failure("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
|
13
|
+
failure("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
|
11
14
|
end
|
12
15
|
end
|
13
16
|
|
@@ -17,12 +20,12 @@ has_app_changes = !git.modified_files.grep(/lib/).empty?
|
|
17
20
|
has_test_changes = !git.modified_files.grep(/spec/).empty?
|
18
21
|
|
19
22
|
# Add a CHANGELOG entry for app changes
|
20
|
-
if !git.modified_files.include?(
|
21
|
-
|
22
|
-
message
|
23
|
+
if !git.modified_files.include?('CHANGELOG.md') && has_app_changes
|
24
|
+
failure "Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/realm/jazzy/blob/master/CHANGELOG.md)."
|
25
|
+
message 'Note, we hard-wrap at 80 chars and use 2 spaces after the last line.'
|
23
26
|
end
|
24
27
|
|
25
28
|
# Non-trivial amounts of app changes without tests
|
26
29
|
if git.lines_of_code > 50 && has_app_changes && !has_test_changes
|
27
|
-
|
30
|
+
warn 'This PR may need tests.'
|
28
31
|
end
|