CLI Konfiguration · All Contributors

Du kannst das Verhalten des all-contributors Bots konfigurieren, indem du die JSON Datei .all-contributorsrc bearbeitest. Hierin werden die Daten, welche für die Erstellung der Liste der Mitwirkenden benötigt werden, festgelegt. Weiters kann man einstellen wie man von @all-contributors-cli die Liste erstellen lassen möchte.

Du schaust dir die CLI Konfiguration an, welche ähnlich mit der Bot Konfiguration ist?

Dies sind die Schlüssel, die Du angeben kannst:

Option	Beschreibung	Beispiel/Standard Wert
`projectName`	Name des Projekt (erforderlich)	Beispiel: `all-contributors-cli`
`projectOwner`	Der Name des Users der das Projekt hostet ist erforderlich.	Beispiel: `jfmengels`
`repoType`	Typ des Repositories. Es muss entweder `github` oder `gitlab` sein.	Standardwert: `github`
`repoHost`	Verweist auf den Repository-Hostnamen. Ändere es, wenn Du ein selbst gehostetes Repository verwendest.	Standard: `https://github.com` wenn `repoType` `github`ist und `https://gitlab.com` wenn `repoType` `gitlab` ist
`files`	Liste von Dateien die aktualisiert werden sollen.	Standardwert: `['README.md']`
`imageSize`	Größe (in px) des User Avatar.	Standardwert: `100`
`commit`	Soll der Badge automatisch aktualisiert werden, wenn neue Mitwirkende hinzugefügt werden.	`true` oder `false`
`commitConvention`	Commit-Konvention (`angular`, `atom`, `ember`, `eslint`, `jshint` oder `gitmoji`).	Standardwert: `none`
`contributorsPerLine`	Maximale Anzahl von Spalten für die Tabelle der Mitwirkenden.	Standardwert: `7`
`contributorsSortAlphabetically`	`true`: Alphabetisch sortieren. `false`: In Reihenfolge der Beiträge.	Default: `false`
`badgeTemplate`	Definiere Deine eigene lodash Vorlage um den Batch erstellen zu lassen.
`contributorTemplate`	Definiere Deine eigene lodash Vorlage um die Mitwirkenden auf der Liste erstellen zu lassen.
`types`	Definiere benutzerdefinierte Symbole oder verknüpfe Beitragstypen Vorlagen. Kann die dokumentierten Typen überschreiben.
`contributors`	Liste der Mitwirkenden für dieses Projekt, diese wird von @all-contributors aktualisiert

{
  "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": []
}