Configuração de CLI
Pode configurar o all-contibuters actualizando o arquivo JSON .all-contributorsrc
. Os dados utilizados para gerar a lista de contribuidores serão armazenados aí, e pode configurar como quer que o all-contributors-cli
gere a lista.
Está vendo a Configuração do CLI, procurando a Configuração do Bot?
Estas são as chaves que pode especificar:
Opção | Descrição | Exemplo/Padrão |
---|---|---|
projectName | Obrigatório, nome do projeto. | Exemplo: todos os contribuidores-cli |
projectOwner | Obrigatório, nome do usuário em que o projeto está hospedado. | Exemplo: jfmengels |
repoType | Tipo de repositório. Deve ser github ou gitlab . | Padrão: github |
repoHost | Nome do host do repositório. Mude-o se usar um repositório auto-hospedado. | Padrão: https://github.com se o repoType for github , e https://gitlab.com se o repoType for gitlab |
files | Lista the arquivos a actualizar. | Padrão: ['README.md'] |
imageSize | Tamanho (em px) do avatar do usuário. | Padrão: 100 |
commit | Opção de commitar automaticament ao adicionar novos contribuidores. | true ou false |
commitConvention | Convenção de commit (angular , atom , ember , eslint , jshint ou gitmoji ). | Padrão: nenhum |
contributorsPerLine | Número máximo de colunas na tabela de contribuidores. | Padrão: 7 |
contributorsSortAlphabetically | true : Sort alphabetically. false : Display in order of addition. | Padrão: false |
badgeTemplate | Defina o próprio modelo de lodash para gerar o badge. | |
contributorTemplate | Defina o próprio modelo de lodash para gerar o contribuidor. | |
types | Especificar símbolos personalizados ou modelos de link para os tipos de contribuição. Pode substituir os tipos documentados. | |
contributors | Lista de contribuidores para este projeto, isto é atualizado ao rodar 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": []
}