Як керувати проектами TypeScript за допомогою tsconfig

Ефективне керування проектами TypeScript має вирішальне значення для підтримки якості та узгодженості коду. Файл tsconfig.json є центральною частиною налаштування та керування проектами TypeScript. Це дозволяє розробникам вказувати різні параметри компілятора, включення файлів, виключення та багато іншого. Цей посібник пояснює, як використовувати tsconfig.json для ефективного керування проектами TypeScript.

Що таке tsconfig.json?

Файл tsconfig.json — це файл конфігурації, який використовується компілятором TypeScript (tsc), щоб визначити, як проект TypeScript має бути скомпільований. Він забезпечує стандартний спосіб визначення параметрів компілятора та файлів, які є частиною проекту. Коли файл tsconfig.json присутній у каталозі, він позначає цей каталог як кореневий для проекту TypeScript.

Створення файлу tsconfig.json

Щоб створити файл tsconfig.json, виконайте таку команду в терміналі:

tsc --init

Ця команда генерує файл tsconfig.json за умовчанням із набором попередньо визначених параметрів. Згенерований файл можна налаштувати відповідно до конкретних потреб проекту.

Розуміння основних властивостей tsconfig.json

Файл tsconfig.json містить кілька властивостей, які можна налаштувати для кращого керування проектом TypeScript. Ось деякі з найбільш часто використовуваних властивостей:

• compilerOptions: визначає параметри компілятора для проекту.
• include: визначає файли або каталоги, які будуть включені до проекту.
• exclude: вказує файли або каталоги, які потрібно виключити з проекту.
• files: визначає окремі файли, які будуть включені в проект.

Налаштування параметрів компілятора

Властивість compilerOptions ​​є найважливішим розділом у файлі tsconfig.json. Це дозволяє розробникам контролювати різні аспекти процесу компіляції. Нижче наведено деякі часто використовувані параметри компілятора:

{
  "compilerOptions": {
    "target": "ES6",               // Specifies the target JavaScript version
    "module": "commonjs",          // Specifies the module system
    "strict": true,                // Enables all strict type-checking options
    "outDir": "./dist",            // Redirects output structure to the directory
    "rootDir": "./src",            // Specifies the root directory of input files
    "esModuleInterop": true,       // Enables emit interoperability between CommonJS and ES Modules
    "forceConsistentCasingInFileNames": true // Disallows inconsistently-cased references to the same file
  }
}

Ці параметри можна налаштувати відповідно до вимог проекту. Наприклад, зміна target на ES5 виведе JavaScript, сумісний із старими браузерами.

Включення та виключення файлів

У проекті TypeScript важливо контролювати, які файли включаються чи виключаються під час компіляції. Для цієї мети використовуються властивості include і exclude у tsconfig.json.

{
  "include": ["src/**/*"],    // Includes all TypeScript files in the src folder
  "exclude": ["node_modules", "**/*.spec.ts"] // Excludes node_modules and all spec files
}

Наведена вище конфігурація включає всі файли TypeScript з каталогу src і його підкаталогів, виключаючи файли в каталозі node_modules ​​і файли з розширенням .spec.ts.

Використання файлів Property

Властивість files ​​використовується для включення окремих файлів у компіляцію. Це може бути корисним, коли потрібно скомпілювати лише певний набір файлів.

{
  "files": ["src/index.ts", "src/app.ts"]
}

У цьому прикладі буде скомпільовано лише файли index.ts ​​і app.ts ​​з каталогу src.

Розширення файлів tsconfig

TypeScript дозволяє розширювати інші файли tsconfig.json за допомогою властивості extends. Це корисно для спільного використання загальної базової конфігурації в кількох проектах або підпроектах.

{
  "extends": "./base.tsconfig.json",
  "compilerOptions": {
    "outDir": "./dist"
  }
}

У цьому прикладі поточний файл tsconfig.json розширює файл base.tsconfig.json і замінює параметр outDir.

Висновок

Керування проектами TypeScript за допомогою tsconfig.json забезпечує велику гнучкість і контроль над процесом компіляції. Розуміння та використання різних властивостей tsconfig.json, таких як compilerOptions, include, exclude і files , проектами TypeScript можна керувати більш ефективно та результативно. Можливість розширення tsconfig файлів також забезпечує кращу організацію проекту та можливість повторного використання.