CLI 설정
.all-contributorsrc
JSON 파일을 업데이트하여 all-contributors를 구성할 수 있습니다. 기여자 목록을 생성하는 데 사용되는 데이터는 여기에 저장되며 all-contributors-cli
에서 목록을 생성하는 방법을 구성할 수 있습니다.
혹시 봇 구성을 찾으시나요? 현재 CLI 설정을 잃고 계십니다.
지정할 수있는 키는 다음과 같습니다.
옵션 | 내용 | 예제/기본값 |
---|---|---|
projectName | 필수 옵션인 프로젝트 이름. | 예: all-contributors-cli |
projectOwner | 필수적 옵션인 프로젝트가 호스팅되는 사용자의 이름. | 예: jfmengels |
repoType | 리포지토리 유형. github 와 gitlab 둘중에 하나. | 기본값: github |
repoHost | 리포지토리 호스트를 가리킵니다. 자가 호스팅 리포지토리를 사용하는 경우 변경하십시오. | 기본값: repoType 이 github 이면 https://github.com 으로, repoType 이 gitlab 이면 https://gitlab.com |
files | 업데이트 할 파일의 배열. | 기본값: ['README.md'] |
imageSize | 사용자의 아바타 크기 (픽셀 단위) 입니다. | 기본값: 100 |
commit | 기여자를 자동 추가 할 때 자동 커밋 배지. | true 나 false |
commitConvention | 커밋 컨벤션 (angular , atom , ember , eslint , jshint 나 gitmoji ). | 기본값: none |
contributorsPerLine | Contributors 테이블의 최대 열 수. | 기본값: 7 |
contributorsSortAlphabetically | true : 알파벳순으로 정렬. false : 추가 순서대로 표시. | 기본값: 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": []
}