CLIの設定 · All Contributors

.all-contributorsrc JSON ファイルからall-contributorsの設定を変更できます。コントリビューターリストを生成するためのデータはそのファイルに格納されています。また、all-contributors-cliでどのようにリストを生成するのかの設定も変更できます。

これはCLI設定に関するページです。ボット設定をお探しですか？

指定できるキーは以下のとおりです:

オプション	説明	例/デフォルト
`projectName`	必須、プロジェクトの名前	例: `all-contributors-cli`
`projectOwner`	必須、プロジェクトのホストユーザー名	例: `jfmengels`
`repoType`	リポジトリのタイプ。 `github`あるいは`gitlab`のどちらか。	デフォルト: `github`
`repoHost`	リポジトリのホスト名。セルフホストされたリポジトリの場合は変更してください。	デフォルト: `repoType`が`github`なら`https://github.com` 、`gitlab`なら`https://gitlab.com`
`files`	更新対象のファイル配列	デフォルト: `['README.md']`
`imageSize`	ユーザーアバターのサイズ (px)	デフォルト: `100`
`commit`	コントリビューターを追加するときにバッジを自動コミットする。	`true`あるいは`false`
`commitConvention`	コミット規約 (`angular`、`atom`、`ember`、`eslint`、`jshint`または`gitmoji`)。	デフォルト: `none`
`contributorsPerLine`	コントリビューターテーブルの最大カラム数	デフォルト: `7`
`contributorsSortAlphabetically`	`true`: Sort alphabetically. `false`: Display in order of addition.	Default: `false`
`badgeTemplate`	バッジを生成するための独自のlodashテンプレート定義
`contributorTemplate`	コントリビューターを生成するための独自のlodashテンプレート定義
`types`	コントリビュータータイプのカスタムシンボルかリンクテンプレートの指定。記述されたタイプを上書き可能
`contributors`	プロジェクトのコントリビューターリスト、all-contributors addで更新される

{
  "projectName": "all-contributors-cli",
  "projectOwner": "jfmengels",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
  "types": {
    "custom": {
      "symbol": "🔭",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "contributors": []
}