tsconfig.json

Waarvoor dient tsconfig.json?

TypeScript is heel nuttig: het stelt ons bijvoorbeeld in staat om types toe te voegen aan gewone JavaScript code. Het controleert ook op syntaxfouten, nog voor het uitvoeren. Het biedt zelfs tooltips die je laten zien waarom sommige code een fout zou kunnen opleveren.

Er zijn zoveel geweldige functies die standaard worden meegeleverd. Zelfs met al deze geweldige functies erkent TypeScript de behoefte aan flexibiliteit.

Soms wilt je niet alle standaardregels die TypeScript probeert op te leggen - en dat is prima. Dat is een van de redenen waarom een tsconfig.json bestand nuttig is.

Laten we eens kijken hoe dit bestand eruit ziet en hoe het helpt.

Voorbeeld tsconfig.json en structuur

Het tsconfig.json bestand komt altijd in de hoofdmap van je project terecht. Jij bepaalt welke regels de TypeScript compiler moet handhaven. Hier zie je een voorbeeld tsconfig.json-bestand.

{
  "compilerOptions": {
    // Stel het doel in op ECMAScript 2017
    "target": "es2017",

    // Kies het moduleformaat als CommonJS
    "module": "commonjs",

    // Schakel strikte controle op nullwaarden in
    "strictNullChecks": true
  },

  // Specificeer welke TypeScript-bestanden moeten worden opgenomen
  "include": ["**/*.ts"]
}

In de JSON zijn er verschillende eigenschappen:

• "compilerOptions", dit is een genest object dat de regels bevat die de TypeScript compiler moet afdwingen.
  • "target", de waarde "es2017" betekent dat we onze code gaan transpileren naar de 2017 versie van EcmaScript standaarden voor JavaScript.
  • "module", welk moduleformaat de TypeScript-compiler moet gebruiken bij het genereren van de JavaScript-uitvoer. In dit geval dus "commonjs".
  • "strictNullChecks", variabelen kunnen alleen null of undefined zijn, als ze expliciet die waarden toegewezen hebben gekregen.
• "include" dat bepaalt op welke bestanden de compiler de regels toepast. In dit geval betekent ["*/.ts"] dat de compiler elk bestand met de extensie .ts moet transpileren.

Je hebt nu een idee van de regels die je kan toepassen, maar voor je eigen projecten kun je deze regels naar eigen voorkeur instellen! Het tsconfig.json bestand is perfect voor zowel individueel werk als voor teamprojecten, omdat het iedereen in staat stelt op dezelfde pagina te zitten over hoe hun code geschreven moet worden.

Gebruik

Een andere leuke toevoeging is dat door het toevoegen van een tsconfig.json bestand, je nu het commando tsc zonder argumenten in je terminal kunt gebruiken! De compiler zal automatisch uit je tsconfig.json bestand herkennen op welke specifieke bestanden hij moet draaien. Je kunt nog steeds specifieke bestanden opgeven zoals $ tsc fileName.ts als dat het enige bestand is dat de compiler moet controleren.

Documentatie

Bekijk TypeScript's compiler optie documentatie voor nog meer informatie.

Veel plezier met coderen!