Tbpgr Blog

Recruiting Operations tbpgr(てぃーびー) のブログ

Package.json

個人用メモです。
どこからでも確認できるように public な場所に置いていますが 特に人に見せることを意識してまとめていません。

package.json とは?

Specifics of npm’s package.json handling

設定項目について

気になる点だけ抜粋

  • keywords - npm search 時に利用される
  • bugs - url, email を指定可能。 npm bugs で該当URLを開く
  • main - main で指定した js で export している内容が利用者に require される

package.json の検証

Web、CLIの2つのツールがありました。

Web - package-json-validator

以前に作った Atom の Package である five-move でためします。

f:id:tbpg:20170818153348p:plain

よし、怒られた(だめじゃん)

CLI - package.json-validator

$ npm install package-json-validator
  • test
# 成功時
$ pjv
{ valid: true }

# エラーケース
# name に ^(キャレット)を含んで実行
$ pjv
package.json is NOT valid
{ valid: false,
  errors: [ 'Value for field name, ^hoge does not match format: /^[a-zA-Z0-9@\\/][a-zA-Z0-9@\\/\\.\\-_]*$/' ] }