bower.json の 仕様 (日本語)

必須

Bower リポジトリ に登録するパッケージ名。

• ユニークな名前であること。
• シンプルさ、一貫性、互換性のために、分かりやすい名前であること。
• 小文字の "a-z"、数字 "0-9"が含められる。
  ダッシュ "-"、ドット "." も利用できるが最初と最後には使えない。
• 連続したダッシュ "-" 、ドット "." は利用できない。
• 50文字未満であること。

推奨

140文字までの任意の文字列。

簡単な説明を付けることで作成したパッケージを検索および特定しやすくします。 パッケージがどう作られているかではなく、どのようなものかを記載します。 CLIで検索した結果やWebサイトのパッケージ検索結果に表示されます。

推奨

パッケージを利用する際に必要となるエントリーポイントファイルを記載します。 ファイルタイプごとに１ファイルずつ指定できます。

エントリーポイントファイルでは モジュール の エクスポート や インポート があります。 Bower では 直接 main ファイルを利用しませんが、bower list --json や bower list --paths コマンドを使用するときリストアップを行います。

例えば以下のようなパッケージを準備していたとします。

package
  js/
    motion.js
    run.js
    walk.js
  sass/
    motion.scss
    run.scss
    walk.scss
  img/
    motion.png
    walk.png
    run.png
  fonts/
    icons.woff2
    icons.woff
  dist/
    movement.js
    movement.min.js
    movement.css
    movement.min.css

motion.js は run.js と walk.js をインポートするモジュールで、motion.scss は run.scss と walk.scss をインポートしているモジュールの場合、main は次のようになります。

"main": [
  "js/motion.js",
  "sass/motion.scss",
]

画像およびフォントファイルも JS や Sass ファイルの中で参照されているかもしれませんが、エントリーポイントではないため main ファイルではありません。

• ビルド前の配布ファイルを指定してください。
• 縮小ファイルは含めないでください。
• 画像、フォント、音声、動画といったリソースファイルは含めないでください。
• ファイル名にバージョンを含めないでください。（悪い例：package.1.1.0.js；良い例：package.js）
• js/*.js といったワイルドカードは使えません。

dependencies は パッケージ名 と 単純なハッシュ

• キーは有効なパッケージ名でなくてはなりません。
• バリューは有効な semver範囲、Git URL、URL （tarball や zipball を含む）でなければなりません。
• Git URL は末尾にハッシュ"#"を付けて参照 (リビジョンを示す SHA、ブランチ、タグ）に制限を付けることができます。
  例：https://github.com/owner/package.git#branch
• バリューは owner/package という短縮表記が利用できます。 デフォルトでは短縮形は GitHub の git://github.com/%owner%/%package%.git を参照します。 この設定は .bowerrc の shorthand_resolver で変更することもできます。
• ローカルパスはローカル開発のための値として使われますが、Bowerリポジトリへ登録する際は許可されません。

dependencies を同じルールです。

テストフレームワークやビルドドキュメントといった開発時でしか利用しないパッケージを記載します。

推奨

main JavaScriptファイル で定義されるモジュールの種別を記載します。 以下の種別から１つないし複数指定できます。

推奨

"name" と同じフォーマットで指定します。

キーワード検索で使われます。 パッケージ名が分からなくても簡単にパッケージを検索できるようにします。

パッケージを作成している著者のリストを指定します。 以下のどちらかのフォーマットで指定します。

"authors": [
  "John Doe",
  "John Doe <john@doe.com>",
  "John Doe <john@doe.com> (http://johndoe.com)"
]

"authors": [
  { "name": "John Doe" },
  { "name": "John Doe", "email": "john@doe.com" },
  { "name": "John Doe", "email": "john@doe.com", "homepage": "http://johndoe.com" }
]

推奨

SPDX ライセンス リスト の 識別子 (Identifier) または ライセンスへの パス か URL を指定します。

推奨

あなたのパッケージをインストールする際、Bower が 無視するファイルのリストを指定します。

(*) シンボリックリンクは常に無視されますが、bower.json は無視されません。

無視するルールは gitignore pattern spec と同じルールに従います。

ソースコードがあるリポジトリを指定します。

パッケージ間で競合が発生した場合に自動解決させる依存バージョンを指定します。