Skip to content

Commit

Permalink
add gotcha section to readme about mixed-case packages
Browse files Browse the repository at this point in the history
  • Loading branch information
zeke committed Jan 12, 2018
1 parent 0f0447b commit b42b809
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,21 @@ npm i -g all-the-package-names
all-the-package-names | grep spell
```

## ⚠️ Gotchas

Note that while mixed-case package names are no longer allowed to be published
to the npm registry, there are over 2800 legacy mixed-case packages, many of
which have the same spelling as other existing lowercase packages. See [nice-registry/mixed-case-package-names](https://github.com/nice-registry/mixed-case-package-names)
for the the full list.

To avoid the mixed-case names when working with this data,
just filter them out:

```js
const names = require('all-the-package-names')
.filter(name => name === name.toLowerCase())
```

## Tests

```sh
Expand Down

0 comments on commit b42b809

Please sign in to comment.