jazzy 0.8.1 → 0.8.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +29 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile.lock +1 -1
- data/Rakefile +12 -10
- data/bin/libCYaml.dylib +0 -0
- data/bin/sourcekitten +0 -0
- data/circle.yml +1 -1
- data/jazzy.gemspec +0 -2
- data/lib/jazzy/config.rb +3 -1
- data/lib/jazzy/doc_builder.rb +4 -6
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/jazzy_markdown.rb +2 -1
- data/lib/jazzy/source_declaration/access_control_level.rb +8 -0
- data/lib/jazzy/sourcekitten.rb +10 -14
- data/lib/jazzy/stats.rb +74 -0
- data/spec/integration_spec.rb +4 -1
- metadata +6 -38
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist +0 -46
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist +0 -46
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist +0 -49
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist +0 -44
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams +0 -1
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftIOKit.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist +0 -46
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework +0 -0
- data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current +0 -1
- data/lib/jazzy/SourceKitten/Rakefile +0 -19
- data/lib/jazzy/SourceKitten/bin/sourcekitten +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3b7c32e3e4852444ab51ebfb2769dfd60a798e51
|
4
|
+
data.tar.gz: 79448b6ccf52510142b1612f279eb5bc46619b1d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4bf01a81ca089fa588c0f2a9630fc61384b17199d634930b0764e6b22d6b45135bb288661e9ae89e914a24c66e4fa9db11058f3b74993b3e436b9525b86f2800
|
7
|
+
data.tar.gz: 35fa4a004b97fce136135b53eeb13dc35cf6ebb40c27e12c6077badfc898bfe57526d65ea389299888ba040f0c2bc82031ab62fd3790bdcf85fec2e8909053c7
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,32 @@
|
|
1
|
+
## 0.8.2
|
2
|
+
|
3
|
+
##### Breaking
|
4
|
+
|
5
|
+
* None.
|
6
|
+
|
7
|
+
##### Enhancements
|
8
|
+
|
9
|
+
* Report number of included and skipped declarations in CLI output.
|
10
|
+
[John Fairhurst](https://github.com/johnfairh)
|
11
|
+
[#238](https://github.com/realm/jazzy/issues/238)
|
12
|
+
|
13
|
+
* Build ObjC docs with clang modules enabled by default (`-fmodules` flag).
|
14
|
+
[Maksym Grebenets](https://github.com/mgrebenets)
|
15
|
+
[#636](https://github.com/realm/jazzy/issues/636)
|
16
|
+
|
17
|
+
* Shave ~1MB from jazzy's gem distribution.
|
18
|
+
[JP Simard](https://github.com/jpsim)
|
19
|
+
|
20
|
+
##### Bug Fixes
|
21
|
+
|
22
|
+
* Fix support for Ruby 2.2.
|
23
|
+
[John Fairhurst](https://github.com/johnfairh)
|
24
|
+
[#801](https://github.com/realm/jazzy/issues/801)
|
25
|
+
|
26
|
+
* Fix many cases of incorrect, missing or superfluous docs on Swift
|
27
|
+
declarations.
|
28
|
+
[John Fairhurst](https://github.com/johnfairh)
|
29
|
+
|
1
30
|
## 0.8.1
|
2
31
|
|
3
32
|
##### Breaking
|
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 8.2 installed to build the integration specs.
|
52
|
+
You must have Xcode 8.3.2 installed to build the integration specs.
|
53
53
|
|
54
54
|
## Making changes to SourceKitten
|
55
55
|
|
data/Gemfile.lock
CHANGED
data/Rakefile
CHANGED
@@ -78,17 +78,19 @@ begin
|
|
78
78
|
|
79
79
|
desc 'Vendors SourceKitten'
|
80
80
|
task :sourcekitten do
|
81
|
-
|
82
|
-
|
81
|
+
sk_dir = 'SourceKitten'
|
82
|
+
Dir.chdir(sk_dir) do
|
83
|
+
`swift build -c release -Xswiftc -static-stdlib`
|
83
84
|
end
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
85
|
+
build_dir = "#{sk_dir}/.build/release"
|
86
|
+
FileUtils.cp_r Dir["#{build_dir}/{sourcekitten,*.dylib}"], 'bin'
|
87
|
+
Dir["#{build_dir}/*.dylib"].each do |file|
|
88
|
+
system 'install_name_tool', '-change', File.expand_path(file),
|
89
|
+
"@loader_path/#{File.basename(file)}", 'bin/sourcekitten'
|
90
|
+
end
|
91
|
+
system 'install_name_tool', '-delete_rpath',
|
92
|
+
(Pathname(`xcrun -find swift`) + '../../lib/swift/macosx').to_s,
|
93
|
+
'bin/sourcekitten'
|
92
94
|
end
|
93
95
|
|
94
96
|
rescue LoadError, NameError => e
|
data/bin/libCYaml.dylib
ADDED
Binary file
|
data/bin/sourcekitten
ADDED
Binary file
|
data/circle.yml
CHANGED
data/jazzy.gemspec
CHANGED
@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
|
|
17
17
|
spec.files = `git ls-files`.split($/)
|
18
18
|
spec.executables << 'jazzy'
|
19
19
|
|
20
|
-
spec.extensions = ['lib/jazzy/SourceKitten/Rakefile']
|
21
|
-
|
22
20
|
spec.add_runtime_dependency 'cocoapods', '~> 1.0'
|
23
21
|
spec.add_runtime_dependency 'mustache', '~> 0.99'
|
24
22
|
spec.add_runtime_dependency 'open4'
|
data/lib/jazzy/config.rb
CHANGED
@@ -162,6 +162,7 @@ module Jazzy
|
|
162
162
|
command_line: '--swift-version VERSION',
|
163
163
|
default: nil,
|
164
164
|
parse: ->(v) do
|
165
|
+
return nil if v.empty?
|
165
166
|
raise 'jazzy only supports Swift 2.0 or later.' if v.to_f < 2
|
166
167
|
v
|
167
168
|
end
|
@@ -258,7 +259,8 @@ module Jazzy
|
|
258
259
|
default: false
|
259
260
|
|
260
261
|
config_attr :min_acl,
|
261
|
-
command_line:
|
262
|
+
command_line:
|
263
|
+
'--min-acl [private | fileprivate | internal | public | open]',
|
262
264
|
description: 'minimum access control level to document',
|
263
265
|
default: 'public',
|
264
266
|
parse: ->(acl) do
|
data/lib/jazzy/doc_builder.rb
CHANGED
@@ -143,7 +143,7 @@ module Jazzy
|
|
143
143
|
# @param [Config] options Build options
|
144
144
|
# @return [SourceModule] the documented source module
|
145
145
|
def self.build_docs_for_sourcekitten_output(sourcekitten_output, options)
|
146
|
-
(docs,
|
146
|
+
(docs, stats) = SourceKitten.parse(
|
147
147
|
sourcekitten_output,
|
148
148
|
options.min_acl,
|
149
149
|
options.skip_undocumented,
|
@@ -152,15 +152,13 @@ module Jazzy
|
|
152
152
|
|
153
153
|
prepare_output_dir(options.output, options.clean)
|
154
154
|
|
155
|
-
|
156
|
-
"with #{undocumented.count} undocumented symbol" \
|
157
|
-
"#{undocumented.count == 1 ? '' : 's'}"
|
155
|
+
stats.report
|
158
156
|
|
159
157
|
unless options.skip_documentation
|
160
|
-
build_site(docs,
|
158
|
+
build_site(docs, stats.doc_coverage, options)
|
161
159
|
end
|
162
160
|
|
163
|
-
write_lint_report(
|
161
|
+
write_lint_report(stats.undocumented_decls, options)
|
164
162
|
end
|
165
163
|
|
166
164
|
def self.relative_path_if_inside(path, base_path)
|
data/lib/jazzy/gem_version.rb
CHANGED
data/lib/jazzy/jazzy_markdown.rb
CHANGED
@@ -148,7 +148,8 @@ module Jazzy
|
|
148
148
|
def render_param_returns(matches)
|
149
149
|
body = matches[:intro].strip + matches[:outro].strip
|
150
150
|
body = "<p>#{body}</p>" unless body.start_with?('<p>')
|
151
|
-
|
151
|
+
# call smartypants for pretty quotes etc.
|
152
|
+
postprocess(body)
|
152
153
|
end
|
153
154
|
end
|
154
155
|
|
@@ -89,6 +89,14 @@ module Jazzy
|
|
89
89
|
def <=>(other)
|
90
90
|
LEVELS[level] <=> LEVELS[other.level]
|
91
91
|
end
|
92
|
+
|
93
|
+
def included_levels
|
94
|
+
LEVELS.select { |_, v| v >= LEVELS[level] }.keys
|
95
|
+
end
|
96
|
+
|
97
|
+
def excluded_levels
|
98
|
+
LEVELS.select { |_, v| v < LEVELS[level] }.keys
|
99
|
+
end
|
92
100
|
end
|
93
101
|
end
|
94
102
|
end
|
data/lib/jazzy/sourcekitten.rb
CHANGED
@@ -8,6 +8,7 @@ require 'jazzy/executable'
|
|
8
8
|
require 'jazzy/highlighter'
|
9
9
|
require 'jazzy/source_declaration'
|
10
10
|
require 'jazzy/source_mark'
|
11
|
+
require 'jazzy/stats'
|
11
12
|
|
12
13
|
ELIDED_AUTOLINK_TOKEN = '36f8f5912051ae747ef441d6511ca4cb'.freeze
|
13
14
|
|
@@ -46,8 +47,6 @@ end
|
|
46
47
|
module Jazzy
|
47
48
|
# This module interacts with the sourcekitten command-line executable
|
48
49
|
module SourceKitten
|
49
|
-
@documented_count = 0
|
50
|
-
@undocumented_decls = []
|
51
50
|
@default_abstract = Markdown.render('Undocumented').freeze
|
52
51
|
|
53
52
|
# Group root-level docs by custom categories (if any) and type
|
@@ -190,7 +189,8 @@ module Jazzy
|
|
190
189
|
arguments += ['--objc', options.umbrella_header.to_s, '--', '-x',
|
191
190
|
'objective-c', '-isysroot',
|
192
191
|
`xcrun --show-sdk-path --sdk #{options.sdk}`.chomp,
|
193
|
-
'-I', options.framework_root.to_s
|
192
|
+
'-I', options.framework_root.to_s,
|
193
|
+
'-fmodules']
|
194
194
|
end
|
195
195
|
# add additional -I arguments for each subdirectory of framework_root
|
196
196
|
unless options.framework_root.nil?
|
@@ -213,7 +213,7 @@ module Jazzy
|
|
213
213
|
else
|
214
214
|
env = ENV
|
215
215
|
end
|
216
|
-
bin_path = Pathname(__FILE__)
|
216
|
+
bin_path = Pathname(__FILE__) + '../../../bin/sourcekitten'
|
217
217
|
output, = Executable.execute_command(bin_path, arguments, true, env: env)
|
218
218
|
output
|
219
219
|
end
|
@@ -263,7 +263,8 @@ module Jazzy
|
|
263
263
|
end
|
264
264
|
end
|
265
265
|
|
266
|
-
SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
|
266
|
+
acl_ok = SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
|
267
|
+
acl_ok.tap { @stats.add_acl_skipped unless acl_ok }
|
267
268
|
end
|
268
269
|
# rubocop:enable Metrics/CyclomaticComplexity
|
269
270
|
# rubocop:enable Metrics/PerceivedComplexity
|
@@ -278,7 +279,7 @@ module Jazzy
|
|
278
279
|
filepath = doc['key.filepath']
|
279
280
|
objc = Config.instance.objc_mode
|
280
281
|
if objc || should_mark_undocumented(doc['key.kind'], filepath)
|
281
|
-
@
|
282
|
+
@stats.add_undocumented(declaration)
|
282
283
|
end
|
283
284
|
return nil if !documented_child?(doc) && @skip_undocumented
|
284
285
|
make_default_doc_info(declaration)
|
@@ -318,7 +319,7 @@ module Jazzy
|
|
318
319
|
declaration.return = Markdown.rendered_returns
|
319
320
|
declaration.parameters = parameters(doc, Markdown.rendered_parameters)
|
320
321
|
|
321
|
-
@
|
322
|
+
@stats.add_documented
|
322
323
|
end
|
323
324
|
# rubocop:enable Metrics/CyclomaticComplexity
|
324
325
|
# rubocop:enable Metrics/PerceivedComplexity
|
@@ -389,12 +390,6 @@ module Jazzy
|
|
389
390
|
# rubocop:enable Metrics/CyclomaticComplexity
|
390
391
|
# rubocop:enable Metrics/MethodLength
|
391
392
|
|
392
|
-
def self.doc_coverage
|
393
|
-
return 0 if @documented_count == 0 && @undocumented_decls.count == 0
|
394
|
-
(100 * @documented_count) /
|
395
|
-
(@undocumented_decls.count + @documented_count)
|
396
|
-
end
|
397
|
-
|
398
393
|
# Merges multiple extensions of the same entity into a single document.
|
399
394
|
#
|
400
395
|
# Merges extensions into the protocol/class/struct/enum they extend, if it
|
@@ -614,6 +609,7 @@ module Jazzy
|
|
614
609
|
def self.parse(sourcekitten_output, min_acl, skip_undocumented, inject_docs)
|
615
610
|
@min_acl = min_acl
|
616
611
|
@skip_undocumented = skip_undocumented
|
612
|
+
@stats = Stats.new
|
617
613
|
sourcekitten_json = filter_excluded_files(JSON.parse(sourcekitten_output))
|
618
614
|
docs = make_source_declarations(sourcekitten_json).concat inject_docs
|
619
615
|
docs = deduplicate_declarations(docs)
|
@@ -628,7 +624,7 @@ module Jazzy
|
|
628
624
|
docs = group_docs(docs)
|
629
625
|
make_doc_urls(docs)
|
630
626
|
autolink(docs, ungrouped_docs)
|
631
|
-
[docs,
|
627
|
+
[docs, @stats]
|
632
628
|
end
|
633
629
|
end
|
634
630
|
end
|
data/lib/jazzy/stats.rb
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
module Jazzy
|
2
|
+
# Collect + report metadata about a processed module
|
3
|
+
class Stats
|
4
|
+
include Config::Mixin
|
5
|
+
|
6
|
+
attr_reader :documented, :acl_skipped
|
7
|
+
attr_reader :undocumented_decls
|
8
|
+
|
9
|
+
def add_documented
|
10
|
+
@documented += 1
|
11
|
+
end
|
12
|
+
|
13
|
+
def add_acl_skipped
|
14
|
+
@acl_skipped += 1
|
15
|
+
end
|
16
|
+
|
17
|
+
def add_undocumented(decl)
|
18
|
+
@undocumented_decls << decl
|
19
|
+
end
|
20
|
+
|
21
|
+
def acl_included
|
22
|
+
documented + undocumented
|
23
|
+
end
|
24
|
+
|
25
|
+
def undocumented
|
26
|
+
undocumented_decls.count
|
27
|
+
end
|
28
|
+
|
29
|
+
def initialize
|
30
|
+
@documented = @acl_skipped = 0
|
31
|
+
@undocumented_decls = []
|
32
|
+
end
|
33
|
+
|
34
|
+
def report
|
35
|
+
puts "#{doc_coverage}\% documentation coverage " \
|
36
|
+
"with #{undocumented} undocumented " \
|
37
|
+
"#{symbol_or_symbols(undocumented)}"
|
38
|
+
|
39
|
+
if acl_included > 0
|
40
|
+
swift_acls = comma_list(config.min_acl.included_levels)
|
41
|
+
puts "included #{acl_included} " +
|
42
|
+
(config.objc_mode ? '' : "#{swift_acls} ") +
|
43
|
+
symbol_or_symbols(acl_included)
|
44
|
+
end
|
45
|
+
|
46
|
+
if !config.objc_mode && acl_skipped > 0
|
47
|
+
puts "skipped #{acl_skipped} " \
|
48
|
+
"#{comma_list(config.min_acl.excluded_levels)} " \
|
49
|
+
"#{symbol_or_symbols(acl_skipped)} " \
|
50
|
+
'(use `--min-acl` to specify a different minimum ACL)'
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def doc_coverage
|
55
|
+
return 0 if acl_included == 0
|
56
|
+
(100 * documented) / acl_included
|
57
|
+
end
|
58
|
+
|
59
|
+
private
|
60
|
+
|
61
|
+
def comma_list(items)
|
62
|
+
case items.count
|
63
|
+
when 0 then ''
|
64
|
+
when 1 then items[0]
|
65
|
+
when 2 then "#{items[0]} or #{items[1]}"
|
66
|
+
else "#{items[0..-2].join(', ')}, or #{items[-1]}"
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
def symbol_or_symbols(count)
|
71
|
+
count == 1 ? 'symbol' : 'symbols'
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
data/spec/integration_spec.rb
CHANGED
@@ -203,7 +203,10 @@ describe_cli 'jazzy' do
|
|
203
203
|
|
204
204
|
describe 'Creates Siesta docs' do
|
205
205
|
behaves_like cli_spec 'document_siesta',
|
206
|
-
|
206
|
+
# Siesta already has Docs/
|
207
|
+
'--output api-docs',
|
208
|
+
# Use default Swift rather than the specified 3.0.2
|
209
|
+
'--swift-version='
|
207
210
|
end
|
208
211
|
|
209
212
|
describe 'Creates docs for Swift project with a variety of contents' do
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jazzy
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.8.
|
4
|
+
version: 0.8.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- JP Simard
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2017-05-
|
13
|
+
date: 2017-05-13 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: cocoapods
|
@@ -158,8 +158,7 @@ email:
|
|
158
158
|
- jp@realm.io
|
159
159
|
executables:
|
160
160
|
- jazzy
|
161
|
-
extensions:
|
162
|
-
- lib/jazzy/SourceKitten/Rakefile
|
161
|
+
extensions: []
|
163
162
|
extra_rdoc_files: []
|
164
163
|
files:
|
165
164
|
- ".gitignore"
|
@@ -174,6 +173,8 @@ files:
|
|
174
173
|
- README.md
|
175
174
|
- Rakefile
|
176
175
|
- bin/jazzy
|
176
|
+
- bin/libCYaml.dylib
|
177
|
+
- bin/sourcekitten
|
177
178
|
- circle.yml
|
178
179
|
- images/logo.jpg
|
179
180
|
- images/logo.sketch
|
@@ -181,40 +182,6 @@ files:
|
|
181
182
|
- images/screenshot.jpg
|
182
183
|
- jazzy.gemspec
|
183
184
|
- lib/jazzy.rb
|
184
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources
|
185
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
|
186
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant
|
187
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources
|
188
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant
|
189
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist
|
190
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current
|
191
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources
|
192
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result
|
193
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist
|
194
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result
|
195
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current
|
196
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources
|
197
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
|
198
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
|
199
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
|
200
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current
|
201
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources
|
202
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist
|
203
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams
|
204
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current
|
205
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams
|
206
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
|
207
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
|
208
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib
|
209
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib
|
210
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib
|
211
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftIOKit.dylib
|
212
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib
|
213
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist
|
214
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
|
215
|
-
- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current
|
216
|
-
- lib/jazzy/SourceKitten/Rakefile
|
217
|
-
- lib/jazzy/SourceKitten/bin/sourcekitten
|
218
185
|
- lib/jazzy/config.rb
|
219
186
|
- lib/jazzy/doc.rb
|
220
187
|
- lib/jazzy/doc_builder.rb
|
@@ -235,6 +202,7 @@ files:
|
|
235
202
|
- lib/jazzy/source_mark.rb
|
236
203
|
- lib/jazzy/source_module.rb
|
237
204
|
- lib/jazzy/sourcekitten.rb
|
205
|
+
- lib/jazzy/stats.rb
|
238
206
|
- lib/jazzy/themes/apple/assets/css/highlight.css.scss
|
239
207
|
- lib/jazzy/themes/apple/assets/css/jazzy.css.scss
|
240
208
|
- lib/jazzy/themes/apple/assets/img/carat.png
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/Resources
|
data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/SourceKittenFrame
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f
|
Binary file
|
@@ -1,46 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
3
|
-
<plist version="1.0">
|
4
|
-
<dict>
|
5
|
-
<key>BuildMachineOSBuild</key>
|
6
|
-
<string>16E195</string>
|
7
|
-
<key>CFBundleDevelopmentRegion</key>
|
8
|
-
<string>en</string>
|
9
|
-
<key>CFBundleExecutable</key>
|
10
|
-
<string>Commandant</string>
|
11
|
-
<key>CFBundleIdentifier</key>
|
12
|
-
<string>org.carthage.Commandant</string>
|
13
|
-
<key>CFBundleInfoDictionaryVersion</key>
|
14
|
-
<string>6.0</string>
|
15
|
-
<key>CFBundleName</key>
|
16
|
-
<string>Commandant</string>
|
17
|
-
<key>CFBundlePackageType</key>
|
18
|
-
<string>FMWK</string>
|
19
|
-
<key>CFBundleShortVersionString</key>
|
20
|
-
<string>0.12.0</string>
|
21
|
-
<key>CFBundleSignature</key>
|
22
|
-
<string>????</string>
|
23
|
-
<key>CFBundleSupportedPlatforms</key>
|
24
|
-
<array>
|
25
|
-
<string>MacOSX</string>
|
26
|
-
</array>
|
27
|
-
<key>CFBundleVersion</key>
|
28
|
-
<string>1</string>
|
29
|
-
<key>DTCompiler</key>
|
30
|
-
<string>com.apple.compilers.llvm.clang.1_0</string>
|
31
|
-
<key>DTPlatformBuild</key>
|
32
|
-
<string>8E2002</string>
|
33
|
-
<key>DTPlatformVersion</key>
|
34
|
-
<string>GM</string>
|
35
|
-
<key>DTSDKBuild</key>
|
36
|
-
<string>16E185</string>
|
37
|
-
<key>DTSDKName</key>
|
38
|
-
<string>macosx10.12</string>
|
39
|
-
<key>DTXcode</key>
|
40
|
-
<string>0832</string>
|
41
|
-
<key>DTXcodeBuild</key>
|
42
|
-
<string>8E2002</string>
|
43
|
-
<key>NSHumanReadableCopyright</key>
|
44
|
-
<string>Copyright © 2014 Carthage. All rights reserved.</string>
|
45
|
-
</dict>
|
46
|
-
</plist>
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame
|
@@ -1,46 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
3
|
-
<plist version="1.0">
|
4
|
-
<dict>
|
5
|
-
<key>BuildMachineOSBuild</key>
|
6
|
-
<string>16E195</string>
|
7
|
-
<key>CFBundleDevelopmentRegion</key>
|
8
|
-
<string>en</string>
|
9
|
-
<key>CFBundleExecutable</key>
|
10
|
-
<string>Result</string>
|
11
|
-
<key>CFBundleIdentifier</key>
|
12
|
-
<string>com.antitypical.Result</string>
|
13
|
-
<key>CFBundleInfoDictionaryVersion</key>
|
14
|
-
<string>6.0</string>
|
15
|
-
<key>CFBundleName</key>
|
16
|
-
<string>Result</string>
|
17
|
-
<key>CFBundlePackageType</key>
|
18
|
-
<string>FMWK</string>
|
19
|
-
<key>CFBundleShortVersionString</key>
|
20
|
-
<string>3.2.1</string>
|
21
|
-
<key>CFBundleSignature</key>
|
22
|
-
<string>????</string>
|
23
|
-
<key>CFBundleSupportedPlatforms</key>
|
24
|
-
<array>
|
25
|
-
<string>MacOSX</string>
|
26
|
-
</array>
|
27
|
-
<key>CFBundleVersion</key>
|
28
|
-
<string>1</string>
|
29
|
-
<key>DTCompiler</key>
|
30
|
-
<string>com.apple.compilers.llvm.clang.1_0</string>
|
31
|
-
<key>DTPlatformBuild</key>
|
32
|
-
<string>8E2002</string>
|
33
|
-
<key>DTPlatformVersion</key>
|
34
|
-
<string>GM</string>
|
35
|
-
<key>DTSDKBuild</key>
|
36
|
-
<string>16E185</string>
|
37
|
-
<key>DTSDKName</key>
|
38
|
-
<string>macosx10.12</string>
|
39
|
-
<key>DTXcode</key>
|
40
|
-
<string>0832</string>
|
41
|
-
<key>DTXcodeBuild</key>
|
42
|
-
<string>8E2002</string>
|
43
|
-
<key>NSHumanReadableCopyright</key>
|
44
|
-
<string>Copyright © 2015 Rob Rix. All rights reserved.</string>
|
45
|
-
</dict>
|
46
|
-
</plist>
|
Binary file
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr
|
@@ -1,49 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
3
|
-
<plist version="1.0">
|
4
|
-
<dict>
|
5
|
-
<key>BuildMachineOSBuild</key>
|
6
|
-
<string>16E195</string>
|
7
|
-
<key>CFBundleDevelopmentRegion</key>
|
8
|
-
<string>en</string>
|
9
|
-
<key>CFBundleExecutable</key>
|
10
|
-
<string>SWXMLHash</string>
|
11
|
-
<key>CFBundleIdentifier</key>
|
12
|
-
<string>drmohundro.SWXMLHash</string>
|
13
|
-
<key>CFBundleInfoDictionaryVersion</key>
|
14
|
-
<string>6.0</string>
|
15
|
-
<key>CFBundleName</key>
|
16
|
-
<string>SWXMLHash</string>
|
17
|
-
<key>CFBundlePackageType</key>
|
18
|
-
<string>FMWK</string>
|
19
|
-
<key>CFBundleShortVersionString</key>
|
20
|
-
<string>2.0</string>
|
21
|
-
<key>CFBundleSignature</key>
|
22
|
-
<string>????</string>
|
23
|
-
<key>CFBundleSupportedPlatforms</key>
|
24
|
-
<array>
|
25
|
-
<string>MacOSX</string>
|
26
|
-
</array>
|
27
|
-
<key>CFBundleVersion</key>
|
28
|
-
<string>1</string>
|
29
|
-
<key>DTCompiler</key>
|
30
|
-
<string>com.apple.compilers.llvm.clang.1_0</string>
|
31
|
-
<key>DTPlatformBuild</key>
|
32
|
-
<string>8E2002</string>
|
33
|
-
<key>DTPlatformVersion</key>
|
34
|
-
<string>GM</string>
|
35
|
-
<key>DTSDKBuild</key>
|
36
|
-
<string>16E185</string>
|
37
|
-
<key>DTSDKName</key>
|
38
|
-
<string>macosx10.12</string>
|
39
|
-
<key>DTXcode</key>
|
40
|
-
<string>0832</string>
|
41
|
-
<key>DTXcodeBuild</key>
|
42
|
-
<string>8E2002</string>
|
43
|
-
<key>UIDeviceFamily</key>
|
44
|
-
<array>
|
45
|
-
<integer>1</integer>
|
46
|
-
<integer>2</integer>
|
47
|
-
</array>
|
48
|
-
</dict>
|
49
|
-
</plist>
|
Binary file
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo
|
@@ -1,44 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
3
|
-
<plist version="1.0">
|
4
|
-
<dict>
|
5
|
-
<key>BuildMachineOSBuild</key>
|
6
|
-
<string>16E195</string>
|
7
|
-
<key>CFBundleDevelopmentRegion</key>
|
8
|
-
<string>en</string>
|
9
|
-
<key>CFBundleExecutable</key>
|
10
|
-
<string>Yams</string>
|
11
|
-
<key>CFBundleIdentifier</key>
|
12
|
-
<string>Yams</string>
|
13
|
-
<key>CFBundleInfoDictionaryVersion</key>
|
14
|
-
<string>6.0</string>
|
15
|
-
<key>CFBundleName</key>
|
16
|
-
<string>Yams</string>
|
17
|
-
<key>CFBundlePackageType</key>
|
18
|
-
<string>FMWK</string>
|
19
|
-
<key>CFBundleShortVersionString</key>
|
20
|
-
<string>0.3.1</string>
|
21
|
-
<key>CFBundleSignature</key>
|
22
|
-
<string>????</string>
|
23
|
-
<key>CFBundleSupportedPlatforms</key>
|
24
|
-
<array>
|
25
|
-
<string>MacOSX</string>
|
26
|
-
</array>
|
27
|
-
<key>CFBundleVersion</key>
|
28
|
-
<string>1</string>
|
29
|
-
<key>DTCompiler</key>
|
30
|
-
<string>com.apple.compilers.llvm.clang.1_0</string>
|
31
|
-
<key>DTPlatformBuild</key>
|
32
|
-
<string>8E2002</string>
|
33
|
-
<key>DTPlatformVersion</key>
|
34
|
-
<string>GM</string>
|
35
|
-
<key>DTSDKBuild</key>
|
36
|
-
<string>16E185</string>
|
37
|
-
<key>DTSDKName</key>
|
38
|
-
<string>macosx10.12</string>
|
39
|
-
<key>DTXcode</key>
|
40
|
-
<string>0832</string>
|
41
|
-
<key>DTXcodeBuild</key>
|
42
|
-
<string>8E2002</string>
|
43
|
-
</dict>
|
44
|
-
</plist>
|
Binary file
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
@@ -1,46 +0,0 @@
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
3
|
-
<plist version="1.0">
|
4
|
-
<dict>
|
5
|
-
<key>BuildMachineOSBuild</key>
|
6
|
-
<string>16E195</string>
|
7
|
-
<key>CFBundleDevelopmentRegion</key>
|
8
|
-
<string>en</string>
|
9
|
-
<key>CFBundleExecutable</key>
|
10
|
-
<string>SourceKittenFramework</string>
|
11
|
-
<key>CFBundleIdentifier</key>
|
12
|
-
<string>com.sourcekitten.SourceKittenFramework</string>
|
13
|
-
<key>CFBundleInfoDictionaryVersion</key>
|
14
|
-
<string>6.0</string>
|
15
|
-
<key>CFBundleName</key>
|
16
|
-
<string>SourceKittenFramework</string>
|
17
|
-
<key>CFBundlePackageType</key>
|
18
|
-
<string>FMWK</string>
|
19
|
-
<key>CFBundleShortVersionString</key>
|
20
|
-
<string>0.17.2</string>
|
21
|
-
<key>CFBundleSignature</key>
|
22
|
-
<string>????</string>
|
23
|
-
<key>CFBundleSupportedPlatforms</key>
|
24
|
-
<array>
|
25
|
-
<string>MacOSX</string>
|
26
|
-
</array>
|
27
|
-
<key>CFBundleVersion</key>
|
28
|
-
<string>1</string>
|
29
|
-
<key>DTCompiler</key>
|
30
|
-
<string>com.apple.compilers.llvm.clang.1_0</string>
|
31
|
-
<key>DTPlatformBuild</key>
|
32
|
-
<string>8E2002</string>
|
33
|
-
<key>DTPlatformVersion</key>
|
34
|
-
<string>GM</string>
|
35
|
-
<key>DTSDKBuild</key>
|
36
|
-
<string>16E185</string>
|
37
|
-
<key>DTSDKName</key>
|
38
|
-
<string>macosx10.12</string>
|
39
|
-
<key>DTXcode</key>
|
40
|
-
<string>0832</string>
|
41
|
-
<key>DTXcodeBuild</key>
|
42
|
-
<string>8E2002</string>
|
43
|
-
<key>NSHumanReadableCopyright</key>
|
44
|
-
<string>Copyright © 2015 SourceKitten. All rights reserved.</string>
|
45
|
-
</dict>
|
46
|
-
</plist>
|
Binary file
|
@@ -1 +0,0 @@
|
|
1
|
-
lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A
|
@@ -1,19 +0,0 @@
|
|
1
|
-
# This Rakefile just ensures that the necessary framework symlinks are in place
|
2
|
-
# when installed as a gem, as RubyGems doesn't play nice with symlinks.
|
3
|
-
|
4
|
-
task :prepare do
|
5
|
-
Dir.glob('**/*.framework/').each do |fw|
|
6
|
-
Dir.chdir(fw) do
|
7
|
-
basename = File.basename(fw, '.framework')
|
8
|
-
FileUtils.rm_f(basename)
|
9
|
-
FileUtils.rm_f('Versions/Current')
|
10
|
-
FileUtils.rm_f('Resources')
|
11
|
-
|
12
|
-
File.symlink('A', 'Versions/Current')
|
13
|
-
File.symlink("Versions/Current/#{basename}", "#{basename}")
|
14
|
-
File.symlink('Versions/Current/Resources', 'Resources')
|
15
|
-
end
|
16
|
-
end
|
17
|
-
end
|
18
|
-
|
19
|
-
task default: :prepare
|
Binary file
|