paint-brush
Comment migrer un projet React de JavaScript vers TypeScriptpar@leandronnz
7,585 lectures
7,585 lectures

Comment migrer un projet React de JavaScript vers TypeScript

par Leandro Nuñez24m2023/10/19
Read on Terminal Reader

Trop long; Pour lire

La migration d'un projet React de Javascript vers TypeScript n'est pas une simple « recherche et remplacement » de fichiers .js par .tsx. Il s'agit d'une démarche stratégique qui implique l'apprentissage de nouvelles conventions, une compréhension approfondie des types et, surtout, un changement dans notre façon de penser la fiabilité et la cohérence de notre code. Voici quelques remarques : Filet de sécurité : TypeScript a introduit une couche de sécurité dans notre projet, détectant les erreurs avant qu'elles ne causent des ravages au moment de l'exécution. Ce filet de sécurité, une fois que vous vous y êtes habitué, change la donne en termes de confiance dans votre code et de vitesse de développement globale. Communication plus claire : avec les types, notre code communique désormais plus explicitement. Qu'il s'agisse de vous revisitant votre code ou d'un nouveau membre de l'équipe essayant de comprendre vos structures de composants, TypeScript sert de couche de documentation supplémentaire. Confiance en matière de refactorisation : vous avez peur du refactoring ? Eh bien, TypeScript vous soutient. Avec des types garantissant des contrats dans votre code, de nombreuses erreurs potentielles sont détectées lors des phases de refactoring, ce qui rend le processus moins intimidant. Communauté et écosystème : l'adoption de TypeScript ouvre les portes d'un écosystème prospère. Des bibliothèques typées sur DefinitelyTyped au support sans fin sur les forums communautaires et à l'intégration plus rationalisée de packages tiers, vous êtes en bonne compagnie. Courbe d'apprentissage : Oui, TypeScript introduit une courbe d'apprentissage. Il y a probablement eu des moments de frustration, des confusions autour des types et des interfaces, ou des luttes avec le compilateur. Mais revenez sur votre parcours et vous verrez à quel point vous comprenez mieux votre code et son comportement maintenant.
featured image - Comment migrer un projet React de JavaScript vers TypeScript
Leandro Nuñez HackerNoon profile picture
0-item


Table des matières

  • Introduction

  • Pourquoi migrer ? Comprendre les avantages

  • Avant de commencer : prérequis

  • Lancement de la migration : configuration de TypeScript dans votre projet

  • Refactorisation des composants React

  • API de gestion d'état et de contexte

  • Opérations de routage et asynchrones

  • Test en TypeScript

  • Gestion des packages non TypeScript

  • Meilleures pratiques et pièges courants

  • Conclusion

  • Ressources additionnelles



Introduction

Salut, amis développeurs ! C'est passionnant de vous voir ici, prêt à explorer la transition de JavaScript vers TypeScript dans nos projets React.


Maintenant, si vous avez travaillé avec JavaScript, vous savez que c'est comme cette vieille paire de chaussures confortables : un peu usées, parfois imprévisibles, mais familières. TypeScript, cependant, c'est comme obtenir une mise à niveau de chaussure avec des semelles intérieures personnalisées ; c'est la même expérience de marche mais avec un soutien supplémentaire.


Alors, quel est tout le buzz autour de TypeScript ?


Eh bien, il s'agit essentiellement de JavaScript mais avec une bonne dose de fonctionnalités supplémentaires, la plus importante étant la vérification de type.


Imaginez que le codage sans ces embêtantes erreurs undefined is not a function qui apparaît à l'improviste. C'est le genre de paix que TypeScript apporte dans votre vie.


Dans ce guide, nous expliquons le pourquoi et le comment de l'intégration de TypeScript dans votre projet React.


Pourquoi réagir ? Parce que c'est génial et qu'on adore ça, évidemment. Mais aussi, la combinaison de l'approche basée sur les composants de React avec les fonctionnalités de vérification de type de TypeScript permet une expérience de codage très efficace et agréable.


Voici un aperçu de ce à quoi ressemble l'ajout de TypeScript à un projet. Dans un composant JavaScript typique, vous auriez :

 // JavaScript way function Greeting({ name }) { return <h1>Hello, {name}</h1>; }


Avec TypeScript, nous introduisons un moyen de garantir name est toujours traité comme une chaîne :

 // TypeScript style type Props = { name: string; }; function Greeting({ name }: Props) { return <h1>Hello, {name}</h1>; }


Remarquez la pièce type Props ?


C'est la manière de TypeScript de dire : "Hé, je regarde ; tu ferais mieux de t'assurer que name est une chaîne !" C'est un changement simple avec de profondes implications. Vous disposez désormais d'un ange gardien qui prévient activement les bogues liés au type, rendant votre code plus robuste et prévisible.


Mais ce n'est qu'un tout petit aperçu. Il existe tout un monde d'avantages et de pratiques avec TypeScript que nous présenterons dans ce guide complet. De la configuration de votre environnement à la refactorisation des composants et des accessoires, en passant par les meilleures pratiques pour éviter les pièges courants, nous avons beaucoup de choses à couvrir. Alors, attachez votre ceinture et mettons ce spectacle en route !




Pourquoi migrer ? Comprendre les avantages

Si vous envisagez de passer de JavaScript à TypeScript, en particulier dans vos projets React , vous n'êtes pas le seul à vous demander : « Est-ce que cela en vaut vraiment la peine ? La transition du langage d'un projet entier n'est pas une mince affaire ; cela nécessite des efforts, un apprentissage et, au début, un peu de productivité ralentie. Alors, pourquoi les développeurs font-ils ce changement ? Décomposons les raisons impérieuses.


1. Détectez les erreurs plus tôt : vérification de type statique

La fonctionnalité principale de TypeScript est son système de types statiques. Contrairement à JavaScript, qui est typé dynamiquement, TypeScript vous permet de spécifier des types pour vos variables, paramètres de fonction et valeurs renvoyées. Quel est l'avantage ? Les erreurs sont détectées pendant le développement, bien avant que le code ne soit proche de la production.


Prenons un exemple simple :

 // In JavaScript function createGreeting(name) { return `Hello, ${name}`; } // You might not catch this typo until runtime const greeting = createGreeting(123); console.log(greeting); // "Hello, 123" - Wait, that's not right!


Voyons maintenant comment TypeScript aide :

 // In TypeScript function createGreeting(name: string): string { return `Hello, ${name}`; } // TypeScript will flag this immediately - '123' is not a string! const greeting = createGreeting(123);


Avec TypeScript, ce bug d'apparence innocente aurait été détecté instantanément, garantissant que vous êtes conscient de l'incident au moment où il se produit. De cette façon, la boucle de rétroaction est raccourcie et vous n'avez pas à vous gratter la tête en regardant des bugs étranges dans votre environnement de production.


2. Améliorer la qualité et la compréhensibilité du code

L'application de la saisie par TypeScript signifie que tout autre développeur (ou même futur vous) peut comprendre en un coup d'œil quel type de données une fonction attend et ce qu'elle renvoie. Cette clarté rend les bases de code plus lisibles et auto-documentées.


Imaginez tomber sur une fonction JavaScript écrite par un collègue :

 function calculateTotal(items) { // ... complicated logic ... }


Vous devrez probablement parcourir la fonction ou trouver où elle est utilisée pour comprendre quels items devraient être. Avec TypeScript, c'est immédiatement clair :

 type Item = { price: number; quantity: number; }; // Now we know exactly what to expect! function calculateTotal(items: Item[]): number { // ... complicated logic ... }


3. Prise en charge améliorée de l'éditeur

TypeScript élève l'expérience du développeur à un nouveau niveau en améliorant les éditeurs de texte et les IDE avec une saisie semi-automatique, une refactorisation et un débogage améliorés. Cette intégration est possible car TypeScript peut partager sa compréhension de votre code avec votre éditeur.

Vous en ferez l'expérience lorsque vous verrez votre éditeur suggérer des noms de méthodes, fournir des informations sur les paramètres de fonction ou vous avertir d'une utilisation incorrecte des fonctions. C'est comme avoir un copilote qui aide à naviguer dans le code avec un niveau de sécurité supplémentaire.


4. Collaboration plus facile

Dans un environnement d'équipe, TypeScript brille en aidant à appliquer certaines normes et structures dans la base de code. Lorsque plusieurs développeurs contribuent à un projet, les règles strictes de TypeScript garantissent que tout le monde adhère aux mêmes directives de codage, rendant ainsi la collaboration plus fluide. Il s'agit d'un langage commun qui parle de « qualité et cohérence » à tous les niveaux.


5. Pérennisez votre code pour l'avenir

JavaScript évolue et TypeScript vise à être au courant des dernières fonctionnalités. En utilisant TypeScript, vous pouvez commencer à tirer parti de la nouvelle génération de fonctionnalités JavaScript avant qu'elles ne soient adoptées par le grand public, garantissant ainsi que votre projet reste moderne et avant-gardiste.


En conclusion, migrer vers TypeScript ne consiste pas seulement à détecter les erreurs plus tôt ; il s'agit d'une amélioration globale de votre processus de codage. Qu'il s'agisse d'une meilleure collaboration d'équipe ou de la pérennité de vos projets, TypeScript fournit une base solide pour créer des applications fiables, évolutives et maintenables.


Faire le changement peut sembler intimidant au début, mais avec les avantages présentés ci-dessus, il est clair pourquoi TypeScript est devenu un favori pour de nombreux développeurs du monde entier. Prêt à plonger ? Allons-y !



Avant de commencer : prérequis

Très bien, vous êtes donc tous prêts à passer à TypeScript avec votre projet React ? Excellente décision !


Mais avant de nous lancer dans le processus proprement dit, nous devons nous assurer que certains éléments sont en place.

Considérez ceci comme notre étape de préparation, où nous préparons tous nos outils pour que le processus de transition soit aussi fluide que du beurre.


Voici ce que vous devez préparer :

1. Projet React existant

Tout d’abord, vous avez besoin d’un projet React existant. Ce projet doit être un projet avec lequel vous êtes à l'aise pour expérimenter ; bien que le processus de migration soit assez simple, vous souhaiterez le faire dans un espace où il est acceptable de créer des dégâts temporaires.


 // Here's a simple React functional component in your project export default function Greeting({ name }) { return <h1>Hello, {name}!</h1>; }


Ce composant est un bon point de départ : il est fonctionnel, il est propre et nous pouvons voir ce qui se passe d'un seul coup d'œil.

2. Compréhension de base de TypeScript

Vous n'avez pas besoin d'être un gourou de TypeScript, mais comprendre les bases rendra cette transition beaucoup plus facile.


Savoir définir des types, des interfaces et connaître la différence entre type et interface .

Un peu de devoirs suffit, croyez-moi.


 // A sneak peek into TypeScript syntax type Props = { name: string; // defining the 'name' expected to be a string }; // Your component in TypeScript would look like this import React, { FC } from 'react'; interface GreetingProps { name: string; } const Greeting: FC<GreetingProps> = ({ name }) => { return <h1>Hello, {name}!</h1>; } export default Greeting;


Regarde la différence? Nous sommes désormais explicites sur ce que Greeting attend, rendant notre composant plus prévisible et plus facile à utiliser.


3. Nœud et NPM/Fil

Node.js doit être installé sur votre environnement de développement car nous allons utiliser npm ou yarn pour gérer nos packages. Cette exigence est une évidence puisque vous travaillez avec React, mais cela ne fait aucun mal de s'en assurer, n'est-ce pas ?


 # Check if Node is installed node --version # Check if npm is installed npm --version # Or for yarn yarn --version


Votre terminal devrait vous montrer les versions actuelles de ces outils, confirmant qu'ils sont tous configurés et prêts à fonctionner.


4. Éditeur de code

Vous aurez besoin d'un éditeur de code capable de bien gérer TypeScript. Visual Studio Code est un favori du public car il intègre une prise en charge robuste de TypeScript, ce qui rend le processus de développement plus fluide grâce à la complétion intelligente du code et à la mise en évidence des erreurs.


5. Contrôle des versions

Cette étape n’est pas obligatoire, mais elle est intelligente. Assurez-vous que votre projet actuel est sous contrôle de version avec git. Si quelque chose tourne mal (même si nous essaierons de nous assurer que ce n'est pas le cas), vous pouvez toujours revenir à une version précédente sans perdre le sommeil.


 # Check if git is installed git --version # If not, you need to initialize version control before proceeding git init git add . git commit -m "Pre-TypeScript commit"


Disposer de ce filet de sécurité signifie que vous pouvez expérimenter en toute confiance, sachant que votre dos est couvert.


Voilà pour nos prérequis ! Vous avez le projet, mis à jour du TypeScript, votre environnement est prêt et votre filet de sécurité est en place.


Nous sommes désormais prêts à nous lancer dans le processus de migration. Lançons le bal !



Lancement de la migration : configuration de TypeScript dans votre projet Refactoring React Components

Très bien, passons à la phase suivante !


Nous avons préparé le terrain avec TypeScript, mais maintenant nous devons nous salir les mains.


Il est temps de refactoriser nos composants React. Cette étape implique un peu plus que la simple modification des extensions de fichiers ; nous devons mettre à jour le code de nos composants pour utiliser les fonctionnalités de TypeScript pour une expérience de codage plus robuste et sans erreur.

Allons-y !


1. Modification des extensions de fichiers

Tout d’abord, renommons nos fichiers de composants. Ce processus implique de changer l'extension de .js en .tsx pour les fichiers contenant du code JSX.


Voici comment vous pouvez le faire en masse dans le répertoire source de votre projet à partir de la ligne de commande :

 # For Unix-like shells, navigate to your source folder and run: find . -name "*.js" -exec bash -c 'mv "$0" "${0%.js}.tsx"' {} \; # If you're using PowerShell (Windows), navigate to your source folder and run: Get-ChildItem -Filter *.js -Recurse | Rename-Item -NewName { $_.Name -replace '\.js$','.tsx' }


Ces commandes recherchent tous les fichiers .js dans le répertoire source de votre projet et les renomment en .tsx . C'est comme dire à vos fichiers : "Bienvenue dans le monde TypeScript !"


2. Saisir vos composants

Une fois nos fichiers renommés, abordons le code. Nous allons commencer par un simple composant fonctionnel en JavaScript :

 // Before: MyComponent.js import React from 'react'; function MyComponent({ greeting }) { return <h1>{greeting}, world!</h1>; }


Maintenant, refactorisons ceci pour utiliser TypeScript :

 // After: MyComponent.tsx import React, { FC } from 'react'; // Define a type for the component props interface MyComponentProps { greeting: string; } // Use the 'FC' (Functional Component) generic from React, with our props type const MyComponent: FC<MyComponentProps> = ({ greeting }) => { return <h1>{greeting}, world!</h1>; }


Qu'avons-nous fait ici ?


Nous avons défini une interface MyComponentProps pour décrire les accessoires de notre composant, garantissant ainsi la sécurité des types. En disant que greeting est une chaîne, TypeScript nous criera dessus si nous essayons de transmettre, par exemple, un nombre à la place. Nous avons également utilisé le type FC (abréviation de Functional Component ) à partir des définitions de type de React, en nous assurant que TypeScript sait qu'il s'agit d'un composant React.


3. Taper fortement useState et useEffect

Améliorons davantage nos composants en ajoutant des types aux états et aux effets, caractéristiques communes des composants fonctionnels.


Voici un composant avec un état et un effet :

 // Before: Counter.js import React, { useState, useEffect } from 'react'; function Counter() { const [count, setCount] = useState(0); useEffect(() => { document.title = `You clicked ${count} times`; }); return ( <div> <p>You clicked {count} times</p> <button onClick={() => setCount(count + 1)}> Click me </button> </div> ); }


Saupoudrons un peu de magie TypeScript là-dessus :

 // After: Counter.tsx import React, { useState, useEffect, FC } from 'react'; const Counter: FC = () => { // Declare the 'count' state variable with TypeScript const [count, setCount] = useState<number>(0); useEffect(() => { document.title = `You clicked ${count} times`; }); return ( <div> <p>You clicked {count} times</p> <button onClick={() => setCount(prevCount => prevCount + 1)}> Click me </button> </div> ); }


Dans notre composant refactorisé, nous avons explicitement dit à TypeScript d'attendre un number pour notre état count .


Ce détail évite les bogues embêtants où nous pourrions accidentellement nous retrouver avec une chaîne, un objet ou, Dieu nous en préserve, null au lieu de notre nombre attendu.


Et voilà !


Nous avons refactorisé avec succès nos composants React pour utiliser TypeScript. En tapant explicitement nos composants, états et accessoires, nous créons une base de code plus prévisible et plus facile à maintenir. Nous ne faisons pas que coder ; nous créons un chef-d'œuvre avec la précision qu'il mérite.


Ensuite, nous approfondirons des scénarios plus complexes et découvrirons comment TypeScript vient à notre secours !



API de gestion d'état et de contexte

Passons maintenant au vif du sujet de la gestion des états dans React avec TypeScript. Si vous avez utilisé l'API Context dans un projet JavaScript, vous savez qu'il s'agit d'une fonctionnalité puissante permettant de transmettre des données via l'arborescence des composants sans avoir à transmettre manuellement des accessoires à chaque niveau. Dans TypeScript, nous bénéficions de l’avantage supplémentaire d’un typage strict, ce qui rend nos données contextuelles encore plus robustes et prévisibles.


Prêt à vous lancer ? Allons-y!


1. Création d'un contexte typé

Tout d'abord, nous allons créer un nouveau contexte avec TypeScript. Ce contexte garantira que toute valeur par défaut, valeur de fournisseur ou composant consommateur correspond à notre type attendu.


Voici comment définir un contexte de base en JavaScript :

 // Before: DataContext.js import React, { createContext, useState } from 'react'; export const DataContext = createContext(); export const DataProvider = ({ children }) => { const [data, setData] = useState(null); return ( <DataContext.Provider value={{ data, setData }}> {children} </DataContext.Provider> ); };


Maintenant, tapons ce contexte en utilisant TypeScript :

 // After: DataContext.tsx import React, { createContext, useState, FC, ReactNode } from 'react'; // First, we define a type for our context's state interface DataContextState { data: any; // Tip: Replace 'any' with the expected type of 'data' setData: (data: any) => void; // And here too, replace 'any' with the actual expected type } // We ensure our createContext() call is typed with the above interface export const DataContext = createContext<DataContextState | undefined>(undefined); // Now, let's create a provider component export const DataProvider: FC<{children: ReactNode}> = ({ children }) => { const [data, setData] = useState<any>(null); // Again, consider replacing 'any' with your actual data type // The context provider now expects a value that matches 'DataContextState' return ( <DataContext.Provider value={{ data, setData }}> {children} </DataContext.Provider> ); };


Ce que nous avons fait ici, c'est créer une interface TypeScript, DataContextState , qui tape strictement nos données contextuelles. Nous avons également tapé la fonction createContext et le composant DataProvider , garantissant que tout, des variables d'état aux valeurs de contexte, s'aligne sur nos types définis.


2. Utilisation du contexte typé

Maintenant que nous avons notre DataContext typé, voyons comment nous pouvons l'utiliser dans un composant.


Nous devrons utiliser le hook useContext , et voici comment procéder :

 // ComponentUsingContext.tsx import React, { useContext, FC } from 'react'; import { DataContext } from './DataContext'; const ComponentUsingContext: FC = () => { // Here we're telling TypeScript to expect 'DataContextState' from our context const { data, setData } = useContext(DataContext) ?? {}; // This function would update the context state, triggering re-renders in consuming components const handleUpdateData = () => { const newData = { message: "Hello, TypeScript!" }; // This should match the structure of your data type setData(newData); }; return ( <div> <pre>{JSON.stringify(data, null, 2)}</pre> <button onClick={handleUpdateData}>Update Data</button> </div> ); };


Dans ComponentUsingContext , nous accédons au contexte et nous attendons que TypeScript valide que la valeur s'aligne sur DataContextState . Notre fonction handleUpdateData montre comment vous pouvez mettre à jour l'état partagé : tous les composants consommant DataContext seraient restitués avec les nouvelles données lorsque setData est appelé.


En utilisant TypeScript avec l'API Context, nous sommes assurés que notre gestion des états partagés est cohérente dans toute l'application. Le compilateur détecte toute divergence entre ce que notre contexte fournit et ce qu'attendent nos composants. Cette synergie rend notre code plus fiable et notre processus de développement plus fluide, nous permettant d'éviter des catégories entières de bugs que nous pourrions autrement rencontrer.


Continuez votre bon travail et n'oubliez pas qu'un peu de saisie permet d'économiser beaucoup de débogage plus tard !



Tests de routage et d'opérations asynchrones dans TypeScript >

Maintenant que nous avons vu comment TypeScript améliore divers aspects de notre application React, il est temps de parler d'un autre domaine critique : les tests.


Les tests sont fondamentaux pour garantir que notre application fonctionne comme prévu, et TypeScript peut rendre nos tests plus fiables et efficaces. Voyons comment TypeScript joue un rôle dans les tests, en particulier dans un projet React.


1. Préparer le terrain pour les tests

Avant d'entrer dans le code, assurez-vous que les bibliothèques nécessaires sont installées pour les tests dans un projet React. Voici une configuration rapide avec la bibliothèque de tests Jest et React, largement utilisées ensemble pour tester les applications React :

 npm install --save-dev jest @types/jest @testing-library/react @testing-library/jest-dom


Ces bibliothèques fournissent un environnement robuste pour l’écriture de tests unitaires et d’intégration. Considérons maintenant un scénario réel pour plus de clarté.


2. Scénario de test dans le monde réel : composant de message d'accueil de l'utilisateur

Imaginez que nous ayons un composant simple dans notre application qui accueille les utilisateurs en fonction de l'heure de la journée. C'est un composant fonctionnel qui prend le nom de l'utilisateur comme accessoire et l'heure actuelle comme état.


Voici à quoi pourrait ressembler notre composant UserGreeting :

 // UserGreeting.tsx import React, { FC, useState, useEffect } from 'react'; interface UserGreetingProps { name: string; } const UserGreeting: FC<UserGreetingProps> = ({ name }) => { const [currentHour, setCurrentHour] = useState(new Date().getHours()); const [greeting, setGreeting] = useState(''); useEffect(() => { // Determine the time of day and set the appropriate greeting if (currentHour < 12) { setGreeting('Good morning'); } else if (currentHour < 18) { setGreeting('Good afternoon'); } else { setGreeting('Good evening'); } }, [currentHour]); return ( <div> <h1>{greeting}, {name}!</h1> </div> ); } export default UserGreeting;


Nous devons maintenant écrire des tests pour garantir que notre composant se comporte comme prévu dans différentes conditions. Nos cas de test confirmeront que le message d'accueil approprié est affiché en fonction de l'heure de la journée.


Voici comment nous pouvons écrire ces tests à l'aide de la bibliothèque de tests Jest et React :

 // UserGreeting.test.tsx import React from 'react'; import { render, screen } from '@testing-library/react'; import UserGreeting from './UserGreeting'; describe('UserGreeting Component', () => { // Mock date for consistent testing const originalDate = Date; beforeAll(() => { const mockDate = new Date(2023, 10, 17, 14); // 2:00 PM global.Date = jest.fn(() => mockDate) as any; }); afterAll(() => { global.Date = originalDate; // Restore original Date object }); it('displays the correct greeting for the afternoon', () => { render(<UserGreeting name="Jordan" />); // Assert the greeting based on the mocked time of day expect(screen.getByText('Good afternoon, Jordan!')).toBeInTheDocument(); }); // Additional tests would repeat this process for other times of day, // ensuring our component behaves consistently. });


Dans ce script, nous rendons notre composant avec une heure définie (simulée à 14h00) et vérifions s'il affiche "Bon après-midi" comme prévu. Nous pouvons écrire davantage de tests à d’autres moments de la journée (matin, soir) pour garantir que notre composant est entièrement couvert.


Grâce à TypeScript, nous nous assurons que les accessoires que nous transmettons à nos composants dans nos tests correspondent aux types attendus. De cette façon, nous évitons de rencontrer des problèmes avec des accessoires incorrects qui pourraient conduire à des faux négatifs dans nos tests, garantissant ainsi que nos tests sont robustes et fiables.


L'utilisation de TypeScript lors des tests permet de détecter les problèmes dès le début du processus de développement, rendant ainsi nos applications plus robustes et plus faciles à maintenir. C'est une situation gagnant-gagnant ! N'oubliez pas que des tests cohérents et complets sont la marque d'un développement logiciel de haute qualité. Continuez comme ça!




Gestion des packages non TypeScript

Très bien, abordons un domaine qui fait souvent trébucher les gens lorsqu'ils passent à TypeScript dans un projet React : gérer les bibliothèques et les packages JavaScript qui ne sont pas écrits en TypeScript. C'est un scénario courant ; votre projet TypeScript est opérationnel, puis vous installez un package tiers, pour constater que votre compilateur TypeScript se plaint. Ne t'inquiète pas; il y a des solutions.


1. Rencontrer le problème

Voici un scénario typique : vous essayez d'utiliser un package qui ne prend pas en charge TypeScript par défaut, et le compilateur TypeScript commence à générer des erreurs telles que "Impossible de trouver un fichier de déclaration pour le module 'nom-module'." Semble familier?


Ce problème se pose car TypeScript s'appuie sur des définitions de types pour comprendre la structure des bibliothèques et des packages. Si ces définitions de types manquent, TypeScript se perd un peu. Mais n’ayez crainte, nous avons des stratégies pour gérer cela.

2. Utiliser DefinitelyTyped

L'une des premières choses que vous pouvez faire est de vérifier si la communauté a fourni des définitions de type pour le package via DefinitelyTyped. DefinitelyTyped est un référentiel massif de définitions de types maintenu par la communauté.


Voici comment vérifier et utiliser les types de DefinitelyTyped :


  1. Recherchez les définitions de type pour votre package en essayant de les installer à l'aide de npm. Les définitions de types sur DefinitelyTyped sont généralement préfixées par @types/ .
 npm install @types/package-name


Par exemple, si vous utilisiez la bibliothèque lodash , vous exécuteriez :

 npm install @types/lodash


  1. Après l'installation, vous n'avez pas besoin d'importer explicitement les types n'importe où dans votre projet. TypeScript les détectera et les utilisera automatiquement, vous permettant d'importer et d'utiliser des bibliothèques comme d'habitude, et d'obtenir la saisie semi-automatique et la vérification de type.


Mais que se passe-t-il si aucune définition de type n'est disponible sur DefinitelyTyped ?


3. Créer votre propre dossier de déclaration

Si DefinitelyTyped ne dispose pas des définitions de type dont vous avez besoin, il est temps de créer un fichier de déclaration personnalisé. Bien que cette approche nécessite plus d'efforts, elle garantit que votre projet TypeScript fonctionne correctement avec la bibliothèque JavaScript.


Voici une version simplifiée de ce que vous pourriez faire :


  1. Créez un nouveau fichier avec une extension .d.ts dans le répertoire source (ou types ) de votre projet. Cela pourrait être quelque chose comme declarations.d.ts .


  2. Dans ce fichier, vous souhaiterez déclarer le module et éventuellement décrire la structure de base que vous attendez de la bibliothèque. Par exemple:

 // This is a simplistic type declaration file for a hypothetical package. // We declare the module so TypeScript recognizes it. declare module 'name-of-untyped-package' { // Below, we're declaring a very basic structure. It's saying // there's a function we're expecting to exist, which returns any. // Ideally, you'd want to flesh this out with more specific types // if you know them or as you learn more about the library. export function functionName(arg: any): any; // You can continue to define the shapes of other functions or variables // you expect to exist within the package. The more detailed you are here, // the more helpful your type checking will be. }


Ce fichier de déclaration fait maison ne sera pas aussi complet qu'un ensemble complet de définitions de types, mais il indique à TypeScript : "Faites-moi confiance, je sais que ce module existe et qu'il fournit ces fonctions/variables." À partir de là, vous pouvez élaborer des définitions plus détaillées selon vos besoins.


N'oubliez pas que gérer des packages non TypeScript peut être un peu un obstacle, mais ces stratégies garantissent que votre projet TypeScript reste robuste et bénéficie de la sécurité et de la prévisibilité des types que nous recherchons. Tout dépend de cette confiance dans votre base de code !



Meilleures pratiques et pièges courants

Passer à TypeScript dans votre projet React ne consiste pas seulement à modifier les extensions de fichiers et à ajouter des annotations de type. Il s'agit également d'adapter votre état d'esprit et vos pratiques de développement pour tirer le meilleur parti de ce que propose TypeScript tout en évitant les obstacles courants. Discutons donc de quelques bonnes pratiques et des pièges courants que vous pourriez rencontrer au cours de ce voyage.

1. Meilleures pratiques

1.1 S'appuyer sur l'inférence de type

Même s'il peut être tentant de tout annoter, l'un des points forts de TypeScript réside dans son inférence de type. Il est souvent inutile d'ajouter des types explicites à chaque élément de votre code.

 // Instead of this: let x: number = 0; // You can rely on type inference: let x = 0; // TypeScript knows this is a number

La sur-annotation peut rendre votre code verbeux sans ajouter de valeur. Faites confiance à TypeScript pour déduire des types là où cela est possible.

1.2 Adopter les types d'utilitaires

Les types d’utilitaires offrent des moyens flexibles de gérer les types dans divers scénarios. Ils peuvent vous épargner beaucoup d’efforts et rendre la gestion de vos caractères plus efficace.

 // Example of using Partial to make all properties in an object optional function updateProfile(data: Partial<UserProfile>) { // function implementation } // Now you can pass only the parts of UserProfile you need to update updateProfile({ username: "newUserName" }); // This is valid

Partial , Readonly , Pick et d'autres types d'utilitaires peuvent être incroyablement pratiques.

1.3 Utiliser des énumérations pour les ensembles de constantes connus

Lorsque vous disposez d'une propriété qui ne peut prendre que des valeurs spécifiques, l'utilisation enum peut clarifier votre intention tout en fournissant une validation sur ces valeurs.

 enum UserRole { Admin = 'ADMIN', User = 'USER', Guest = 'GUEST', } // Now UserRole can only be one of the values defined in the enum function assignRole(role: UserRole) { // function implementation }

1.4 Préférer les interfaces pour la définition de la structure des objets

Bien que type et interface puissent souvent être utilisés de manière interchangeable, l'utilisation interface pour définir la structure des objets ou des classes rend votre code plus lisible et fournit de meilleurs messages d'erreur.

 interface UserProfile { username: string; email: string; // More properties... }


2. Pièges courants

2.1 Abuser any

L'utilisation any annule les avantages de TypeScript en contournant la vérification de type. Même si cela peut sembler une solution rapide, cela rend votre code moins sûr et moins prévisible.

 // Try to avoid this: let userData: any = fetchData(); // Instead, define a type for the data you expect: let userData: UserProfile = fetchData();

2.2 Ignorer les avertissements du compilateur

Les avertissements du compilateur TypeScript sont là pour vous aider. Les ignorer peut entraîner les mêmes types de bogues et de problèmes que vous essayez d'éviter en utilisant TypeScript.

2.3 Se perdre dans des types complexes

Parfois, pour tenter de rendre les types précis, les développeurs créent des définitions de types incroyablement complexes, difficiles à comprendre et à maintenir. Si vos types deviennent alambiqués, il est peut-être temps de simplifier ou de refactoriser votre code.

2.4 Oublier les types de bibliothèques tierces

Si vous utilisez des bibliothèques tierces, vérifiez toujours s'il existe des types TypeScript existants sur DefinitelyTyped. Ne pas le faire peut signifier passer à côté des fonctionnalités de sécurité de type pour ces bibliothèques.

En conclusion, adopter TypeScript, c’est bien plus que simplement utiliser une nouvelle syntaxe ; il s'agit d'adopter de nouvelles pratiques qui permettent d'éviter les erreurs, de rendre le code plus lisible et d'améliorer la maintenance. Évitez les pièges courants et n'oubliez pas que l'objectif est d'écrire un code plus propre, plus fiable et plus maintenable !




Conclusion

Eh bien, les amis, nous avons atteint la fin de notre parcours de migration vers TypeScript. Ça a été toute une aventure, n'est-ce pas ? Nous avons commencé par la grande question du « pourquoi » et nous sommes plongés dans le vif du sujet du passage d'un projet React de JavaScript à TypeScript. De la configuration de votre environnement TypeScript à la refactorisation des composants, en passant par la gestion des états, la gestion des itinéraires et même la gestion de ces embêtants packages non TypeScript, nous avons couvert beaucoup de terrain.


En réfléchissant à ce parcours, il est clair que la migration vers TypeScript n'est pas une simple « recherche et remplacement » de fichiers .js par .tsx . Il s'agit d'une démarche stratégique qui implique l'apprentissage de nouvelles conventions, une compréhension approfondie des types et, surtout, un changement dans notre façon de penser la fiabilité et la cohérence de notre code.


Voici quelques points à retenir en guise de conclusion :

  1. Safety Net : TypeScript a introduit une couche de sécurité dans notre projet, détectant les erreurs avant qu'elles ne causent des ravages au moment de l'exécution. Ce filet de sécurité, une fois que vous vous y êtes habitué, change la donne en termes de confiance dans votre code et de vitesse de développement globale.


  2. Communication plus claire : Avec les types, notre code communique désormais plus explicitement. Qu'il s'agisse de vous revisitant votre code ou d'un nouveau membre de l'équipe essayant de comprendre vos structures de composants, TypeScript sert de couche de documentation supplémentaire.


  3. Confiance en matière de refactoring : Vous avez peur du refactoring ? Eh bien, TypeScript vous soutient. Avec des types garantissant des contrats dans votre code, de nombreuses erreurs potentielles sont détectées lors des phases de refactoring, ce qui rend le processus moins intimidant.


  4. Communauté et écosystème : l'adoption de TypeScript ouvre les portes d'un écosystème prospère. Des bibliothèques typées sur DefinitelyTyped au support sans fin sur les forums communautaires et à l'intégration plus rationalisée de packages tiers, vous êtes en bonne compagnie.


  5. Courbe d'apprentissage : Oui, TypeScript introduit une courbe d'apprentissage. Il y a probablement eu des moments de frustration, des confusions autour des types et des interfaces, ou des luttes avec le compilateur. Mais revenez sur votre parcours et vous verrez à quel point vous comprenez mieux votre code et son comportement maintenant.


N'oubliez pas que la transition vers TypeScript n'est pas un sprint ; c'est un marathon. Il peut y avoir quelques obstacles au début, mais les gains à long terme en termes de qualité, de prévisibilité et de maintenabilité du code en valent bien la peine.


Tout en poursuivant votre parcours de développement, continuez à explorer, à apprendre et à partager vos expériences avec TypeScript. Chaque défi est une opportunité d’apprendre. Votre futur moi (et votre équipe) vous remerciera pour la base de code robuste, sécurisée et nettement plus maintenable que vous cultivez aujourd'hui.


Merci de vous joindre à moi dans cette exploration de TypeScript avec React. Continuez à coder, continuez à vous améliorer et, plus important encore, appréciez le processus !


Rester connecté

Si vous avez apprécié cet article et souhaitez en savoir plus sur le développement Web, n'hésitez pas à me contacter sur différentes plateformes :

dev.to

hackernoon.com

hashnode.com

twitter.com


Vos commentaires et questions sont toujours les bienvenus.

Continuez à apprendre, à coder et à créer des applications Web étonnantes.


Bon codage !



Ressources additionnelles

Même si notre guide est terminé, votre aventure avec TypeScript ne s'arrête pas là. Le monde de TypeScript est vaste, avec une pléthore de ressources à explorer, à apprendre et auxquelles contribuer. Vous trouverez ci-dessous quelques ressources précieuses qui peuvent vous aider à renforcer votre compréhension et à vous tenir au courant de la communauté TypeScript.


  1. Documentation officielle de TypeScript : Il n'y a pas de meilleur endroit pour explorer TypeScript que son site officiel . Il contient une documentation détaillée, des exemples et des explications sur diverses fonctionnalités.


  2. DefinitelyTyped : Lorsque vous travaillez avec des bibliothèques tierces, DefinitelyTyped est une bouée de sauvetage. Il s'agit d'un référentiel massif de définitions de types TypeScript de haute qualité.


  3. Aide-mémoire React TypeScript : cet aide-mémoire complet s'adresse spécifiquement aux développeurs React passant à TypeScript, couvrant les modèles et pratiques courants.


  4. TypeScript Deep Dive : Un excellent livre en ligne qui propose une exploration détaillée de TypeScript. Deep Dive explique les détails de TypeScript en mettant l'accent sur des scénarios pratiques.


  5. Référentiel TypeScript GitHub : engagez-vous avec la communauté et restez au courant des derniers développements de TypeScript en visitant le référentiel officiel TypeScript GitHub .


  6. Stack Overflow : la balise TypeScript sur Stack Overflow est un centre de requêtes courantes (et rares) et de cas d'utilisation nuancés rencontrés par les développeurs du monde entier. C'est une mine d'or d'informations pratiques.


  7. TypeScript Weekly : newsletter organisée, TypeScript Weekly fournit les derniers articles, conseils et ressources directement dans votre boîte de réception.


  8. Canaux Reddit et Discord : les communautés sur des plateformes telles que r/typescript de Reddit et diverses chaînes Discord hébergent des discussions animées, des actualités et des fils de discussion de résolution de problèmes liés à TypeScript.


  9. Blog TypeScript officiel : pour les annonces, les analyses approfondies et les didacticiels de l'équipe TypeScript, consultez le blog officiel .


  10. Plateformes de codage en ligne : des expériences d'apprentissage interactives via des plates-formes telles que Codecademy , freeCodeCamp et Scrimba proposent des cours pratiques sur TypeScript.


N'oubliez pas que les communautés prospèrent grâce à la participation. N'hésitez pas à poser des questions, à apporter des réponses ou à partager vos solutions et expériences. La sagesse collective des forums communautaires, de la documentation officielle et de la pratique continue vous guidera vers la maîtrise de TypeScript.


Bon codage !