create-ts-index

설치

npm install create-ts-index --save-dev

소개

TypeScript 프로젝트를 개발할 때 export를 위한 index.ts 파일을 생성합니다. index.ts 파일을 export 용도로만 사용하거나 라이브러리 프로젝트를 개발할 때 유용합니다. 예를들면 blueprint.js와 같은 라이브러리 프로젝트를 개발한다면 컴포넌트를 다른 프로젝트에서 사용할 수 있도록 모든 파일을 export 해야 합니다. 이런 경우 create-ts-index를 아주 유용하게 사용할 수 있습니다. 라이브러리 프로젝트가 아니라도, create-ts-index를 사용해서 export 용 index.ts 파일을 사용한다면 import 구문을 간단하게 만들 수 있고 협업할 때 import 형식에 대한 고민을 줄일 수 있어서 유용합니다.

예를들어, 아래와 같은 디렉터리가 있다고 가정합시다.

  src/
    app.ts
    component/
      Nav.ts
      Button.ts

create-ts-index create sub-command는 아래와 같이 export index.ts 파일을 생성합니다.

  src/
    app.ts
    > index.ts
      // created from 'create-ts-index'
      export * from './component';
      export * from './app';
    component/
      Nav.ts
      Button.ts
      > index.ts
        // created from 'create-ts-index'
        export * from './Nav';
        export * from './Button';

만약 create-ts-index entrypoint sub-command를 사용하면 아래와 같이 동작합니다.

  src/
    app.ts
    component/
      Nav.ts
      Button.ts
  > entrypoint.ts
    // created from 'create-ts-index'
    export * from './src/app.ts'
    export * from './src/component/Nav.ts'
    export * from './src/component/Button.ts'

index.ts 파일을 webpack entrypoint로 사용할 수 있습니다.

옵션

라이브러리로 사용할 경우

• fileFirst: boolean 생성되는 export 파일내용에서 파일이름을 먼저 export 할지 디렉터리 이름을 먼저 export 할지 결정합니다. 기본 값은 false 입니다.
• addNewline: boolean 파일 마지막에 줄바꿈 문자를 추가할지 말지를 결정합니다. 기본 값은 true 입니다.
• useSemicolon: boolean 줄 마지막에 ; 문자를 추가할지 말지를 결정합니다. 기본 값은 true 입니다.
• useTimestamp: boolean 파일 처음에 주석을 작성할 때 시간(YYYY-MM-DD HH:mm 형식)을 추가할지 말지를 결정합니다. 기본 값은 false 입니다.
• includeCWD: boolean 작업디렉터리로 전달된 cwd에 대해서 index.ts 파일을 생성할 것인지에 대해서 결정합니다. 기본 값은 true 입니다.
• excludes: string[] 제외할 디렉터리를 전달합니다. 기본 값은 ['@types', 'typings', '__test__', '__tests__'] 입니다.
• fileExcludePatterns: string[] 제외할 파일이름 패턴을 전달합니다. 기본 값은 [] 입니다. 전달된 패턴은 indexOf 함수를 사용하여 파일이름에서 검색되며 indexOf 함수 결과가 0 이상인 경우 제외됩니다.
• targetExts: string[] export 구문을 생성할 때 사용할 확장자명을 전달합니다. 기본 값은 ['ts', 'tsx'] 입니다. 확장자명을 전달할 때는 예와같이 점 문자를 제외하고 전달해야합니다.
• globOptions: glob.IOptions node-glob 옵션 값을 전달할 수 있습니다. 자세한 내용은 링크문서를 참고하세요.
• quote export 구문에서 사용할 따옴표 문자를 전달합니다. 기본 값은 홑따옴표 입니다.
• verbose 실행할 때 더 많은 로그 메시지를 출력합니다.
• withoutComment index.ts 파일 또는 entrypoint.ts 파일 맨 윗줄에 추가되는 주석을 제거합니다.
• withoutBackupFile index.ts 파일 또는 entrypoint.ts 파일을 생성할 때 이미 파일이 있는 경우 백업 파일을 생성하는 기능을 사용하지 않습니다.
• output index.ts 파일 또는 entrypoint.ts 파일 이름의 이름을 변경합니다.

CLI(command-line interface)로 사용할 경우

• -f --filefirst 생성되는 export 파일내용에서 파일이름을 먼저 export 할지 디렉터리 이름을 먼저 export 할지 결정합니다. 옵션을 생략하면 false, 전달하면 true 이며, 기본 값은 false 입니다.
• -n --addnewline 파일 마지막에 줄바꿈 문자를 추가할지 말지를 결정합니다. 옵션을 생략하면 true, 전달하면 false 입니다.
• -s --usesemicolon 줄 마지막에 ; 문자를 추가할지 말지를 결정합니다. 옵션을 생략하면 true, 전달하면 false 입니다.
• -t --usetimestamp 파일 처음에 주석을 작성할 때 시간(YYYY-MM-DD HH:mm 형식)을 추가할지 말지를 결정합니다. 옵션을 생략하면 false 전달하면 true 입니다.
• -c --includecwd 작업디렉터리로 전달된 cwd에 대해서 index.ts 파일을 생성할 것인지에 대해서 결정합니다. 옵션을 생략하면 true 전달하면 false 입니다.
• -e --excludes [comma separated exclude directories] 제외할 디렉터리를 전달합니다. 기본 값은 ['@types', 'typings', '__test__', '__tests__'] 입니다. 사용자 설정 값을 전달하려고 하는 경우 아래 예제와 같이 쉼표로 구분해서 전달하세요.
• -i --fileexcludes [comma separated extname] 제외할 파일이름 패턴을 전달합니다.기본 값은 [] 입니다. 사용자 설정 값을 전달하려고 하는 경우 쉼표로 구분해서 전달하세요.
• -x --targetexts [comma separated extname] export 구문을 생성할 때 사용할 확장자명을 전달합니다. 기본 값은 ['ts', 'tsx'] 입니다. 확장자명을 전달할 때는 예와같이 점 문자를 제외하고 전달해야합니다. 또한 사용자 설정 값을 전달하려고 하는 경우 아래 예제와 같이 쉼표로 구분해서 전달하세요.
• -v --verbose 로그 메시지를 더 상세하게 출력합니다. 1.5.0 버전부터 로그 메시지 출력을 간소화 하였습니다. 하여 기존과 같이 상세한 로그를 보고자 하는 경우 이 옵션을 추가해야 합니다.
• -q --quote 따옴표를 결정한다. 쌍따옴표와 홑따옴표를 전달할 수 있고 전달한 문자를 사용해서 따옴표를 출력한다.
• -w --withoutcomment index.ts 파일 또는 entrypoint.ts 파일 맨 윗줄에 추가되는 주석을 제거합니다.
• -b --withoutbackup index.ts 파일 또는 entrypoint.ts 파일을 생성할 때 이미 파일이 있는 경우 백업 파일을 생성하는 기능을 사용하지 않습니다.
• -o --output index.ts 파일 또는 entrypoint.ts 파일 이름의 이름을 변경합니다.

사용법

라이브러리로 사용하는 경우

TypeScritIndexWriter 사용

const tsiw = new TypeScritIndexWriter();
const option = TypeScritIndexWriter.getDefaultOption('./src');

(async () => {
  await tsiw.create(option);

  // or

  await tsiw.createEntrypoint(option);
})();

CommandModule 사용

(async () => {
  const option = CreateTsIndexOption.getOption({});
  const createCommand = new CreateCommandModule();
  await createCommand.do(process.cwd(), option);
});

CLI로 사용하기

Git-style sub-command를 사용합니다.

• create
  • index.ts 파일을 재귀적으로 생성합니다.
• entrypoint
  • entrypoint.ts 파일을 생성합니다.
• init
  • .ctirc 파일을 생성합니다.
• clean
  • entrypoint.ts 파일과 index.ts 파일을 모두 삭제합니다. 복원할 수 없으니 주의하세요.

# 기본 사용법
## create 명령어
cti ./src
cti create ./src

## entrypoint 명령어
cti entrypoint ./src

# 줄바꿈 문자 포함하지 않기
cti create -n ./src
## or
cti entrypoint -n ./src

# 제외할 디렉터리를 직접 전달하는 방법
cti create -n -e @types typings __test__ __tests__ pages ./src
## or
cti entrypoint -n -e @types typings __test__ __tests__ pages ./src

# entrypoint.ts 와 index.ts 파일 삭제하기
cti clean ./src

# 하위 디렉터리를 포함해서 실행하기
for f in *; do cti create ./$f; done

# 여러 디렉터리를 전달하기
cti create ./src/server ./src/client ./src/module

CLI 에 .ctirc 설정파일 적용하기

create-ts-index cli는 1.7.0버전에서 .ctirc 설정파일을 지원합니다. 설정파일 이름은 오직 .ctirc 만 가능합니다. .ctirc는 여러 개를 만들어서 적용할 수 있습니다. create-ts-index는 제일 먼저 인자로 주어진 디렉터리에서 .ctirc 파일을 찾습니다. 다음은 cti 스크립트가 실행된 디렉터리에서 .ctirc 파일을 찾습니다. 그리고 스크립트 디렉터리, 인자 디렉터리 순으로 설정을 차례대로 적용하고 스크립트를 실행합니다. 단, cti 스크립트 인자로 주어진 설정은 우선적으로 적용됩니다. .ctirc 파일은 json5 형식으로 기술되며 주석을 쓰거나 키 값을 쌍따옴표를 쓰지 않고 기술할 수 있습니다. 자세한 스펙은 링크를 참고하세요.

아래 예제는 .ctirc 파일을 어떻게 찾고, 적용하는지를 보여줍니다.

# execute on /Users/cti/github/create-ts-index
sh> cti create ./example/type01

# search configuration file on "/Users/cti/github/create-ts-index"
# search configuration file on "/Users/cti/github/create-ts-index/example/type01"
# apply configuration by "/Users/cti/github/create-ts-index"
# apply configuration by "/Users/cti/github/create-ts-index/example/type01"
# every configuration is overwrited 

.ctirc 파일 생성하기

cli를 사용해서 .ctirc 파일을 생성할 수 있습니다.

# 현재 디렉터리에 생성
> cti init

# 여러 디렉터리에 생성
> cti init ./example/type03 ./example/type02

Language

• English
• Korean