da21b6add2
Summary: ## The dependency [string-natural-compare](https://github.com/nwoltman/string-natural-compare) was updated from `2.0.3` to `3.0.0`. This version is **not covered** by your **current version range**. If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update. --- **Publisher:** [nwoltman](https://www.npmjs.com/~nwoltman) **License:** MIT <details> <summary>Release Notes for 3.0.0</summary> <h3>BREAKING CHANGES</h3> <ul> <li>Update code to use ES2015 syntax (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="6d9d8c036b/hovercard" href="6d9d8c036b"><tt>6d9d8c0</tt></a>)</li> <li>Throw on non-string arguments and replace the caseInsensitive function with an option (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="65d397ba75/hovercard" href="65d397ba75"><tt>65d397b</tt></a>) <ul> <li><code>naturalCompare()</code> now throws if either of the first two arguments are not a string.</li> <li>Also, the <code>naturalCompare.caseInsensitive()</code> function has been removed. Pass <code>{caseInsensitive: true}</code> as the third parameter to <code>naturalCompare()</code> instead.</li> </ul> </li> <li>Replace <code>naturalCompare.alphabet</code> with an <code>alphabet</code> option (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="6048bab315/hovercard" href="6048bab315"><tt>6048bab</tt></a>) <ul> <li><code>naturalCompare.alphabet</code> no longer exists for setting a custom alphabet. Use the new <code>alphabet</code> option instead.</li> </ul> </li> </ul> <h3>Improvements</h3> <ul> <li>Perf boost with custom alphabet (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="21e061a6c8/hovercard" href="21e061a6c8"><tt>21e061a</tt></a>)</li> </ul> <h3>Polish</h3> <ul> <li>Simplify if statements that handle leading zeros (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="fcaae03b2b/hovercard" href="fcaae03b2b"><tt>fcaae03</tt></a>)</li> <li>Replace <code>var</code> with <code>let</code> and <code>const</code> (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="e4de3f28b6/hovercard" href="e4de3f28b6"><tt>e4de3f2</tt></a>)</li> </ul> <h3>Documentation</h3> <ul> <li>Make explanation a little clearer (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="464e890e92/hovercard" href="464e890e92"><tt>464e890</tt></a>)</li> <li>Simplify a section of the readme (<a class="commit-link" data-hovercard-type="commit" data-hovercard-url="4a4ca90b75/hovercard" href="4a4ca90b75"><tt>4a4ca90</tt></a>)</li> </ul> </details> <details> <summary>Commits</summary> <p>The new version differs by 15 commits.</p> <ul> <li><a href="3e0a51624e"><code>3e0a516</code></a> <code>v3.0.0</code></li> <li><a href="e7035cdf6b"><code>e7035cd</code></a> <code>refactor: Add comments to indicate the actual character for character code numbers</code></li> <li><a href="e4de3f28b6"><code>e4de3f2</code></a> <code>refactor: Replace <code>var</code> with <code>let</code> and <code>const</code></code></li> <li><a href="fcaae03b2b"><code>fcaae03</code></a> <code>refactor: Simplify if statements that handle leading zeros</code></li> <li><a href="e9e9b99896"><code>e9e9b99</code></a> <code>chore(ci): Fix coverage reporting</code></li> <li><a href="d9c9de755a"><code>d9c9de7</code></a> <code>deps: Update devDependencies and benchmark dependencies</code></li> <li><a href="6048bab315"><code>6048bab</code></a> <code>refactor!: Replace <code>naturalCompare.alphabet</code> with an <code>alphabet</code> option</code></li> <li><a href="21e061a6c8"><code>21e061a</code></a> <code>improvement: Perf boost with custom alphabet</code></li> <li><a href="65d397ba75"><code>65d397b</code></a> <code>refactor!: Throw on non-string arguments and replace the caseInsensitive function with an option</code></li> <li><a href="6d9d8c036b"><code>6d9d8c0</code></a> <code>refactor!: Update code to use ES2015 syntax</code></li> <li><a href="8fa47814db"><code>8fa4781</code></a> <code>test: Add tests to get back to 100% coverage</code></li> <li><a href="bba68db636"><code>bba68db</code></a> <code>internal: Remove grunt and update dependencies</code></li> <li><a href="c0f5ca613d"><code>c0f5ca6</code></a> <code>ci: Test on latest Node.js versions and only run releases once</code></li> <li><a href="4a4ca90b75"><code>4a4ca90</code></a> <code>docs: Simplify a section of the readme</code></li> <li><a href="464e890e92"><code>464e890</code></a> <code>readme: Make explanation a little clearer</code></li> </ul> <p>See the <a href="2f70d49a9f...3e0a51624e">full diff</a></p> </details> --- <details> <summary>FAQ and help</summary> There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new). </details> --- Your [Greenkeeper](https://greenkeeper.io) bot 🌴 Pull Request resolved: https://github.com/facebook/flipper/pull/619 Reviewed By: jknoxville Differential Revision: D18269202 Pulled By: passy fbshipit-source-id: 88421f02a213fe6f813512d37d39f9b5ab2460a4
Flipper 
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android. 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
- Extending Flipper
- Contributing to Flipper
- In this repo
- Getting started
- Building from Source
- iOS SDK + Sample App
- Android SDK + Sample app
- Documentation
- Contributing
- License
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 and native mobile 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 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 (
/src) - native Flipper SDKs for iOS (
/iOS) - native Flipper SDKs for Android (
/android) - Plugins:
- Logs (
/src/device-plugins/logs) - Layout inspector (
/src/plugins/layout) - Network inspector (
/src/plugins/network) - Shared Preferences/NSUserDefaults inspector (
/src/plugins/shared_preferences)
- Logs (
- website and documentation (
/website//docs)
Getting started
Please refer to our Getting Started guide to set up 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
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
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.