open-index/open-npm huggingface dataset:
npm package: @seed-design/icon-deprecated
Description: 현재 이 패키지는 더 이상 사용되지 않습니다. 자세한 맥락은 [seed-icon](https://github.com/daangn/seed-icon) 레포에서 확인할 수 있습니다.
Latest version: 0.2.1
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# THIS PACKAGE IS DEPRECATED

현재 이 패키지는 더 이상 사용되지 않습니다.
자세한 맥락은 [seed-icon](https://github.com/daangn/seed-icon) 레포에서 확인할 수 있습니다.

# @seed-design/icon (deprecated)

- [한국어](./README.md)
- [English](./README-en.md)

## 설치하기

`@seed-design/icon`는 seed icon 생성을 위한 커맨드라인 도구입니다.

```bash
npm install --dev @seed-design/icon

# or

yarn add -D @seed-design/icon
```

## 사용 방법

단 두 가지 명령어로 seed icon을 생성할 수 있습니다.

### `init` (초기화)

`init` 명령어는 seed icon 생성을 위한 기본 폴더 구조를 생성합니다.
해당 명령어를 입력하면 `icon.config.yml` 설정 파일이 생성됩니다.

```bash
# npm
npm run seed-icon init

# yarn
yarn seed-icon init
```

### `generate` (생성하기)

`generate` 명령어는 생성된 `icon.config.yml` 설정 파일 아이콘에 필요한 파일들을 생성합니다.
생성되는 파일은 **아이콘 컴포넌트**와 **아이콘 데이터 파일**입니다.

```bash
# npm
npm run seed-icon generate
npm run seed-icon gen

# yarn
yarn seed-icon generate
yarn seed-icon gen
```

### etc (기타)

- help
- version

## Config 파일 옵션

`icon.config.yml` 설정 파일은 아래와 같은 옵션을 가집니다.

| Option          | Description                                                    | Default                                                               |
| --------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- |
| `icons`         | 위 피그마 파일에서 사용되는 아이콘 이름을 추가해주세요.        | [icon_add_circle_fill, icon_add_circle_regular, icon_add_circle_thin] |
| `componentPath` | 아이콘 컴포넌트가 저장될 경로입니다. 프로젝트 루트 기준입니다. | src/components/SeedIcon.tsx                                           |