question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

npm README field is blank

See original GitHub issue

To reproduce:

  1. curl https://registry.npmjs.org/preact | pbcopy (link)
  2. Open you favorite JSON formatter (ex: https://codebeautify.org/jsonviewer)
  3. See that the top-level “readme” property is empty string
  4. See that there is no “readme” property on the latest version (or any versions <10)
  5. See that a “readme” property does exist on the “next” version (and all versions 10+)

This is the only package I’ve seen this for in all of my npm traveling. I can’t tell why this is (README does exist in the installed package) but just wanted to bring it to your attention since package README-viewers may be failing for your package.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:8 (4 by maintainers)

github_iconTop GitHub Comments

3reactions
Haroenvcommented, Aug 12, 2019

I contacted npm support with that insight, hopefully I can find the root cause now!

2reactions
marvinhagemeistercommented, Aug 12, 2019

Oh ok, just checked and our package contains the right version of the readme. Not sure why the registry points to something else. Like Jason said, it seems to be an issue with the registry when multiple tags are used. I don’t think there is anything we can do to resolve that in Preact.

Read more comments on GitHub >

github_iconTop Results From Across the Web

NPM - How to fix "No readme data"
When I execute "npm install" i get the following warning which I would like to fix: "npm WARN package.json camapaign@0.0.1 No readme data."...
Read more >
package.json
The file in the "main" field. README & LICENSE can have any case and extension. Conversely, some files are always ignored: .git ...
Read more >
internetarchive/icon-calendar-blank - NPM Package Overview
Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the...
Read more >
Create a package.json File
json. Re-running npm init is additive. It won't overwrite values you have already entered, but will update any previously blank fields it can ......
Read more >
How to publish a npm package in four steps
Run npm init inside your git directory and follow the prompts. If you don't know what to put in a field, just leave...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found