如何正确使用package.json中的“keywords”属性?

时间:2017-03-21 16:42:35

标签: node.js npm

为包列出尽可能多的关键字(百?)是不是很好?或者这是一种不好的方法?

如何正确列出关键字?

1 个答案:

答案 0 :(得分:21)

  

为包列出尽可能多的关键字(百?)是不是很好?或者这是一种不好的方法?

您应该只使用与您的模块相关的关键字,并且您希望人们在搜索与您类似的模块时使用这些关键字。

因此,如果您有一个使用Twitter并具有基于承诺的api的模块,那么您可以使用" twitter"等关键字。和#34;承诺"但是你不应该使用不相关的关键词来垃圾搜索结果。

我无法想到需要这么多关键字的任何正当理由。

  

如何正确列出关键字?

这是我自己的模块caught的示例 - 如您所见,它使用了4个关键字:

{
  "name": "caught",
  "version": "0.1.1",
  "description": "Avoids UnhandledPromiseRejectionWarning and PromiseRejectionHandledWarning",
  "main": "index.js",
  "types": "index.d.ts",
  "scripts": {
    "test": "bash test.sh"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/rsp/node-caught.git"
  },
  "keywords": [
    "promise",
    "async",
    "UnhandledPromiseRejectionWarning",
    "PromiseRejectionHandledWarning"
  ],
  "author": "Rafał Pocztarski <r.pocztarski@gmail.com> (https://pocztarski.com/)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/rsp/node-caught/issues"
  },
  "homepage": "https://github.com/rsp/node-caught#readme"
}

请参阅: