jazzy 0.14.0 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6b0e2553b3b64a0b692c79a6d62735a8f2e35d3322fe371bd926f050a8b0850
-  data.tar.gz: df8dd3fb4e80e0c9e69db6ec7f0337c5c9687a90a130bc899748ab789ee56d61
+  metadata.gz: 3e164bb425f5dbce55a0705ce07038b3b34fd5a055dd1a6d309250665cabb25f
+  data.tar.gz: 770f2055c954dfea38085151f571669be2013458f370556808f165b537fc4cf9
 SHA512:
-  metadata.gz: b6d2956ca649999f8802d00c59fadd0b5e608a9f46a553c1b5c54cb9d49962d69336fcfe822bde691409770412bf484da4f73cf8405720dbfe24aa6096a9ca60
-  data.tar.gz: 036cb12b85c127721690e88295ac68ed5b25dee219c7c87f5933a20d4e2a285fa75acbc4496a97637f09ca07b4caee193aca783ee73ffdd110a9a02fbe064f00
+  metadata.gz: a1d8ffd5b6bc1ed5637698a73c18918989105486d1da0198ba35450c7b9943802eaa4e5e31dde0d6fdaa54a6472fca85a8dbbbb3367db4be0de7a1ff80123333
+  data.tar.gz: c63d5645be9de11716c7b301bdc196749afdb841719010dc3a20f15ec3380a3acf61b220b976b4c5247f22a1368b4db9f6d1b4ff67a81d76c312e9f6c8be8964

data/.github/workflows/Tests.yml

@@ -15,23 +15,23 @@ jobs:
         with:
           ruby-version: 2.6
           bundler-cache: true
+      - name: Rubocop
+        run: |
+          bundle exec rake rubocop
       - name: Danger
         env:
           DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           bundle exec danger --verbose
-      - name: Rubocop
-        run: |
-          bundle exec rake rubocop
 
   spec:
-    runs-on: macos-11
+    runs-on: macos-12
     continue-on-error: true
     strategy:
       matrix:
         spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
     env:
-      DEVELOPER_DIR: /Applications/Xcode_12.5.app/Contents/Developer
+      DEVELOPER_DIR: /Applications/Xcode_14.0.app/Contents/Developer
     steps:
       - uses: actions/checkout@v2
         with:

data/.rubocop.yml

@@ -7,9 +7,15 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.6
 
-#- Pending Cops as of 1.19.0 ---------------------------------------------#
+#- Pending Cops as of 1.36.0 ---------------------------------------------#
 
-Gemspec/DateAssignment: # (new in 1.10)
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: false
+Layout/LineContinuationSpacing: # new in 1.31
   Enabled: true
 Layout/SpaceBeforeBrackets: # (new in 1.7)
   Enabled: true
@@ -17,6 +23,8 @@ Lint/AmbiguousAssignment: # (new in 1.7)
   Enabled: true
 Lint/AmbiguousRange: # (new in 1.19)
   Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
 Lint/DeprecatedConstants: # (new in 1.8)
   Enabled: true
 Lint/DuplicateBranch: # (new in 1.3)
@@ -29,8 +37,12 @@ Lint/EmptyClass: # (new in 1.3)
   Enabled: true
 Lint/EmptyInPattern: # (new in 1.16)
   Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
 Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
   Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
 Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
   Enabled: true
 Lint/NumberedParameterAssignment: # (new in 1.9)
@@ -39,6 +51,12 @@ Lint/OrAssignmentToConstant: # (new in 1.9)
   Enabled: true
 Lint/RedundantDirGlobSort: # (new in 1.8)
   Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
 Lint/SymbolConversion: # (new in 1.9)
   Enabled: true
 Lint/ToEnumArguments: # (new in 1.1)
@@ -49,16 +67,34 @@ Lint/UnexpectedBlockArity: # (new in 1.5)
   Enabled: true
 Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
 Naming/InclusiveLanguage: # (new in 1.18)
   Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
 Style/ArgumentsForwarding: # (new in 1.1)
   Enabled: true
 Style/CollectionCompact: # (new in 1.2)
   Enabled: true
 Style/DocumentDynamicEvalDefinition: # (new in 1.1)
   Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
 Style/EndlessMethod: # (new in 1.8)
   Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
 Style/HashConversion: # (new in 1.10)
   Enabled: true
 Style/HashExcept: # (new in 1.7)
@@ -67,18 +103,38 @@ Style/IfWithBooleanLiteralBranches: # (new in 1.9)
   Enabled: true
 Style/InPatternThen: # (new in 1.16)
   Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
 Style/MultilineInPatternThen: # (new in 1.16)
   Enabled: true
 Style/NegatedIfElseCondition: # (new in 1.2)
   Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
 Style/NilLambda: # (new in 1.3)
   Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
 Style/QuotedSymbols: # (new in 1.16)
   Enabled: true
 Style/RedundantArgument: # (new in 1.4)
   Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
 Style/RedundantSelfAssignmentBranch: # (new in 1.19)
   Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
 Style/StringChars: # (new in 1.12)
   Enabled: true
 Style/SwapValues: # (new in 1.1)
@@ -195,6 +251,10 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 10
 
+# Too much firing on basic arithmetic
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.

data/CHANGELOG.md

@@ -1,3 +1,78 @@
+## 0.14.3
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support Swift 5.7 and Xcode 14.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Update Javascript: jQuery 3.6.1, KaTeX 0.13.5  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* None.
+
+## 0.14.2
+
+##### Breaking
+
+* When building with Swift 5.6 and not passing `—-module` to Jazzy, declarations
+  may not be correctly identified as undocumented and docs may include unwanted
+  extensions.  Pass `—-module MyModuleName` to fix this.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Enhancements
+
+* Support using pre-generated symbolgraph files in Swift symbolgraph mode.  
+  [Nathan Wong](https://github.com/esteluk)
+
+* Issue a warning on some combinations of Objective-C flags.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#900](https://github.com/realm/jazzy/issues/900)
+
+* Support Swift 5.6.  The bundled `sourcekitten` is a universal binary.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* In Swift symbolgraph mode, stop including extensions to types that are beneath
+  the minimum ACL.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1291](https://github.com/realm/jazzy/issues/1291)
+
+## 0.14.1
+
+##### Breaking
+
+* Support Swift SPI groups.  Swift declarations marked `@_spi` are no longer
+  included in docs when `--min-acl` is set to `public` or `open`.  Use
+  `--include-spi-declarations` to include docs for these declarations.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1263](https://github.com/realm/jazzy/issues/1263)
+
+##### Enhancements
+
+* Correct line number references with Xcode 13.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support `union` declarations in Objective-C headers.  
+  [Brian Osborn](https://github.com/bosborn)
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support Swift concurrency features: identify actors and asynchronous
+  methods.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Improve HTML5 correctness, all themes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1280](https://github.com/realm/jazzy/issues/1280)
+
 ## 0.14.0
 
 ##### Breaking

data/CONTRIBUTING.md

@@ -49,7 +49,7 @@ git push
 You'll need push access to the integration specs repo to do this. You can
 request access from one of the maintainers when filing your PR.
 
-You must have Xcode 12.5 installed to build the integration specs.
+You must have Xcode 14 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.14.0)
+    jazzy (0.14.3)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4 (~> 1.3)
@@ -15,21 +15,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.3)
-    activesupport (5.2.6)
+    CFPropertyList (3.0.5)
+      rexml
+    activesupport (6.1.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     ast (2.4.2)
     atomos (0.1.3)
     bacon (1.2.0)
-    claide (1.0.3)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
@@ -37,10 +39,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.10.2)
-      addressable (~> 2.6)
+    cocoapods (1.11.3)
+      addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.10.2)
+      cocoapods-core (= 1.11.3)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -51,37 +53,37 @@ GEM
       escape (~> 0.0.4)
       fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.6.6)
+      molinillo (~> 0.8.0)
       nap (~> 1.0)
-      ruby-macho (~> 1.4)
-      xcodeproj (>= 1.19.0, < 2.0)
-    cocoapods-core (1.10.2)
-      activesupport (> 5.0, < 6)
-      addressable (~> 2.6)
+      ruby-macho (>= 1.0, < 3.0)
+      xcodeproj (>= 1.21.0, < 2.0)
+    cocoapods-core (1.11.3)
+      activesupport (>= 5.0, < 7)
+      addressable (~> 2.8)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
       netrc (~> 0.11)
-      public_suffix
+      public_suffix (~> 4.0)
       typhoeus (~> 1.0)
-    cocoapods-deintegrate (1.0.4)
-    cocoapods-downloader (1.4.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (1.6.3)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.1)
-    cocoapods-trunk (1.5.0)
+    cocoapods-trunk (1.6.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
-    danger (8.3.1)
+    danger (8.6.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -94,116 +96,124 @@ GEM
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (>= 1, < 4)
-    diffy (3.4.0)
+    diffy (3.4.2)
     escape (0.0.4)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    faraday (1.7.0)
+    faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
-    faraday-http-cache (2.2.0)
+    faraday-http-cache (2.4.1)
       faraday (>= 0.8)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    ffi (1.15.3)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.9.1)
+    git (1.12.0)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     httpclient (2.8.3)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
-    kramdown (2.3.1)
+    json (2.6.2)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
-    minitest (5.14.4)
-    mocha (1.13.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    mocha (1.14.0)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
-    molinillo (0.6.6)
-    multipart-post (2.1.1)
+    molinillo (0.8.0)
+    multipart-post (2.2.3)
     mustache (1.1.1)
     nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.21.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (13.0.6)
     rchardet (1.8.0)
     redcarpet (3.5.1)
-    regexp_parser (2.1.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rouge (3.26.0)
-    rubocop (1.19.0)
+    rouge (3.30.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.10.0)
-      parser (>= 3.0.1.1)
-    ruby-macho (1.4.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-macho (2.5.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
-    sawyer (0.8.2)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    sqlite3 (1.4.2)
-    terminal-table (3.0.1)
+      faraday (>= 0.17.3, < 3)
+    sqlite3 (1.5.0)
+      mini_portile2 (~> 2.8.0)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (2.0.0)
-    webmock (3.14.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.21.0)
+    xcodeproj (1.22.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
       rexml (~> 3.2.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby