Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add gotcha section to readme about mixed-case packages #11

Merged
merged 1 commit into from
Jan 12, 2018
Merged

add gotcha section to readme about mixed-case packages #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions readme.md
View file
Open in desktop
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