📦 보일러플레이트 생성기를 만들어보자

1. 프로젝트 설정

• bin : 프로젝트 설치, 실행시 실행될 스크립트가 들어갈 디렉토리

• dist : 빌드된 프로그램 디렉토리

• lib : 보일러플레이트들

• src : 보일러플레이트 생성기 소스

#!/usr/bin/env node

require("../dist")().run();

chmod 755 run
chmod 755 run.cmd

2. index.ts

const run = () => {
  const selectItemMap: SelectItemMap = new Map(selectItems)
  const options: PromptOptions = {
    DEFAULT_DEST_DIR_NAME,
    QUESTION_MESSAGE1,
    QUESTION_MESSAGE2,
  }

  createPrompt(selectItemMap, options)
}

module.exports = () => {
  return {
    run,
  }
}

3. data.ts

• type : 보일러플레이트인지, quit인지에 대한 정보 (‘boiler-plate’ | ‘quit’)

• dirName : 보일러플레이트의 경우 디렉토리이름

• description : 터미널에 출력될 문자열

export const selectItems: SelectItems = [
  [
    0,
    {
      type: 'boiler-plate',
      dirName: 'ts-webpack',
      description: '- TypeScript + Webpack',
    },
  ],
  [
    1,
    {
      type: 'boiler-plate',
      dirName: 'js-webpack',
      description: '- JavaScript + Webpack',
    },
  ],
  [
    2,
    {
      type: 'quit',
      description: '- quit',
    },
  ],
]

export const defaultDestDirName = 'my-app'
export const QUESTION_MESSAGE1 =
  '생성할 프로젝트명을 입력하세요(default : my-app, 현재위치: . ) > '
export const QUESTION_MESSAGE2 = '\n\n생성할 보일러 플레이트를 선택해주세요.\n'
export const SUCCESS_MESSAGE = '\n생성되었습니다!\n'
export const FAILURE_MESSAGE = '\n아무일도 일어나지 않았습니다!\n'
export const QUIT_MESSAGE = '\n종료되었습니다!\n'
export const EXIST_DEST_ERROR_MESSAGE = '\n디렉토리가 존재합니다.\n"'
export const EXIST_TARGET_ERROR_MESSAGE =
  '\n현재 디렉토리에 파일들이 존재합니다\n'

4. types.ts

interface QuitSelectItem {
  type: 'quit'
  description: string
}

interface BoilerSelectItem {
  type: 'boiler-plate'
  dirName: string
  description: string
}

export type SelectItems = Array<[number, QuitSelectItem | BoilerSelectItem]>

export type SelectItemMap = Map<number, QuitSelectItem | BoilerSelectItem>

export interface PromptOptions {
  defaultDestDirName?: string
  QUESTION_MESSAGE1?: string
  QUESTION_MESSAGE2?: string
  SUCCESS_MESSAGE?: string
  FAILURE_MESSAGE?: string
  QUIT_MESSAGE?: string
  EXIST_DEST_ERROR_MESSAGE?: string
  EXIST_TARGET_ERROR_MESSAGE?: string
}

export type DefaultPromptOptions = Required<PromptOptions>

5. prompt.ts

const {
  defaultDestDirName,
  QUESTION_MESSAGE1,
  QUESTION_MESSAGE2,
  SUCCESS_MESSAGE,
  FAILURE_MESSAGE,
  QUIT_MESSAGE,
  EXIST_DEST_ERROR_MESSAGE,
  EXIST_TARGET_ERROR_MESSAGE,
} = { ...defaultOptions, ...options }

term.cyan(QUESTION_MESSAGE1)

const destDirName = await getDestDirName(defaultDestDirName)

const selectItemValues = selectItemMap.values()
const descriptions = Array.from(selectItemValues).map(
  value => value.description
)

term.cyan(QUESTION_MESSAGE2)

const selectedItem = await getSelectItemType(descriptions)

const selectedItemType = await createDirectory(
  selectItemMap,
  selectedItem.selectedIndex,
  destDirName
)

if (selectedItemType === 'exist-dest') {
  term.red(EXIST_DEST_ERROR_MESSAGE)
  createPrompt(selectItemMap, options)
}
if (selectedItemType === 'exist-target') {
  term.red(EXIST_TARGET_ERROR_MESSAGE)
  createPrompt(selectItemMap, options)
}
if (selectedItemType === 'boiler-plate') {
  term.cyan(SUCCESS_MESSAGE)
  process.exit(0)
}
if (selectedItemType === 'quit') {
  term.red(FAILURE_MESSAGE)
  process.exit(0)
}
if (!selectedItemType) {
  term.white(QUIT_MESSAGE)
  process.exit(0)
}

6. 배포

{
  "name": "@taenykim/generator",
  "version": "0.0.3",
  "scripts": {
    "dev": "tsc && ./bin/run",
    "build": "tsc"
  }
}

7. 사용

npx는 node_module 로 패키지가 저장되지 않고, 패키지 실행 후, 제거된다.

8. 후기