Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

Commit

Permalink
refactor(uri-scheme): move to expo/expo
Browse files Browse the repository at this point in the history
  • Loading branch information
byCedric committed Dec 4, 2023
1 parent 1a00098 commit f15317f
Show file tree
Hide file tree
Showing 19 changed files with 2 additions and 1,120 deletions.
1 change: 0 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ jobs:
plist,
pwa,
schemer,
uri-scheme,
# webpack-config,
xdl,
]
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/test_windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ jobs:
plist,
pwa,
schemer,
uri-scheme,
webpack-config,
xdl,
]
Expand Down
22 changes: 0 additions & 22 deletions packages/uri-scheme/LICENSE

This file was deleted.

156 changes: 2 additions & 154 deletions packages/uri-scheme/README.md
Original file line number Diff line number Diff line change
@@ -1,155 +1,3 @@
<!-- Title -->
<h1 align="center">
👋 Welcome to <br><code>uri-scheme</code>
</h1>
# `uri-scheme`

<!-- Header -->

<p align="center">
<b>Interact with native URI schemes</b>
<br/>
<br/>
<a aria-label="Circle CI" href="https://circleci.com/gh/expo/expo-cli/tree/main">
<img alt="Circle CI" src="https://flat.badgen.net/circleci/github/expo/expo-cli?label=Circle%20CI&labelColor=555555&icon=circleci">
</a>
</p>

---

<!-- Body -->

This package provides a simple interface for modifying, viewing, and testing a project's native URI schemes.

👋 **Notice:** This package is not limited to Expo projects! You can use it with any iOS, or Android project.

## 🤔 Why?

We created `uri-scheme` to make it easier to setup, test, and modify deep links, and authentication in native apps.

## 🚀 Usage

### CLI

```sh
# Usage
npx uri-scheme [options] [command]

# View all URIs for a project
npx uri-scheme list

# Open a URI in a simulator
npx uri-scheme open <uri> --ios

# Add a URI to your project
npx uri-scheme add <uri>
```

### Node

In order to make this package fast with npx we don't ship types or doc-blocks.

```js
import { Android, Ios } from 'uri-scheme';

Ios.openAsync({ uri: 'http://expo.dev/' });
```

## ⚙️ Options

For more information run `npx uri-scheme --help` (or `-h`)

| Options | Description |
| ------------- | ------------------------- |
| -V, --version | output the version number |
| -h, --help | output usage information |

### add

Add URI schemes to a native app.

**Options**

| Options | Description |
| -------------------------- | --------------------------------------------------------------- |
| `-a, --android` | Apply action to Android |
| `-i, --ios` | Apply action to iOS |
| `-n, --name <string>` | Name to use on iOS. |
| `-r, --role <string>` | Role to use on iOS: Editor, Viewer |
| `--manifest-path <string>` | Custom path to use for an Android project's AndroidManifest.xml |
| `--info-path <string>` | Custom path to use for an iOS project's Info.plist |
| `--dry-run` | View the proposed change |
| `-h, --help` | output usage information |

**Examples**

- `uri-scheme add com.app`
- `uri-scheme add myapp`

### remove

Remove URI schemes from a native app

**Options**

| Options | Description |
| -------------------------- | --------------------------------------------------------------- |
| `-a, --android` | Apply action to Android |
| `-i, --ios` | Apply action to iOS |
| `--manifest-path <string>` | Custom path to use for an Android project's AndroidManifest.xml |
| `--info-path <string>` | Custom path to use for an iOS project's Info.plist |
| `--dry-run` | View the proposed change |
| `-h, --help` | output usage information |

**Examples**

- `uri-scheme remove com.app`
- `uri-scheme remove myapp`

### open

Open a URI scheme in a running simulator or emulator

**Options**

| Options | Description |
| -------------------- | ----------------------------------------------------------- |
| `-a, --android` | Apply action to Android |
| `-i, --ios` | Apply action to iOS |
| `--package <string>` | The Android package name to use when opening in an emulator |
| `-h, --help` | output usage information |

**Examples**

- `uri-scheme open com.app://oauth --ios`
- `uri-scheme open http://expo.dev --android`

### list

List the existing URI scheme prefixes for a native app

**Options:**

| Options | Description |
| -------------------------- | --------------------------------------------------------------- |
| `-a, --android` | Apply action to Android |
| `-i, --ios` | Apply action to iOS |
| `--manifest-path <string>` | Custom path to use for an Android project's AndroidManifest.xml |
| `--info-path <string>` | Custom path to use for an iOS project's Info.plist |
| `-h, --help` | output usage information |

## License

The Expo source code is made available under the [MIT license](LICENSE). Some of the dependencies are licensed differently, with the BSD license, for example.

<!-- Footer -->

---

<p>
<a aria-label="sponsored by expo" href="http://expo.dev">
<img src="https://img.shields.io/badge/Sponsored_by-Expo-4630EB.svg?style=for-the-badge&logo=EXPO&labelColor=000&logoColor=fff" target="_blank" />
</a>
<a aria-label="uri-scheme is free to use" href="/LICENSE" target="_blank">
<img align="right" alt="License: MIT" src="https://img.shields.io/badge/License-MIT-success.svg?style=for-the-badge&color=33CC12" target="_blank" />
</a>
</p>
This package has [moved to the `expo/expo` repo](https://github.com/expo/expo/tree/main/packages/uri-scheme).
5 changes: 0 additions & 5 deletions packages/uri-scheme/cli.js

This file was deleted.

7 changes: 0 additions & 7 deletions packages/uri-scheme/jest.config.js

This file was deleted.

47 changes: 0 additions & 47 deletions packages/uri-scheme/package.json

This file was deleted.

Loading

0 comments on commit f15317f

Please sign in to comment.