Skip to content

Commit 4d87da0

Browse files
authored
Document banned npm names (#381)
* Document banned npm names Cherry-picked from microsoft/dtslint@1ed6a62 Resolves microsoft/dtslint#351 (comment) by @sandersn * Update link to PR
1 parent cd3e093 commit 4d87da0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

packages/dtslint/src/index.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,15 @@ function assertPathIsInDefinitelyTyped(dirPath: string): void {
249249
}
250250
}
251251

252+
/**
253+
* Starting at some point in time, npm has banned all new packages whose names
254+
* contain the word `download`. However, some older packages exist that still
255+
* contain this name.
256+
* @NOTE for contributors: The list of literal exceptions below should ONLY be
257+
* extended with packages for which there already exists a corresponding type
258+
* definition package in the `@types` scope. More information:
259+
* https://github.com/microsoft/DefinitelyTyped-tools/pull/381.
260+
*/
252261
function assertPathIsNotBanned(dirPath: string) {
253262
const basedir = basename(dirPath);
254263
if (

0 commit comments

Comments
 (0)