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.

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

Packages without README aren't identified correctly #12

Closed
Freakspot opened this issue Jul 29, 2018 · 6 comments
Closed

Packages without README aren't identified correctly #12

Freakspot opened this issue Jul 29, 2018 · 6 comments

Comments

@Freakspot
Copy link

It seems that packages without READMEs get detected as being "not present" despite obviously it just being the readme missing, not the package itself.

Is that something you could fix? :D

@zeke
Copy link
Member

zeke commented Aug 5, 2018

Hi sorry for the delay getting back to you. Can you cite any specific example packages that are getting left out?

@zeke zeke reopened this Aug 5, 2018
@Freakspot
Copy link
Author

Freakspot commented Aug 6, 2018

Hey, try doing console.log(names.includes('dso'));. It'll return false despite dso being a package name (https://www.npmjs.com/package/dso).

Same thing happens with a package called "khi" which I just created some days ago (I have updated all-the-package-names since then!). Khi actually has a readme, but includes still returns false? Seems that my initial assumption of it being only packages that lack a readme was incorrect.

Both packages are not part of names.json; I even checked manually.

@zeke
Copy link
Member

zeke commented Aug 6, 2018

Investigating...

@easingthemes
Copy link

also few more:
[ 'cy', 'hx', 'lh', 'lj', 'mp', 'su', 'vg', 'wv' ]

https://www.npmjs.com/package/hx has a readme file, but lowercase, if that matters readme.md

@easingthemes
Copy link

easingthemes commented Dec 23, 2018

package-stream is using nice-package which has validation for name and description as required.

https://github.com/nice-registry/package-stream/blob/master/index.js#L26
https://github.com/nice-registry/nice-package/blob/master/index.js#L55
https://github.com/nice-registry/nice-package/blob/master/lib/schema.js

Only name and version are required fields. description is not mandatory.
https://docs.npmjs.com/files/package.json#version

So invalid packages (missing description) as per nice-package validation are not included.

@zeke
Copy link
Member

zeke commented Aug 26, 2021

Hey party people. Long time no see.

nice-package was updated a while back to no longer require description.

@jimaek has graciously offered to revive this package, so all the description-less packages should be in the mix soon.

@zeke zeke closed this as completed Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants