web-dev-qa-db-ja.com

package.jsonのスクリプトにはどのような命名規則を使用しますか?

package.jsonこのスクリプト名は、lintfixの2つの単語で構成されています。正しい名前を付けるにはどうすればよいですか?

オプションがあります:

  1. lowerCamelCase-lintFix
  2. UpperCamelCase-LintFix
  3. snake_case-lint_fix
  4. ケバブケース-lint-fix
  5. コロン区切りのgulp-style-lint:fix
  6. その他の区切り文字。

どのオプションが正しいですか?なぜ?

16
galkin

正式な命名規則はありませんが、npm @ v5以降、lowerCamelCaseが事実上使用されています。 npm @ v5は、新しい標準スクリプト名prepublishOnlyを導入しました。 npm @ v5以前は、標準のスクリプトにはWordが1つしかありませんでした。たとえば、teststartprestartなどです。

したがって、ベストプラクティスはlowerCamelCaseを使用することです。

12
galkin

常にケバブケースを使用してください。コロンはむせびの先戻りであり、ひどく見えます。私はそれが嫌いです。

免責事項:私の意見はしばしば間違っており、機能不全の家族がいました。

8
John Henckel

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の顕著な例外を除いて、そこにあるトップパッケージの多くはケバブケースを使用しています。

7