@charcoal-ui/icons-cli v3.11.0
@charcoal-ui/icons-cli
Figma からアイコンの SVG をダウンロードし、GitHub に自動で更新の Pull Request を作成します。
GitLab にも対応しています。
インストール
npm
npm i --save-dev @charcoal-ui/icons-cli
yarn
yarn add -D @charcoal-ui/icons-cli
使い方
Figma からアイコンをダウンロードする
yarn icons-cli figma:export
必要な環境変数は以下です。
名前 | 必須 | 説明 |
---|---|---|
FIGMA_FILE_URL | yes | Figma の URL です。node-id は含んでいても良いです |
FIGMA_TOKEN | yes | Figma API のアクセストークンです |
OUTPUT_ROOT_DIR | yes | svg をダウンロードするディレクトリ( 例: packages/icons ) |
Figma 内のコンポーネントは以下の命名規則に従います( 例: 16/Add
Inline/Add
)。
/
を含む/
の前は数字あるいはInline
SVG ファイルにアイコン向けの変換をかける
yarn icons-cli svg:optimize --file path/to/file --color "#000"
ダウンロードしたファイルに SVGO による最適化をかけつつ、指定した色を currentColor
に置換します。
GitHub に Pull Request を作成する
yarn icons-cli github:pr
必要な環境変数は以下です。
名前 | 必須 | 説明 |
---|---|---|
GITHUB_ACCESS_TOKEN | yes | GitHub のアクセストークンです |
GITHUB_REPO_OWNER | no | リポジトリの owner です( 例: pixiv ) |
GITHUB_REPO_NAME | no | リポジトリ名です( 例: charcoal ) |
GITHUB_DEFAULT_BRANCH | no | リポジトリのデフォルトブランチです( 例: main ) |
GitLab に Pull Request を作成する
yarn icons-cli gitlab:mr
必要な環境変数は以下です。
名前 | 必須 | 説明 |
---|---|---|
GITLAB_PROJECT_ID | yes | GitLab のプロジェクト ID(数値)です |
GITLAB_ACCESS_TOKEN | yes | GitLab のアクセストークンです |
GITLAB_HOST | no | GitLab のホスト名(セルフホスティング版の場合は自身のサーバーのホスト名)です |
GITLAB_DEFAULT_BRANCH | no | リポジトリのデフォルトブランチです( 例: main ) |
7 days ago
8 days ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
4 months ago
4 months ago
8 months ago
6 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
7 months ago
10 months ago
10 months ago
6 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago