Configuración de la interfaz de línea de comandos
Puede configurar all-contributors actualizando el archivo JSON .all-contributorsrc
. Los datos utilizados para generar la lista de colaboradores se almacenarán allí, y puede configurar cómo desea que all-contributors-cli
genere la lista.
Está viendo la configuración de CLI, ¿está buscando la configuración del bot?
Estas son las claves que puede especificar:
Opción | Descrición | Ejemplo/Defecto |
---|---|---|
projectName | Obligatorio, nombre del proyecto. | Ejemplo: all-contributors-cli |
projectOwner | Obligatorio, nombre del usuario que aloja el proyecto. | Ejemplo: jfmengels |
repoType | Tipo de repositorio. Debe ser github o gitlab . | Defecto: 100 |
repoHost | Apunta al nombre de host del repositorio. Cámbiala si usas un repositorio auto alojado. | Defecto: https://github.com si repoType es github , y https://gitlab.com si repoType es gitlab |
files | Arreglo (o vector) de archivos para actualizar. | Defecto: ['README.md'] |
imageSize | Tamaño (en px) del avatar del usuario. | Defecto: 100 |
commit | Insignia de auto-commit al agregar colaboradores. | true o false |
commitConvention | Convención de commit (angular , atom , ember , eslint , jshint o gitmoji ). | Por defecto: none |
contributorsPerLine | Número máximo de columnas para la tabla de colaboradores. | Defecto: 7 |
contributorsSortAlphabetically | true : Ordena alfabéticamente. false : Mostar por orden de contribución. | Por defecto: false |
badgeTemplate | Defina su propia plantilla de lodash para generar la insignia. | |
contributorTemplate | Defina su propia plantilla de lodash para generar el colaborador. | |
types | Especifique símbolos personalizados o plantillas de enlaces para los tipos de contribución. Puede anular los tipos documentados. | |
contributors | Lista de colaboradores para este proyecto, esto se actualiza por 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": []
}