–help în TypeScript

Afișează ajutorul lui tsc: comenzile obișnuite și opțiunile principale; cu --all, toate opțiunile.

Sintaxă
tsc --help
tsc -h
tsc -?
tsc --help --all
tsc --all

Ce face --help

tsc --help (sau -h, -?) afișează un rezumat: cum se compilează un proiect, cum se creează tsconfig.json, cum se folosesc -b și -p, plus cele mai folosite opțiuni. Este o opțiune doar pentru linia de comandă; nu se scrie în tsconfig.json.

tsc --all (sau tsc --help --all) afișează toate opțiunile, grupate pe categorii (Modules, Emit, Type Checking…), cu tipul, valorile permise și valoarea implicită a fiecăreia. Este cel mai rapid mod de a afla ce acceptă versiunea de tsc instalată, fără să cauți pe internet.

Parametri

Parametru Descriere
--help, -h, -? Ajutorul scurt.
--all Lista completă de opțiuni.

Exemple

Exemplul 1: Începutul ajutorului

Primele rânduri din tsc --help arată comenzile cele mai des folosite.

npx tsc --help

Rezultat (tsc 5.9)

$ npx tsc --help | head -25
tsc: The TypeScript Compiler - Version 5.9.3

COMMON COMMANDS

  tsc
  Compiles the current project (tsconfig.json in the working directory.)

  tsc app.ts util.ts
  Ignoring tsconfig.json, compiles the specified files with default compiler options.

  tsc -b
  Build a composite project in the working directory.

  tsc --init
  Creates a tsconfig.json with the recommended settings in the working directory.

  tsc -p ./path/to/tsconfig.json
  Compiles the TypeScript project located at the specified path.

  tsc --help --all
  An expanded version of this information, showing all possible compiler options

  tsc --noEmit
  tsc --target esnext
  Compiles the current project, with additional settings.

Exemplul 2: Toate opțiunile

--all are mult mai multe intrări. Pentru fiecare opțiune afișează tipul și valoarea implicită, de exemplu pentru --strict.

npx tsc --all

Rezultat (tsc 5.9)

$ npx tsc --all | grep -c '^--'
138
$ npx tsc --help | grep -c '^--'
26

$ npx tsc --all | grep -A3 '^--strict$'
--strict
Enable all strict type-checking options.
type: boolean
default: false

Greșeli frecvente

  • Să cauți documentația unei opțiuni pentru altă versiune de TypeScript. tsc --all arată exact ce știe tsc-ul din proiect.

Comenzi înrudite

  • --version: Afișează versiunea compilatorului TypeScript folosit.
  • --init: Creează un fișier tsconfig.json nou, cu setările recomandate de versiunea curentă de TypeScript.
  • --showConfig: Afișează configurația finală (cu extends rezolvat și opțiunile deduse) și lista de fișiere, fără să compileze.