我对package.json中的脚本使用什么命名约定?

时间:2017-07-11 12:05:09

标签: node.js npm naming-conventions package.json

package.json我的脚本名称中包含两个单词lintfix。我该怎么做一个正确的名字?

有选项:

  1. lowerCamelCase - lintFix
  2. UpperCamelCase - LintFix
  3. snake_case - lint_fix
  4. kebab-case - lint-fix
  5. 带有冒号分隔符的gulp-style - lint:fix
  6. 任何其他分隔符。
  7. 什么选择是对的?为什么?

3 个答案:

答案 0 :(得分:7)

没有正式的命名约定,但是从npm @ v5开始,事实上使用了lowerCamelCase。 npm @ v5引用了新的标准脚本名prepublishOnly。 在npm @ v5之前,任何标准脚本只有一个单词。例如teststartprestart

现在,最佳做法是使用 lowerCamelCase

答案 1 :(得分:5)

galkin's answer中查看npm本身似乎是一个好主意。但具有讽刺意味的是,虽然npm脚本prepublishOnly是lowerCamelCase,但npm GitHub项目中的大多数脚本都是kebab-case: https://github.com/npm/cli/blob/latest/package.json

有人可能还想查看最依赖的npm包:https://www.npmjs.com/browse/depended。许多顶级包装都使用烤肉串,除了使用冒号的lodash之外。

答案 2 :(得分:5)

始终使用烤肉串包 。冒号使人大吃一惊,看起来很糟糕。我讨厌。

免责声明:我的观点经常是错误的,并且我的家庭功能失调。