From c83a11c439b5607ad2a5d6f73bc691fbc4400494 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Thu, 14 Mar 2019 14:47:02 -0700 Subject: [PATCH] Detail on deprecated packages with dependents --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cb4fd7510b..b50272dbf4 100644 --- a/README.md +++ b/README.md @@ -171,13 +171,26 @@ You can remove it by running `npm run not-needed -- typingsPackageName asOfVersi - `typingsPackageName`: This is the name of the directory to delete. - `asOfVersion`: A stub will be published to `@types/foo` with this version. Should be higher than any currently published version. - `sourceRepoURL`: This should point to the repository that contains the typings. -- `libraryName`: Name of npm package that replaces the Definitely Typed types. Usually this is identical to "typingsPackageName" so you can omit it. +- `libraryName`: Name of npm package that replaces the Definitely Typed types. Usually this is identical to "typingsPackageName", in which case you can omit it. -Any other packages in Definitely Typed that referenced the deleted package should be updated to reference the bundled types. To do this, add a `package.json` with `"dependencies": { "foo": "x.y.z" }`. +Any other packages in Definitely Typed that referenced the deleted package should be updated to reference the bundled types. +You can get this list by looking at the errors from `npm run test`. +To fix the errors, add a `package.json` with `"dependencies": { "foo": "x.y.z" }`. +For example: + +```json +{ + "private": true, + "dependencies": { + "foo": "^2.6.0" + } +} +``` + +When you add a `package.json` to dependents of `foo`, you will also need to open a PR to add `foo` [to dependenciesWhitelist.txt in types-publisher](https://github.com/Microsoft/types-publisher/blob/master/dependenciesWhitelist.txt). If a package was never on Definitely Typed, it does not need to be added to `notNeededPackages.json`. - #### Lint All new packages must be linted. To lint a package, add a `tslint.json` to that package containing