tstf

CLI tools for useful TypeScript code transformations such as paths transforms

• Usage
• Commands

Usage

$ npm install -g tstf
$ tstf COMMAND
running command...
$ tstf (-v|--version|version)
tstf/0.0.24 darwin-x64 node-v13.13.0
$ tstf --help [COMMAND]
USAGE
  $ tstf COMMAND
...

Commands

• tstf genIndex
• tstf help [COMMAND]
• tstf relToAlias

tstf genIndex

generate index.ts file for all exported modules

USAGE
  $ tstf genIndex

OPTIONS
  -e, --exclude=exclude               files to exclude
  -h, --help                          show CLI help
  -o, --out=out                       (required) path to output file
  -q, --quote=single|double           [default: double] whether to use single or double quote
  -s, --src=src                       path to source files
  -v, --verbose=debug|log|warn|error  [default: log] logging verbosity
  -w, --write                         whether to write to output file

EXAMPLES
  $ tstf genIndex -o src/index.ts
  $ tstf genIndex -s src/**/*.ts -e src/**/*.test.ts -o src/exports.ts -q single -v debug -w

See code: dist/node/commands/genIndex.ts

tstf help [COMMAND]

display help for tstf

USAGE
  $ tstf help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

tstf relToAlias

transform relative paths to alias paths according to tsconfig.compilerOptions.paths

USAGE
  $ tstf relToAlias

OPTIONS
  -h, --help                          show CLI help
  -p, --project=project               [default: tsconfig.json] path to tsconfig.json
  -q, --quote=single|double           [default: double] whether to use single or double quote
  -v, --verbose=debug|log|warn|error  [default: log] logging verbosity
  -w, --write                         whether to save changes to source files

EXAMPLES
  $ tstf relToAlias
  $ tstf relToAlias -p ./path/to/tsconfig.json -q single -w -v debug

See code: dist/node/commands/relToAlias.ts