create-ts-index

Install

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

Please using ctix

ctix next generation export generation tool. ctix use TypeScript compiler API. So Many problem solve in create-ts-index. For example, separate project(using by tsconfig.json) and support default function, auto detect file that have export statement, etc. I need more help for improvement at ctix.

Introduction

index.ts file create for exportation. If don't have business logic in index.ts that use to only exportation, create-ts-index help easy importing. Or if you have library project need this export process(for example, blueprint.js etc ...). cti(create-ts-index) create export index.ts file.

For example, sample directory below.

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

create-ts-index create sub-command create index.ts file below.

  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 create index.ts file below.

  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'

Option

library

• fileFirst: boolean export list create filefirst. default false
• addNewline: boolean decide add newline file ending. default true
• useSemicolon: boolean decide use semicolon line ending. default true
• useTimestamp: boolean decide use timestamp(YYYY-MM-DD HH:mm) top line comment. default false
• includeCWD: boolean decide include cwd directory. default true
• excludes: string[] pass exclude directory. default exclude directory is ['@types', 'typings', '__test__', '__tests__']
• fileExcludePatterns: string[] pass exclude filename pattern. default exclude patterns is []
• targetExts: string[] pass include extname. default extname is ['ts', 'tsx']. extname pass without dot character.
• globOptions: glob.IOptions pass include glob options. node-glob option use it.
• quote decide quote character. Single quote character use to default.
• verbose verbose log message display
• withoutComment remove create-ts-index comment that top of line in index.ts
• withoutBackupFile Don't create backup file if already exists target file
• output index.ts or entrypoint.ts filename change
• includeDeclarationFiles pass declaration files (*.d.ts). default is false

cli (use it cti)

• -f --filefirst export list create file first, no option false, option true
• -n --addnewline decide add newline file ending. no option true, option false
• -s --usesemicolon decide use semicolon line ending. no option true, option false
• -t --usetimestamp decide use timestamp(YYYY-MM-DD HH:mm) top line comment. no option false, option true
• -c --includecwd decide include cwd directory. no option true, option true
• -e --excludes [comma separated exclude directories] pass exclude directory. default exclude directory is ['@types', 'typings', '__test__', '__tests__']
• -i --fileexcludes [comma separated extname] pass exclude filename pattern. default exclude patterns is []
• -x --targetexts [comma separated extname] pass include extname. default extname is ['ts', 'tsx']. extname pass without dot character.
• -q --quote decide quote character. default quote character single quote
• -v --verbose display verbose log message. no option false, option true
• -w --withoutcomment remove create-ts-index comment that top of line in index.ts
• -b --withoutbackup Don't create backup file if already exists target file
• -o --output index.ts or entrypoint.ts filename change
• -d --includeDeclarationFiles pass declaration files (*.d.ts). default is false

Usage

library

Use TypeScritIndexWriter

1const tsiw = new TypeScritIndexWriter();
2const option = TypeScritIndexWriter.getDefaultOption('./src');
3
4(async () => {
5  await tsiw.create(option);
6
7  // or
8
9  await tsiw.createEntrypoint(option);
10})();

Use CommandModule

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

CLI

cli use git-style sub-command

• create
  • cti create index.ts file
• entrypoint
  • cti create webpack entrypoint
• init
  • create .ctirc file
• clean
  • cti clean index.ts file recursively

1# basic usage
2cti create ./src  # or cti create ./src
3## or
4cti entrypoint ./src  # or cti create ./src
5
6# without newline
7
8## create sub-command, create sub-command is a default command
9cti -n ./src
10cti create -n ./src
11
12## entrypoint sub-command
13cti entrypoint -n ./src
14
15# custom exclude directories
16cti create -n -e @types,typings,__test__,__tests__,pages ./src
17## or
18cti entrypoint -n -e @types,typings,__test__,__tests__,pages ./src
19
20# clean index.ts
21cti clean ./src  # or cti clean ./src
22
23# loop through every sub-directory in current path (thanks Mohsen)
24for f in *; do cti create ./$f; done
25
26# Pass variadic directories
27cti create ./src/server ./src/client ./src/module

CLI with .ctirc

create-ts-index cli support .ctirc configuration file. Available name is only .ctirc. .ctirc configuration file can applied by each target directories and script working directory. Every configuration overwrited same feature. Also cti cli arguments forced applied. And .ctirc file can write json5 format. json5 spec. can comment and more feature.

See below search, apply order.

1# execute on /Users/cti/github/create-ts-index
2sh> cti create ./example/type01
3
4# search configuration file on "/Users/cti/github/create-ts-index"
5# search configuration file on "/Users/cti/github/create-ts-index/example/type01"
6# apply configuration by "/Users/cti/github/create-ts-index"
7# apply configuration by "/Users/cti/github/create-ts-index/example/type01"
8# every configuration is overwrited 

.ctirc creation

You can use cli for .ctirc file creation.

1# create current directory
2> cti init
3
4# create multiple directory
5> cti init ./example/type03 ./example/type02

Language

• English
• Korean