Skip to content

Commit

Permalink
Detail on deprecated packages with dependents
Browse files Browse the repository at this point in the history
  • Loading branch information
sandersn committed Mar 14, 2019
1 parent 586d1fb commit c83a11c
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,12 +171,25 @@ 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:

If a package was never on Definitely Typed, it does not need to be added to `notNeededPackages.json`.
```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

Expand Down

0 comments on commit c83a11c

Please sign in to comment.