Konfigurasi CLI
Kamu bisa mengkonfigurasi all-contributors dengan memperbarui berkas JSON .all-contributorsrc
. Data yang digunakan untuk membuat daftar kontributor akan disimpan di sana, dan kamu dapat mengonfigurasi bagaimana kamu ingin all-contributors-cli
untuk membuat daftar.
Kamu sedang melihat Konfigurasi CLI, apa kamu sedang mencari Konfigurasi Bot?
Berikut adalah kunci yang bisa kamu tentukan:
Pilihan | Deskripsi | Contoh/Bawaan |
---|---|---|
projectName | Nama proyek, harus diisi. | Contoh: all-contributors-cli |
projectOwner | Nama pengguna yang memiliki proyek tsb, harus diisi. | Contoh: jfmengels |
repoType | Tipe repositori. Harus github atau gitlab . | Bawaan: github |
repoHost | Mengarah ke nama host repositori. Ganti jika kamu menggunakan repositori yang di-hosting sendiri. | Bawaan: https://github.com jika repoType adalah github , dan https://gitlab.com jika repoType adalah gitlab |
files | Array file untuk diperbarui. | Bawaan: ['README.md'] |
imageSize | Ukuran (dalam px) dari avatar pengguna. | Bawaan: 100 |
commit | Lencana auto-commit ketika menambahkan kontribusi. | true atau false |
melakukan Konvensi | Melakukan konversi (bersudut , atom , bara , pengumpan , jshint atau gitmoji ). | Bawaan: none |
contributorsPerLine | Maksimal jumlah kolom untuk tabel kontributor. | Bawaan: 7 |
kontributor Sortir menurut abjad | true : Sort alphabetically. false : Display in order of addition. | Utama: salah |
badgeTemplate | Tentukan template lodash kamu sendiri untuk menghasilkan lencana. | |
contributorTemplate | Tentukan template lodash kamu sendiri untuk menghasilkan kontributor. | |
types | Tentukan simbol atau templat tautan khusus untuk jenis kontribusi. Dapat mengganti jenis yang didokumentasikan. | |
contributors | Daftar para kontributor untuk proyek ini, diperbarui oleh 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": []
}