Stratégie d'adoption progressive de TypeScript pour les projets front-end

La stratégie d'adoption progressive de TypeScript dans les projets front-end comprend généralement :

Présentation de TypeScript

Si nous avons un simple module JavaScript utils.js, qui contient une fonction permettant de calculer la somme de deux nombres :

// utils.js
export function add(a, b) {
    return a + b;
}

Tout d'abord, nous changeons l'extension du fichier en .ts et commençons à ajouter des annotations de type étape par étape :

// utils.ts
export function add(a: number, b: number): number {
    return a + b;
}

Configuration de tsconfig.json

Créez un tsconfig.json dans le répertoire racine du projet pour configurer le compilateur TypeScript :

{
// Specify the target ECMAScript version for compilation
"target": "es6",

// Specify the module system
"module": "esnext",

// Output directory, where the compiled files are stored
"outDir": "./dist",

// Whether to include source map files for debugging
"sourceMap": true,

// Enable strict type checking options
"strict": true,

// Allow default imports from modules that do not set default exports
"esModuleInterop": true,

// Ignore type checking for libraries
"skipLibCheck": true,

// Ensure consistent case for file names
"forceConsistentCasingInFileNames": true,

// Which files to include for compilation
"include": [
    "src/**/*.ts",
    "src/**/*.tsx" // If TypeScript's JSX is used in the project
],

// Which files or directories are excluded from compilation
"exclude": [
    "node_modules",
    "**/*.spec.ts" // Exclude test files
]
}

Éléments de configuration avancés

chemins : utilisé pour la configuration de l'alias de chemin afin de faciliter la gestion des chemins lors de l'importation de modules.

"paths": {
    "@components/*": ["src/components/*"]
}

baseUrl : définit le répertoire de base du projet. Lorsqu'il est utilisé avec des chemins, il peut fournir un chemin d'importation plus concis.

    "baseUrl": "./src"

resolveJsonModule : permet l'importation directe de fichiers JSON.

    "resolveJsonModule": true

lib : Spécifie la collection de fichiers de bibliothèque utilisée dans le projet, telle que ECMAScript, DOM, etc.

    "lib": ["es6", "dom"]

jsx : Si le projet utilise la syntaxe JSX, cette option doit être définie.

    "jsx": "react-jsx"

Configuration héritée

Si la structure de votre projet est complexe, vous aurez peut-être besoin de différentes configurations dans différents répertoires. Vous pouvez utiliser la propriété extends pour hériter d'un tsconfig.json de base :

// tsconfig.app.json in a subdirectory
{
    "extends": "../tsconfig.json",
    "compilerOptions": {
    // You can override or add application-specific compilation options here
    },
    // You can add or modify include and exclude here
}

Intégrer TypeScript dans le processus de construction

L'intégration de TypeScript dans le processus de construction implique généralement d'ajuster la configuration de l'outil de construction (tel que Webpack, Rollup ou Parcel). Et ajout des règles de traitement TypeScript dans le fichier de configuration.

npm install --save-dev typescript ts-loader webpack webpack-cli

webpack.config.js配置文件

const path = require('path');

module.exports = {
  entry: './src/index.ts', // Your entry file, usually index.ts
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist'),
  },
  resolve: {
    extensions: ['.ts', '.tsx', '.js', '.jsx'], // Add .ts and .tsx extensions
  },
  module: {
    rules: [
      {
        test: /\.tsx?$/,
        use: 'ts-loader',
        exclude: /node_modules/, // Exclude the node_modules directory
      },
    ],
  },
  devtool: 'source-map', // Generate source map for easy debugging during development
};

Dans tsconfig.json , assurez-vous d'avoir configuré le bon outDir pour qu'il corresponde au répertoire de sortie de Webpack :

{
  // ...
  "outDir": "./dist",
  // ...
}

Vous pouvez maintenant démarrer le processus de construction en exécutant la commande suivante à partir de la ligne de commande :

npx webpack

Cela compilera le code source TypeScript en JavaScript à l'aide de Webpack et ts-loader et le sortira dans le répertoire dist.

Si vous utilisez des scripts npm, vous pouvez ajouter un script de build à package.json :

{
  "scripts": {
    "build": "webpack"
  }
}

Ensuite, exécutez le build via npm run build.

Utilisation des définitions de types

Si vous utilisez des bibliothèques tierces dans votre projet, assurez-vous d'installer les packages de définition de type correspondants, tels que @types/lodash. Pour les bibliothèques sans définitions de types officielles, vous pouvez essayer les définitions fournies par la communauté ou écrire vos propres fichiers de déclaration.

1. Installez les packages de définition de type :

Les bibliothèques les plus populaires ont des packages de définition de type correspondants, généralement situés dans l'espace de noms @types. Par exemple, si vous utilisez lodash dans votre projet, vous pouvez exécuter la commande suivante pour installer ses définitions de type :

// utils.js
export function add(a, b) {
    return a + b;
}

Ou utilisez Yarn :

// utils.ts
export function add(a: number, b: number): number {
    return a + b;
}

2. Inférence de type automatique

Après avoir installé les définitions de type, le compilateur TypeScript reconnaîtra et utilisera automatiquement ces définitions de type. Vous n'avez pas besoin de les importer explicitement dans votre code, référencez simplement la bibliothèque normalement dans votre projet.

3. Définitions de types personnalisés

Si vous utilisez une bibliothèque qui n'a pas de définitions de type officielles, ou si les définitions de types officielles sont incomplètes, vous pouvez écrire votre propre fichier de déclaration de type (.d.ts). Généralement, ce fichier doit être placé au même emplacement que le fichier JavaScript de la bibliothèque, ou dans le répertoire types ou @types.

Par exemple, supposons qu'il existe une bibliothèque appelée customLib et que son fichier principal est customLib.js. Vous pouvez créer un fichier customLib.d.ts pour déclarer ses types :

{
// Specify the target ECMAScript version for compilation
"target": "es6",

// Specify the module system
"module": "esnext",

// Output directory, where the compiled files are stored
"outDir": "./dist",

// Whether to include source map files for debugging
"sourceMap": true,

// Enable strict type checking options
"strict": true,

// Allow default imports from modules that do not set default exports
"esModuleInterop": true,

// Ignore type checking for libraries
"skipLibCheck": true,

// Ensure consistent case for file names
"forceConsistentCasingInFileNames": true,

// Which files to include for compilation
"include": [
    "src/**/*.ts",
    "src/**/*.tsx" // If TypeScript's JSX is used in the project
],

// Which files or directories are excluded from compilation
"exclude": [
    "node_modules",
    "**/*.spec.ts" // Exclude test files
]
}

Ensuite, dans votre code, TypeScript reconnaîtra et utilisera ces types.

4. Définitions des types de communautés

Parfois, la communauté fournira des définitions de types non officielles. Vous pouvez le trouver dans le référentiel DefinitelyTyped (https://github.com/DefinitelyTyped/DefinitelyTyped) ou rechercher @types/library-name sur GitHub.

5. Limites des définitions de types

Bien que les définitions de types soient utiles pour améliorer la qualité du code, toutes les bibliothèques ne fournissent pas de définitions de types complètes, ou elles peuvent ne pas correspondre entièrement au comportement réel de la bibliothèque. Dans ce cas, vous devrez peut-être utiliser le commentaire any type ou // @ts-ignore dans votre code pour ignorer les vérifications de type spécifiques.

Intégration de l'EDI

Assurez-vous que votre IDE (tel que VSCode) dispose du plugin TypeScript installé pour obtenir la complétion du code, la vérification du type et d'autres fonctionnalités.

Migrer progressivement d'autres modules

Au fil du temps, vous pouvez progressivement convertir d'autres modules JavaScript en TypeScript. Par exemple, supposons qu'il existe un app.js, qui peut être converti de la même manière en app.ts et ajouter des annotations de type.

• Renommer app.js en app.ts. Cette étape marque que le module est officiellement entré dans l'environnement TypeScript.

• Ouvrez app.ts et commencez à ajouter des annotations de type aux variables, aux paramètres de fonction, aux valeurs de retour, etc. Cela aide le compilateur TypeScript à effectuer une vérification de type et à réduire les erreurs de type potentielles.
  

// utils.js
export function add(a, b) {
    return a + b;
}

• Pour les structures de données complexes, envisagez d'utiliser des interfaces (interface) ou des alias de type (type alias) pour définir des types afin d'améliorer la lisibilité et la maintenabilité du code.

// utils.ts
export function add(a: number, b: number): number {
    return a + b;
}

Renforcer la vérification de type

Une fois que votre équipe s'est habituée à TypeScript, vous pouvez progressivement activer des options de vérification de type plus strictes dans tsconfig.json, telles que strictNullChecks.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!