Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update manifest and readme #3

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 51 additions & 2 deletions packages/icon-export-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,56 @@ This plugin can export selected icon from figma layouts.
npm run build
```

### Условия для загрузки plugins

- у учетной записи включена возможность `dev mode`;
- установлена приложение `Figma` (MacOS, Windows);

### Import plugin to figma

1. In toolbar: `Plugins` -> `Manage plugins...`.
2. In modal window: `Plugins` -> `In development` -> `+` -> `Import plugin from manifest`.
1. Выбираем в верхнем меню: `Plugins` -> `Development` -> `Import plugin from manifest`.
2. После плагин доступен в приложении

### Использование

- выбираем иконку или группу иконок и запускаем плагин
- появиться UI плагина в котором можно будет указать название commit и заголовок для pull request (так же будет информация о кол-ве svg иконок)

### Как использовать token (PAT)?

Для корректной работы плагина нужен github token - [Creating a fine grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)

В файле `useGithubAuth.ts` укажите полученный вами токен.

```ts
const [token, setToken] = useState<string | undefined>('PAT');
```

#### Обход ограничение github rate limit

К сожалению за раз обработать более 600 иконок нельзя - есть ограничения.

Поэтому можно в "ручном" режиме добавлять commit к созданной ветке.

- создаем pull request с первым набором иконок через плагин
- убедились что ветка и pull request созданы
- в файле `useRunGithubPRProcess.ts` выключаем шаги: 0, 6, 7
- в файле `App.tsx` меняем `branchName` на созданную вами ветку, например - `icon-export-63qgo1r6vg8`

```tsx
const [step, createPullRequest] = useRunGithubPRProcess({
branchName: `icon-export-${getSalt()}`, //"<-- icon-export-63qgo1r6vg8"
});
```

- в файле `githubFilesFetcher.ts` меняем в методе `getFilesSource` значение для `ref`

```ts
const result = await octokit.rest.repos.getContent({
ref: 'dev', // <-- branchName (icon-export-63qgo1r6vg8)
});
```

Этот "трюк" позволит создавать новые commits и добавлять их к **уже** **созданной** ветке/pull request.

Примечание: В корне пакета `icon-export-ui` должен быть запущен webpack - `npm run watch`.
15 changes: 8 additions & 7 deletions packages/icon-export-ui/manifest.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "@salutejs/icon-export-ui",
"id": "1065149449043856348",
"api": "1.0.0",
"main": "dist/main.js",
"ui": "dist/ui.html",
"editorType": ["figma"],
"permissions": ["currentuser"]
"name": "@salutejs/icon-export-ui",
"id": "1065149449043856348",
"api": "1.0.0",
"main": "dist/main.js",
"ui": "dist/ui.html",
"editorType": ["figma", "dev"],
"permissions": ["currentuser"],
"capabilities": ["inspect"]
}
Loading