Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Commit 1ed6a62

Browse files
committed
Document banned npm names
See also #349 and #350. As soon as an official decision for this issue exists, that should be referenced in the docs as well.
1 parent 1ccb573 commit 1ed6a62

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/index.ts

+9
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,15 @@ function assertPathIsInDefinitelyTyped(dirPath: string): void {
234234
}
235235
}
236236

237+
/**
238+
* Starting at some point in time, npm has banned all new packages whose names
239+
* contain the word `download`. However, some older packages exist that still
240+
* contain this name.
241+
* @NOTE for contributors: The list below list should ONLY be extended with
242+
* packages for which there already exists a corresponding type definition
243+
* package in the `@types` scope. More information:
244+
* https://github.com/microsoft/dtslint/pull/351.
245+
*/
237246
function assertPathIsNotBanned(dirPath: string) {
238247
const basedir = basename(dirPath);
239248
if (/(^|\W)download($|\W)/.test(basedir) &&

0 commit comments

Comments
 (0)