【问题标题】:What naming convention do I use for scripts in package.json?我对 package.json 中的脚本使用什么命名约定?
【发布时间】:2017-12-15 11:47:20
【问题描述】:

在package.json 我有这个脚本名称,其中包含两个单词lint 和fix。我应该如何取一个合适的名字?

有多种选择:

  1. 小驼峰式 - lintFix
  2. UpperCamelCase - LintFix
  3. snake_case - lint_fix
  4. 烤肉串 - lint-fix
  5. 带有冒号分隔符的 gulp 样式 - lint:fix
  6. 任何其他分隔符。

什么选项是正确的?为什么?

【问题讨论】:

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


【解决方案1】:

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

您可能还想查看最依赖的 npm 包:https://www.npmjs.com/browse/depended。那里的许多顶级软件包都使用 kebab 大小写,除了 lodash,它使用冒号。

更新:还有一个比人们想象的更重要的便利方面:键入不需要 shift 键的分隔符更令人愉快。至少在美国、英国和德国键盘上,这也适用于 kebab-case。

【讨论】:

    【解决方案2】:

    没有正式的命名约定。之前 npm@v4 标准脚本只有一个词,例如test、start、prestart。 npm@v4 引入了一个新脚本prepublishOnly*。

    所以现在,最好的做法是使用 lowerCamelCase。

    *参考:https://iamakulov.com/notes/npm-4-prepublish/

    【讨论】:

    • 对此有任何参考吗?
    • dropbox.com/s/2kd0v71xto2mbaj/… - 现在似乎是“常态”。 : 用于某些特定情况。与 JS 中的大多数东西一样,这类东西可能会有所不同,并且基于组织/个人的“风格指南”。
    【解决方案3】:

    请始终使用烤肉串盒。冒号是 gulp 的回归,它看起来很糟糕。我讨厌它。

    免责声明:我的意见经常是错误的,而且我的家庭功能失调。

    【讨论】:

      猜你喜欢
      • 2015-09-11
      • 2017-08-21
      • 2014-05-04
      • 2011-08-20
      • 2012-11-09
      • 2011-10-06
      • 2022-06-28
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多