[packages] Add @deprecated annotations to deprecated APIs #9959
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🛠 Suggested fixes:📋 Missing changelogApply suggested changes:diff --git a/packages/expo-ads-admob/CHANGELOG.md b/packages/expo-ads-admob/CHANGELOG.md
index aeb3bfb1..19fe54fb 100644
--- a/packages/expo-ads-admob/CHANGELOG.md
+++ b/packages/expo-ads-admob/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.3.0 — 2020-08-18
### 🎉 New features
diff --git a/packages/expo-auth-session/CHANGELOG.md b/packages/expo-auth-session/CHANGELOG.md
index caac40c9..fa5c534f 100644
--- a/packages/expo-auth-session/CHANGELOG.md
+++ b/packages/expo-auth-session/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 1.5.0 — 2020-08-26
### 🎉 New features
diff --git a/packages/expo-av/CHANGELOG.md b/packages/expo-av/CHANGELOG.md
index 3e06efcd..adfe387b 100644
--- a/packages/expo-av/CHANGELOG.md
+++ b/packages/expo-av/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.6.0 — 2020-08-18
_This version does not introduce any user-facing changes._
diff --git a/packages/expo-calendar/CHANGELOG.md b/packages/expo-calendar/CHANGELOG.md
index 98781d50..41e71ca8 100644
--- a/packages/expo-calendar/CHANGELOG.md
+++ b/packages/expo-calendar/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.5.0 — 2020-08-18
### 🎉 New features
diff --git a/packages/expo-file-system/CHANGELOG.md b/packages/expo-file-system/CHANGELOG.md
index 48fff07a..ec4b5b68 100644
--- a/packages/expo-file-system/CHANGELOG.md
+++ b/packages/expo-file-system/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 9.2.0 — 2020-08-18
### 🐛 Bug fixes
diff --git a/packages/expo-google-app-auth/CHANGELOG.md b/packages/expo-google-app-auth/CHANGELOG.md
index a951bf97..fb0debd1 100644
--- a/packages/expo-google-app-auth/CHANGELOG.md
+++ b/packages/expo-google-app-auth/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.1.3 — 2020-08-18
### 🐛 Bug fixes
diff --git a/packages/expo-haptics/CHANGELOG.md b/packages/expo-haptics/CHANGELOG.md
index 8a8258dc..0fd12e6c 100644
--- a/packages/expo-haptics/CHANGELOG.md
+++ b/packages/expo-haptics/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.3.0 — 2020-08-18
_This version does not introduce any user-facing changes._
diff --git a/packages/expo-location/CHANGELOG.md b/packages/expo-location/CHANGELOG.md
index 99edc4ad..e859d0c1 100644
--- a/packages/expo-location/CHANGELOG.md
+++ b/packages/expo-location/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 9.0.0 — 2020-08-18
### 🛠 Breaking changes
diff --git a/packages/expo-notifications/CHANGELOG.md b/packages/expo-notifications/CHANGELOG.md
index 0c143136..0a642627 100644
--- a/packages/expo-notifications/CHANGELOG.md
+++ b/packages/expo-notifications/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 0.7.1 — 2020-08-26
_This version does not introduce any user-facing changes._
@@ -80,11 +82,7 @@ _This version does not introduce any user-facing changes._
- Added native permission requester that will let developers call `Permissions.getAsync(Permissions.NOTIFICATIONS)` (or `askAsync`) when this module is installed. ([#8486](https://github.com/expo/expo/pull/8486) by [@sjchmiela](https://github.com/sjchmiela))
-> Note that the effect of this method is the same as if you called `Notifications.getPermissionsAsync()` (or `requestPermissionsAsync`) and then `Notifications.getDevicePushTokenAsync()`—it tries to both ask the user for user-facing notifications permissions and then tries to register the device for remote notifications. We are planning to deprecate the `.NOTIFICATIONS` permission soon.## 0.2.0 — 2020-05-27### 🛠 Breaking changes
-
-> Note that this may or may not be a breaking change for you — if you'd expect the notification to be automatically dismissed when tapped on this is a bug fix and a new feature (fixes inconsistency between platforms as on iOS this is the only supported behavior; adds the ability to customize the behavior on Android). If you'd expect the notification to only be dismissed at your will this is a breaking change and you'll need to add `autoDismiss: false` to your notification content inputs.- Changed the default notification behavior on Android to be automatically dismissed when clicked. This is customizable with the `autoDismiss` parameter of `NotificationContentInput`. ([#8241](https://github.com/expo/expo/pull/8241) by [@thorbenprimke](https://github.com/thorbenprimke))### 🎉 New features
-
-- Added the ability to configure whether the notification should be automatically dismissed when tapped on or not (on Android) with the `autoDismiss` parameter of `NotificationContentInput`. ([#8241](https://github.com/expo/expo/pull/8241) by [@thorbenprimke](https://github.com/thorbenprimke))
+> Note that the effect of this method is the same as if you called `Notifications.getPermissionsAsync()` (or `requestPermissionsAsync`) and then `Notifications.getDevicePushTokenAsync()`—it tries to both ask the user for user-facing notifications permissions and then tries to register the device for remote notifications. We are planning to deprecate the `.NOTIFICATIONS` permission soon.## 0.2.0 — 2020-05-27### 🛠 Breaking changes> Note that this may or may not be a breaking change for you — if you'd expect the notification to be automatically dismissed when tapped on this is a bug fix and a new feature (fixes inconsistency between platforms as on iOS this is the only supported behavior; adds the ability to customize the behavior on Android). If you'd expect the notification to only be dismissed at your will this is a breaking change and you'll need to add `autoDismiss: false` to your notification content inputs.- Changed the default notification behavior on Android to be automatically dismissed when clicked. This is customizable with the `autoDismiss` parameter of `NotificationContentInput`. ([#8241](https://github.com/expo/expo/pull/8241) by [@thorbenprimke](https://github.com/thorbenprimke))### 🎉 New features- Added the ability to configure whether the notification should be automatically dismissed when tapped on or not (on Android) with the `autoDismiss` parameter of `NotificationContentInput`. ([#8241](https://github.com/expo/expo/pull/8241) by [@thorbenprimke](https://github.com/thorbenprimke))
- Added `DailyTriggerInput` that allows scheduling a daily recurring notification for a specific hour and minute. It is supported on both iOS and Android. ([#8199](https://github.com/expo/expo/pull/8199) by [@thorbenprimke](https://github.com/thorbenprimke))
### 🐛 Bug fixes
diff --git a/packages/expo-payments-stripe/CHANGELOG.md b/packages/expo-payments-stripe/CHANGELOG.md
index b3270f1a..04ac5874 100644
--- a/packages/expo-payments-stripe/CHANGELOG.md
+++ b/packages/expo-payments-stripe/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.3.0 — 2020-08-18
_This version does not introduce any user-facing changes._
diff --git a/packages/expo-splash-screen/CHANGELOG.md b/packages/expo-splash-screen/CHANGELOG.md
index bbdcf543..14a3d84d 100644
--- a/packages/expo-splash-screen/CHANGELOG.md
+++ b/packages/expo-splash-screen/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 0.6.0 — 2020-08-18
### 🎉 New features
diff --git a/packages/expo-task-manager/CHANGELOG.md b/packages/expo-task-manager/CHANGELOG.md
index efe39b5b..9ecc3977 100644
--- a/packages/expo-task-manager/CHANGELOG.md
+++ b/packages/expo-task-manager/CHANGELOG.md
@@ -8,6 +8,8 @@
### 🐛 Bug fixes
+- Add @deprecated annotations to deprecated APIs. ([#9959](https://github.com/expo/expo/pull/9959) by [@barthap](https://github.com/barthap))
+
## 8.5.0 — 2020-08-18
_This version does not introduce any user-facing changes._ |
|
Native Component List for this branch is ready |
barthap
force-pushed
the
@barthap/deprecation-annotations
branch
from
f4f020c to
e34c012
Compare
barthap
requested review from
cruzach,
EvanBacon,
ide,
IjzerenHein,
lukmccall,
sjchmiela and
tsapeta
as code owners
ide
approved these changes
Aug 31, 2020
lukmccall
approved these changes
Sep 1, 2020
Jamedjo
pushed a commit
to Jamedjo/expo
that referenced
this pull request
Feb 4, 2021
# Why _This follows the TS 4.0 update PR: #9960_ Typescript 4.0 comes with support for `@deprecated` annotations, which gives nice VS Code (and probably other IDE) messages informing users about API deprecation. It also marks deprecated methods/properties with ~~Strikethrough~~. See [this](https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/#deprecated-support) and microsoft/TypeScript#38523 # How - Added appropriate annotations to every possible deprecated Expo API that I found. - Updated existing comments to play nice with VS Code messages Also, added note about dead code in Notifications, which is related to expo#9563 (I forgot to add it then) > Not sure what to do with changelogs ❓ # Test Plan Tested messages in VS Code with _TS 4.0.2_ enabled.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
This follows the TS 4.0 update PR: #9960
Typescript 4.0 comes with support for
@deprecatedannotations, which gives nice VS Code (and probably other IDE) messages informing users about API deprecation. It also marks deprecated methods/properties withStrikethrough.See this and microsoft/TypeScript#38523
How
Also, added note about dead code in Notifications, which is related to #9563 (I forgot to add it then)
Test Plan
Tested messages in VS Code with TS 4.0.2 enabled.