Sicilian CLI 사용법

@ilokesto/sicilian은 개발자의 생산성을 높이고 반복적인 코드 작성을 줄이기 위한 CLI(Command Line Interface) 도구를 제공합니다. CLI를 통해 빠르고 효율적으로 sicilian 코드 스니펫을 간편하게 생성하고 프로젝트에 추가할 수 있습니다.

help 명령어#

help 명령어는 Sicilian CLI의 사용법과 사용 가능한 플래그 및 옵션에 대한 정보를 표시합니다.

npx sicilian help

또는 인자 없이 sicilian 명령어 만을 단독으로 실행할 때도 도움말이 표시됩니다.

npx sicilian

generate 명령어#

generate 명령어는 새로운 코드 스니펫을 생성하여 지정된 파일에 추가합니다.

npx sicilian -g <file_path> [options]

• <file_path>: 스니펫을 생성할 파일의 경로를 지정합니다. 파일이 존재하지 않으면 새로 생성되고, 이미 존재하면 스니펫이 파일 끝에 추가됩니다. 필요한 경우 상위 디렉토리도 자동으로 생성됩니다.
• -o, --object: 객체 형태의 스니펫을 생성합니다. 이 옵션을 사용하지 않으면 기본적으로 비구조화 할당 형태의 스니펫이 생성됩니다.

1. 기본 스니펫 생성 (비구조화 할당)#

다음 명령어를 사용하여 src/components/MyForm.tsx 에 비구조화 할당 형태의 스니펫을 생성합니다.

npx sicilian -g src/components/MyForm.tsx

명령어 실행의 결과로 src/components/MyForm.tsx 에 다음과 같은 코드가 추가됩니다:

import { CreateForm } from '@ilokesto/sicilian';

export const sicilianForm = new CreateForm({ 
  initValue: {}, 
  resolver: undefined, 
  validator: {}, 
  validateOn: ["change", "blur", "submit"],
  clearFormOn: ["submit", "routeChange"]
});

2. 객체 스니펫 생성#

다음 명령어를 사용하여 src/utils/formHooks.ts 에 객체 형태의 스니펫을 생성합니다.

npx sicilian -g src/utils/formHooks.ts -o

명령어 실행의 결과로 src/utils/formHooks.ts 에 다음과 같은 코드가 추가됩니다:

import { CreateForm } from '@ilokesto/sicilian';

export const {
  initValue,
  register,
  getValues,
  getErrors,
  setValues,
  setErrors,
  handleSubmit,
  handleServerAction
} = new CreateForm({ 
  initValue: {}, 
  resolver: undefined, 
  validator: {}, 
  validateOn: ["change", "blur", "submit"],
  clearFormOn: ["submit", "routeChange"]
});