Конфигурация CLI · All Contributors

Вы можете настроить all-contributors, изменяя JSON .all-contributorsrc файл. Данные, используемые для генерации списка участников, будут сохранены в этом файле, и Вы можете настроить all-contributors-cli для генерации списка как Вам угодно.

Вы просматриваете CLI-конфигурацию, ищете конфигурацию бота?

Ниже приведены ключи, которые можно задать:

Опция	Описание	Пример/По-умолчанию
`projectName`	Обязательно, имя проекта.	Пример: `all-contributors-cli`
`projectOwner`	Обязательно, имя пользователя, на котором размещается проект.	Пример: `jfmengels`
`repoType`	Тип репозитория. Должно быть `github` или `gitlab`.	По умолчанию: `github`
`repoHost`	Указывает имя хоста репозитория. Измените его, если вы используете собственный репозиторий.	По умолчанию: `https://github.com` если `repoType` является `github`, и `https://gitlab.com` если `repoType` является `gitlab`
`files`	Массив файлов для обновления.	По умолчанию: `['README.md']`
`imageSize`	Размер аватара пользователя (в пикселях).	По умолчанию: `100`
`commit`	Автоматически коммитить значек (badge) при добавлении участников.	`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": []
}