b182caf8e4
Summary: Bumps [dokka-gradle-plugin](https://github.com/Kotlin/dokka) from 1.6.10 to 1.6.20. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/Kotlin/dokka/releases">dokka-gradle-plugin's releases</a>.</em></p> <blockquote> <h2>1.6.20 Beta</h2> <h2>Features</h2> <ul> <li>Introduce <code>documentedVisibilities</code> setting that allows including/excluding any visibility modifier in documentation. This is a more flexible replacement for <code>includeNonPublic</code>, which has now been deprecated (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2270">Kotlin/dokka#2270</a>)</li> <li>Make HTML pages customizable through FreeMarker HTML templates (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2374">Kotlin/dokka#2374</a>)</li> <li>Add global settings to JSON dokka CLI input (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2292">Kotlin/dokka#2292</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> </ul> <h2>HTML format changes</h2> <ul> <li>Add vertical alignment (wrapping) of signatures when 3 and more parameters are present (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2309">Kotlin/dokka#2309</a>)</li> <li>Enhance primary constructor signature, display <code>val</code>/<code>var</code> keywords and default values (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2313">Kotlin/dokka#2313</a>)</li> <li>Add a level of indentation to childless items in navigation tree (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2291">Kotlin/dokka#2291</a>)</li> <li>Add horizontal margin to breadcrumbs delimiter (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2285">Kotlin/dokka#2285</a>)</li> <li>Fixed various CSS rendering issues (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2284">Kotlin/dokka#2284</a>, <a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2389">Kotlin/dokka#2389</a>)</li> </ul> <h2>Bugfixes</h2> <ul> <li>Fixed <code>OutOfMemoryError: Metaspace</code>-related issues for the majority of cases (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2216">Kotlin/dokka#2216</a>)</li> <li>Fixed classpath issues for HMPP libraries (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2431">Kotlin/dokka#2431</a>)</li> <li>Using <code>@</code> symbol within code blocks in <code>.md</code> files doesn't lead to cropped documents anymore (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2418">Kotlin/dokka#2418</a>)</li> <li>Fixed incorrect placement of HTML head tags, which led to missing favicon in multi-module projects (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2365">Kotlin/dokka#2365</a>)</li> <li>Fixed resolution of ultralight methods that led to flaky signature generation (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2400">Kotlin/dokka#2400</a>)</li> <li>Coroutines dispatchers are now shut down after each module pass to avoid resource leaks (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2325">Kotlin/dokka#2325</a>)</li> <li>Suppressed property setters are now excluded from documentation (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2220">Kotlin/dokka#2220</a>)</li> <li>Suppressing extensions doesn't fail builds anymore (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2348">Kotlin/dokka#2348</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> <li>Fixed java getter / setter name generation for kotlin-java interop, now <code>isBoolean</code> instead of <code>getBoolean</code> (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2356">Kotlin/dokka#2356</a>), thanks to <a href="https://github.com/CharlesG-Branch"><code>@CharlesG-Branch</code></a>!</li> <li>Fixed MathJax plugin, previously completely broken (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2342">Kotlin/dokka#2342</a>), thanks to <a href="https://github.com/wyskoj"><code>@wyskoj</code></a>!</li> <li>Fixed Input/Output streams to minimize resource leaks (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2312">Kotlin/dokka#2312</a>, <a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2319">Kotlin/dokka#2319</a>)</li> </ul> <h2>Plugin API Changes</h2> <ul> <li>Add an extension point for rendering custom <a href="https://kotlinlang.org/docs/kotlin-doc.html#block-tags">documentation tags</a> (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2343">Kotlin/dokka#2343</a>)</li> <li>Add an extension point for an external documentable provider (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2307">Kotlin/dokka#2307</a>), thanks to <a href="https://github.com/Kordyjan"><code>@Kordyjan</code></a>!</li> <li>Add filtering stategies extension point and fix constructors in Kotlin-as-Java (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2277">Kotlin/dokka#2277</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> <li>Expose Kotlin-as-Java methods that could be used not only as part of transformers (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2351">Kotlin/dokka#2351</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> <li>Refactor Ancestry Graphs (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2326">Kotlin/dokka#2326</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> <li>Fixed resolving of DRIs for Enum Entries (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2305">Kotlin/dokka#2305</a>), thanks to <a href="https://github.com/BarkingBad"><code>@BarkingBad</code></a>!</li> </ul> <h2>General Improvements</h2> <ul> <li>Collect annotations from <code>package-info.java</code> (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2331">Kotlin/dokka#2331</a>), thanks to <a href="https://github.com/ember-rose"><code>@ember-rose</code></a>!</li> <li>Add support for header tags (<code><h1></code> / <code><h2></code> / <code><h3></code>) in Javadoc (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2345">Kotlin/dokka#2345</a>), thanks to <a href="https://github.com/asfalcone"><code>@asfalcone</code></a>!</li> <li>Add an option to merge implicit expect-actual declarations, enables merging of pages for related declarations which are not connected via <code>expect</code>-<code>actual</code> keywords (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2316">Kotlin/dokka#2316</a>)</li> <li>Add a note about using Dokka in a precompiled script plugin (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2303">Kotlin/dokka#2303</a>), thanks to <a href="https://github.com/chkpnt"><code>@chkpnt</code></a>!</li> <li>Fixed wrong Groovy DSL example (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2302">Kotlin/dokka#2302</a>), thanks to <a href="https://github.com/chkpnt"><code>@chkpnt</code></a>!</li> <li>Various code cleanups (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2165">Kotlin/dokka#2165</a>, <a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2360">Kotlin/dokka#2360</a>, <a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2364">Kotlin/dokka#2364</a>, <a href="https://github-redirect.dependabot.com/Kotlin/dokka/pull/2385">Kotlin/dokka#2385</a>), thanks to <a href="https://github.com/Goooler"><code>@Goooler</code></a>!</li> </ul> <h2>Known issues</h2> <ul> <li>Kotlin Multiplatform projects that use <code>.klib</code> libraries may experience problems. There will be a separate <code>1.6.21</code> release that will address this issue shortly.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="bf0476ec3e"><code>bf0476e</code></a> Update documentation, examples and test references to 1.6.20 (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2440">https://github.com/facebook/flipper/issues/2440</a>)</li> <li><a href="301b12fae7"><code>301b12f</code></a> Update version to 1.6.20 release</li> <li><a href="92adc586b8"><code>92adc58</code></a> Fix classpath in HMPP (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2431">https://github.com/facebook/flipper/issues/2431</a>)</li> <li><a href="34916ec2dc"><code>34916ec</code></a> Fix using <code>@</code> symbol inside code block (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2418">https://github.com/facebook/flipper/issues/2418</a>)</li> <li><a href="5af8d0f8db"><code>5af8d0f</code></a> Update mkdocs gradle plugin to fix documentation generation (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2422">https://github.com/facebook/flipper/issues/2422</a>)</li> <li><a href="3bb04e047e"><code>3bb04e0</code></a> Update Kotlin to 1.6.20 (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2417">https://github.com/facebook/flipper/issues/2417</a>)</li> <li><a href="cb596b4787"><code>cb596b4</code></a> Fix type parameter annotation regression (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2388">https://github.com/facebook/flipper/issues/2388</a>) (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2410">https://github.com/facebook/flipper/issues/2410</a>)</li> <li><a href="a20b4760c6"><code>a20b476</code></a> Update version to 1.6.20-RC</li> <li><a href="a36b3af639"><code>a36b3af</code></a> Update Kotlin to 1.6.20-RC2 (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2407">https://github.com/facebook/flipper/issues/2407</a>)</li> <li><a href="57133de2fe"><code>57133de</code></a> Bug resolving in ultralightmethod (<a href="https://github-redirect.dependabot.com/Kotlin/dokka/issues/2400">https://github.com/facebook/flipper/issues/2400</a>)</li> <li>Additional commits viewable in <a href="https://github.com/Kotlin/dokka/compare/v1.6.10...v1.6.20">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `dependabot rebase` will rebase this PR - `dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `dependabot merge` will merge this PR after your CI passes on it - `dependabot squash and merge` will squash and merge this PR after your CI passes on it - `dependabot cancel merge` will cancel a previously requested merge and block automerging - `dependabot reopen` will reopen this PR if it is closed - `dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Pull Request resolved: https://github.com/facebook/flipper/pull/3639 Reviewed By: mweststrate Differential Revision: D35893243 Pulled By: lblasa fbshipit-source-id: 50344925929617dba5fa2db4b14234f11cd5616f
Flipper
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and, recently, even JS apps in your browser or in Node.js. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
Table of Contents
Mobile development
Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools, including a log viewer, interactive layout inspector, and network inspector.
Extending Flipper
Flipper is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
Contributing to Flipper
Both Flipper's desktop app, native mobile SDKs, JS SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course, join the community and help to improve Flipper. We are excited to see what you will build on this platform.
In this repo
This repository includes all parts of Flipper. This includes:
- Flipper's desktop app built using Electron
(
/desktop) - native Flipper SDKs for iOS (
/iOS) - native Flipper SDKs for Android (
/android) - React Native Flipper SDK (
/react-native) - JS Flipper SDK (
/js) - Plugins:
- Logs (
/desktop/plugins/public/logs) - Layout inspector (
/desktop/plugins/public/layout) - Network inspector (
/desktop/plugins/public/network) - Shared Preferences/NSUserDefaults inspector
(
/desktop/plugins/public/shared_preferences)
- Logs (
- website and documentation (
/website//docs)
Getting started
Please refer to our
Getting Started guide to set
up Flipper.
Or, (still experimental) run npx flipper-server for a browser based version of Flipper.
Requirements
- node >= 8
- yarn >= 1.5
- iOS developer tools (for developing iOS plugins)
- Android SDK and adb
Building from Source
Desktop
Running from source
git clone https://github.com/facebook/flipper.git
cd flipper/desktop
yarn
yarn start
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until this issue is resolved.
Building standalone application
Provide either --mac, --win, --linux or any combination of them to
yarn build to build a release zip file for the given platform(s). E.g.
yarn build --mac --version $buildNumber
You can find the resulting artifact in the dist/ folder.
iOS SDK + Sample App
cd iOS/Sample
rm -f Podfile.lock
pod install --repo-update
open Sample.xcworkspace
<Run app from xcode>
You can omit --repo-update to speed up the installation, but watch out as you
may be building against outdated dependencies.
Android SDK + Sample app
Start up an android emulator and run the following in the project root:
./gradlew :sample:installDebug
React Native SDK + Sample app
cd react-native/ReactNativeFlipperExample
yarn
yarn android
Note that the first 2 steps need to be done only once.
Alternatively, the app can be started on iOS by running yarn ios.
If this is the first time running, you will also need to run
pod install --repo-update from the
react-native/ReactNativeFlipperExample/ios folder.
JS SDK + Sample React app
cd js/react-flipper-example
yarn
yarn start
Troubleshooting
Older yarn versions might show an error / hang with the message 'Waiting for the
other yarn instance to finish'. If that happens, run the command yarn first
separately in the directory react-native/react-native-flipper.
Documentation
Find the full documentation for this project at fbflipper.com.
Our documentation is built with Docusaurus. You can build it locally by running this:
cd website
yarn
yarn start
Contributing
See the CONTRIBUTING file for how to help out.
License
Flipper is MIT licensed, as found in the LICENSE file.