NPM - Cách khắc phục dữ liệu không có dữ liệu readme


190

Tôi có một gói.json đơn giản:

{
  "name": "camapaign",
  "version": "0.0.1",
  "scripts": {
    "start": "node app.js"
  },
  "engines": {
    "node": "0.10.15",
    "npm": "1.3.5"
  },
  "repository": { 
    "type": "svn",
    "url": ""
  }
}

Khi tôi thực hiện "npm install", tôi nhận được cảnh báo sau đây muốn sửa:

"npm WARN package.json camapaign@0.0.1 No readme data."

Tôi đã thử thêm "README.md" & "readme.txt" vào cùng một thư mục với gói nhưng không có niềm vui. Tôi đang thiếu gì?


Một câu trả lời từ bộ phận hỗ trợ NPM có thể phù hợp với một số người: "Đó chỉ là một sự chậm trễ trong bộ nhớ cache của trang web cần theo kịp việc xuất bản."
Joshua Pinter

Câu trả lời:


225

Đơn giản chỉ cần thêm một README.mdtập tin sẽ không sửa nó, bạn nên viết một cái gì đó bên trong nó; ít nhất là tiêu đề dự án và một mô tả ngắn gọn là tốt cho mọi người! Nhưng đối với NPM, một byte có thể là đủ ...
Làm như vậy sẽ ngừng hiển thị các cảnh báo.

Ngoài ra, khi bạn đọc cảnh báo đó, hãy đảm bảo rằng sự cố không liên quan đến gói bên thứ 3.


19
Tôi có vấn đề này và tôi có một tệp README không trống ...: /
mgol

3
Tôi cũng có một README.mdtập tin với toàn bộ nội dung trong cùng thư mục với tôi package.jsonvà vẫn nhận được tệp này (liên quan đến bộ xử lý karma-coffee-cà phê)
Conan

2
Yup, giống như @Conan. README.mdtập tin, dân cư, vẫn nhận được lỗi.
Nathan Hornby

4
@gustavohenke Thật ngớ ngẩn với tôi, bạn nói đúng - lời cảnh báo dành cho một gói, không phải ứng dụng của tôi
Nathan Hornby

2
@NathanHornby vì nó hữu ích cho bạn, tôi đã thêm nó vào câu trả lời :)
gustavohenke

178

Chỉ cần đặt là riêng tư;)

{
  "name": "camapaign",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "start": "node app.js"
  },
  "engines": {
    "node": "0.10.15",
    "npm": "1.3.5"
  },
  "repository": { 
    "type": "svn",
    "url": ""
  }
}

6
Cần lưu ý rằng tài sản privatenói với npm rằng đây không phải là một dự án dự định có sẵn trên kho npm. Bạn có thể thấy ai đó đã hỏi tài sản đó được sử dụng cho stackoverflow.com/a/7314961/1128216
Jonathan Morales Vélez

2
Nếu bạn đặt "riêng tư": true trong gói.json, thì npm sẽ từ chối xuất bản nó. tham chiếu:https://www.npmjs.org/doc/files/package.json.html
AlexStack

3
Trên thực tế, trong các phiên bản NPM mới hơn, không có vấn đề gì nếu gói đó là riêng tư hay không. Bạn phải có một README.mdtập tin. @gustavohenke trả lời phù hợp hơn với mọi phiên bản.
ViniciusPires

Điều này hoạt động tốt nếu bạn chỉ sử dụng nó để tạo một số mã đầu ra và không thực sự cần một gói nguồn đầy đủ.
Neil Monroe

Tôi sẽ từ câu trả lời này giống như - Tất nhiên, lý do duy nhất để không có một README.mdtập tin là dự án của bạn là riêng tư. Vì vậy, hoặc viết một phù hợp README.md hoặc đặt cờ riêng.
rustyx

9

Thêm README.md vào gốc dự án của bạn là câu trả lời, nhưng tôi nhận thấy rằng phải mất một thời gian ngắn để NPM nhận ra điều này. Có lẽ vài phút?


2
Đúng là sau khi bạn xuất bản, phải mất một chút thời gian để cập nhật danh sách của NPM. Đây là phản hồi từ bộ phận hỗ trợ của NPM: "Đó chỉ là sự chậm trễ trong bộ nhớ cache của trang web cần theo kịp xuất bản."
Joshua Pinter

1

Thêm vào gói.json "readme": "README.md"


6
thêm kết quả thuộc tính này vào văn bản "README.md" hiển thị trên trang chi tiết trên npmjs.com. Rõ ràng, nó là cho markdown thô và không phải là một tên tệp.
code_monk

Tuy nhiên, nó loại bỏ cảnh báo npm - không phải theo cách mà câu trả lời này ngụ ý.
rogersillito

@code_monk vì vậy chúng tôi có thể viết một cái gì đó giống như "nhìn thấy README.md "
aloisdg chuyển sang codidact.com

1
bạn có thể, nhưng AFAIK chỉ cần thêm README.md vào thư mục gốc của repo sẽ khắc phục cảnh báo này; đó là một ý tưởng tốt và sẽ giúp người dùng của bạn hiểu cách phần mềm của bạn hoạt động
code_monk 7/2/2016

0

Kể từ hôm nay, tháng 4 năm 2017, chỉ cần thiết lập bên dưới trong pack.json, vẫn hoạt động tốt:

"private": true

điều này có nghĩa là kho lưu trữ riêng của bạn

thậm chí, với npm mới nhất, nó hoạt động tốt:

npm update -g npm
> 3.10.8

0

giải pháp của tôi

  • npm show
  • npm dist-tag add

1. sử dụng npm showkiểm tra thông tin triển khai trang web từ xa.

vd. như thế này:

SOME_PACKAGEs@0.3.60-beta | Proprietary | deps: 14 | versions: 289
<span style="color:red;">最新日志倒序在这里增加,注明作者+日期+功能</span>

dist
.tarball: https://registry.npmjs.org/xxx/-/xxx-0.3.60-beta.tgz
.shasum: 021e30640a62f13905b1e2b7a4facd169df46a1d
.integrity: sha512-9N4pUwwoYGNek34fCCCjURuQdx1K5VBlCWl4t1sy8wi3xul/N/TiDvjmUBF24t2Dg2fX6cFM9on+tftnVaEr7A==
.unpackedSize: 114.5 kB

dependencies:
@hanyk/rc-viewer: ^0.0.3        crypto-js: ^3.1.9-1             moment: ^2.25.3                 react-dom: ^16.12.0             uuid: ^3.3.3                    
axios: ^0.19.0                  dirty-json-ie11: ^0.0.2         query-string: ^6.9.0            react-quill: ^1.3.3             yqquill-image-drop-module: ^0.0 
cookie-universal: ^2.0.16       md5: ^2.2.1                     quill-delta-to-html: ^0.11.0    react-resizable: ^1.10.1        

maintainers:
- jyjin <jyjin@qq.com>
- jyjin1 <jyjin1@163.com>
- jyjin2 <jyjin2@163.com>

dist-tags:
beta: 0.3.61-beta    latest: 0.3.53-beta  

published 26 minutes ago by jyjin1 <jyjin1@163.com>

2.npm dist-tag add [PACKAGE_NAME]@[VERSION]

và sau đó cập nhật lasest 0.3.53-betađể0.3.61-beta

npm dist-tag add SOME_PACKAGE@0.3.61-beta

3. npm showkiểm tra agin

tương tự bước 1

Quay trở lại trang web gói npm của bạn, tất cả đã được làm mới!


Mong được giúp đỡ, cảm ơn ~

[Một người Trung Quốc dạy] 希望 对 您 有 帮助 谢谢 ~

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.