paint-brush
Как перенести проект React с JavaScript на TypeScriptк@leandronnz
15,604 чтения
15,604 чтения

Как перенести проект React с JavaScript на TypeScript

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

Слишком долго; Читать

Миграция проекта React с Javascript на TypeScript — это не просто «поиск и замена» файлов .js на .tsx. Это стратегический шаг, который предполагает изучение новых соглашений, глубокое понимание типов и, что наиболее важно, изменение нашего подхода к надежности и согласованности нашего кода. Вот несколько примечаний: Сеть безопасности: TypeScript ввел в наш проект уровень безопасности, выявляя ошибки до того, как они нанесут ущерб во время выполнения. Эта система безопасности, как только вы к ней привыкнете, изменит правила игры с точки зрения уверенности в вашем коде и общей скорости разработки. Более четкое общение. Благодаря типам наш код теперь взаимодействует более явно. Независимо от того, просматриваете ли вы свой код или новый член команды пытается понять структуру ваших компонентов, TypeScript служит дополнительным уровнем документации. Уверенность в рефакторинге: боитесь рефакторинга? Что ж, TypeScript вас поддержит. Благодаря типам, обеспечивающим контракты внутри вашего кода, многие потенциальные ошибки выявляются на этапах рефакторинга, что делает процесс менее сложным. Сообщество и экосистема: использование TypeScript открывает двери в процветающую экосистему. От типизированных библиотек на DefinitelyTyped до бесконечной поддержки на форумах сообщества и более оптимизированной интеграции сторонних пакетов — вы в хорошей компании. Кривая обучения: Да, TypeScript вводит кривую обучения. Вероятно, были моменты разочарования, путаницы в отношении типов и интерфейсов или проблем с компилятором. Но оглянитесь назад на свое путешествие, и вы увидите, насколько лучше вы теперь понимаете свой код и его поведение.
featured image - Как перенести проект React с JavaScript на TypeScript
Leandro Nuñez HackerNoon profile picture
0-item


Оглавление

  • Введение

  • Зачем мигрировать? Понимание преимуществ

  • Прежде чем начать: Предварительные условия

  • Инициирование миграции: настройка TypeScript в вашем проекте

  • Рефакторинг React-компонентов

  • Управление состоянием и контекстный API

  • Маршрутизация и асинхронные операции

  • Тестирование в TypeScript

  • Обработка пакетов, не относящихся к TypeScript

  • Лучшие практики и распространенные ошибки

  • Заключение

  • Дополнительные ресурсы



Введение

Привет, коллеги-разработчики! Приятно видеть вас здесь, готовых изучить переход от JavaScript к TypeScript в наших проектах React.


Теперь, если вы работали с JavaScript, вы знаете, что это как старая, удобная пара обуви — немного поношенная, иногда непредсказуемая, но знакомая. Однако TypeScript — это все равно, что обновить обувь с помощью специальных стелек; это тот же опыт ходьбы, но с дополнительной поддержкой.


Итак, что же такого в TypeScript?


Ну, по сути, это JavaScript, но с хорошей дозой дополнительных возможностей, наиболее важной из которых является проверка типов.


Представьте себе, что кодирование без этих надоедливых undefined is not a function , возникающие из ниоткуда. Именно такой мир TypeScript привносит в вашу жизнь.


В этом руководстве мы рассмотрим, почему и как интегрировать TypeScript в ваш проект React.


Почему Реагировать? Потому что это потрясающе, и нам это, очевидно, нравится. Но также сочетание компонентного подхода React с функциями проверки типов TypeScript обеспечивает очень эффективный и приятный процесс кодирования.


Вот краткий обзор того, как выглядит добавление TypeScript в проект. В типичном компоненте JavaScript у вас будет:

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


С помощью TypeScript мы представляем способ гарантировать, name всегда обрабатывается как строка:

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


Обратите внимание на часть type Props ?


Это способ TypeScript сказать: «Эй, я смотрю; лучше убедитесь, что name — это строка!» Это простое изменение имеет глубокие последствия. Теперь у вас есть ангел-хранитель, активно предотвращающий ошибки, связанные с типами, что делает ваш код более надежным и предсказуемым.


Но это всего лишь крошечный взгляд. У TypeScript есть целый мир преимуществ и практик, которые мы раскроем в этом подробном руководстве. Нам есть о чем рассказать — от настройки среды до рефакторинга компонентов и реквизитов и даже передовых методов предотвращения распространенных ошибок. Итак, пристегнитесь и отправимся в путь!




Зачем мигрировать? Понимание преимуществ

Если вы обдумываете переход от JavaScript к TypeScript, особенно в ваших проектах React , вы не одиноки, кто задается вопросом: «Действительно ли это стоит затраченных усилий?» Переход на язык всего проекта — немалый подвиг; это требует усилий, обучения и, поначалу, некоторого замедления производительности. Итак, почему разработчики делают этот переход? Давайте разберем веские причины.


1. Выявляйте ошибки раньше: статическая проверка типов

Основная особенность TypeScript — это статическая система типов. В отличие от JavaScript, который является динамически типизированным, TypeScript позволяет указывать типы переменных, параметров функций и возвращаемых значений. В чем преимущество? Ошибки выявляются во время разработки, задолго до того, как код приблизится к производству.


Рассмотрим простой пример:

 // 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!


Теперь давайте посмотрим, как помогает TypeScript:

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


С помощью TypeScript эта невинная на первый взгляд ошибка была бы обнаружена мгновенно, гарантируя, что вы узнаете о происшествии в тот момент, когда оно произойдет. Таким образом, цикл обратной связи сокращается, и вам не придется ломать голову, выискивая странные ошибки в вашей производственной среде.


2. Улучшите качество и понятность кода

Обеспечение типизации в TypeScript означает, что любой другой разработчик (или даже вы в будущем) может с первого взгляда понять, какие данные ожидает функция и что она возвращает. Эта ясность делает базы кода более читабельными и самодокументируемыми.


Представьте себе, что вы столкнулись с функцией JavaScript, написанной коллегой:

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


Вам, вероятно, придется покопаться в функции или найти, где она используется, чтобы понять, какие items должны быть. С TypeScript сразу понятно:

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


3. Расширенная поддержка редактора.

TypeScript выводит работу разработчиков на новый уровень, расширяя возможности текстовых редакторов и IDE за счет улучшенного автодополнения, рефакторинга и отладки. Такая интеграция возможна, поскольку TypeScript может поделиться своим пониманием вашего кода с вашим редактором.

Вы почувствуете это, когда обнаружите, что ваш редактор предлагает имена методов, предоставляет информацию о параметрах функции или предупреждает вас о неправильном использовании функции. Это похоже на второго пилота, который помогает перемещаться по коду, обеспечивая дополнительный уровень безопасности.


4. Упрощение сотрудничества

В командной среде TypeScript проявляет себя великолепно, помогая обеспечить соблюдение определенных стандартов и структур во всей кодовой базе. Когда в проекте участвуют несколько разработчиков, строгие правила TypeScript гарантируют, что все будут придерживаться одних и тех же правил кодирования, что делает совместную работу более гладкой. Это общий язык, который говорит о «качестве и последовательности» во всех сферах.


5. Готовность вашего кода к будущему

JavaScript развивается, и TypeScript стремится быть в курсе новейших функций. Используя TypeScript, вы можете начать использовать функции JavaScript следующего поколения до того, как они станут массовыми, гарантируя, что ваш проект останется современным и передовым.


В заключение, переход на TypeScript — это не просто раннее обнаружение ошибок; речь идет о комплексном улучшении вашего процесса кодирования. TypeScript обеспечивает надежную основу для создания надежных, масштабируемых и удобных в обслуживании приложений — от улучшения совместной работы в команде до готовности ваших проектов к будущему.


Поначалу переход может показаться сложным, но с учетом преимуществ, изложенных выше, становится ясно, почему TypeScript стал фаворитом для многих разработчиков во всем мире. Готовы погрузиться? Давайте продолжим!



Прежде чем начать: Предварительные условия

Итак, вы готовы перейти на TypeScript в своем проекте React? Отличное решение!


Но прежде чем мы углубимся в сам процесс, нам нужно убедиться в наличии нескольких вещей.

Считайте это нашим подготовительным этапом, на котором мы подготавливаем все наши инструменты, чтобы процесс перехода прошел гладко, как по маслу.


Вот что вам нужно иметь наготове:

1. Существующий проект React

Прежде всего, вам нужен существующий проект React. Этот проект должен быть таким, с которым вам будет удобно экспериментировать; Хотя процесс миграции довольно прост, вам следует сделать это в месте, где можно создавать временные беспорядки.


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


Этот компонент является хорошей отправной точкой: он функционален, чист, и мы можем с первого взгляда увидеть, что происходит.

2. Базовое понимание TypeScript

Вам не обязательно быть гуру TypeScript, но понимание основ значительно облегчит этот переход.


Уметь определять типы и интерфейсы и знать разницу между type и interface .

Небольшая домашняя работа имеет большое значение, поверьте мне.


 // 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;


Увидеть разницу? Теперь мы четко говорим о том, чего ожидает Greeting , делая наш компонент более предсказуемым и простым в работе.


3. Узел и NPM/пряжа

В вашей среде разработки должен быть установлен Node.js, поскольку мы собираемся использовать npm или yarn для обработки наших пакетов. Это требование является само собой разумеющимся, поскольку вы работаете с React, но не помешает убедиться в этом, верно?


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


Ваш терминал должен показать вам текущие версии этих инструментов, подтверждая, что все они настроены и готовы к работе.


4. Редактор кода

Вам понадобится редактор кода, который хорошо поддерживает TypeScript. Visual Studio Code является фаворитом публики, поскольку он имеет надежную встроенную поддержку TypeScript, что делает процесс разработки более плавным благодаря интеллектуальному завершению кода и выделению ошибок.


5. Контроль версий

Этот шаг не является обязательным, но разумным. Убедитесь, что ваш текущий проект находится под контролем версий с помощью git. Если что-то пойдет не так (хотя мы постараемся убедиться, что это не так), вы всегда можете вернуться к предыдущей версии, не теряя сна.


 # 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"


Наличие этой системы безопасности означает, что вы можете смело экспериментировать, зная, что ваша спина прикрыта.


Вот и все наши предпосылки! У вас есть проект, вы немного освоили TypeScript, ваша среда готова, и ваша система безопасности на месте.


Теперь мы готовы погрузиться в процесс миграции. Давайте начнем!



Инициирование миграции: настройка TypeScript в вашем проекте Рефакторинг компонентов React

Хорошо, переходим к следующему этапу!


Мы подготовили почву для TypeScript, но теперь нам нужно испачкать руки.


Пришло время провести рефакторинг наших компонентов React. Этот шаг включает в себя нечто большее, чем просто изменение расширений файлов; нам необходимо обновить код нашего компонента, чтобы использовать функции TypeScript для более надежного и безошибочного кодирования.

Давайте погрузимся!


1. Изменение расширений файлов

Прежде всего, давайте переименуем файлы наших компонентов. Этот процесс включает изменение расширения с .js на .tsx для файлов, содержащих код JSX.


Вот как вы можете сделать это массово в исходном каталоге вашего проекта из командной строки:

 # 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' }


Эти команды ищут все файлы .js в исходном каталоге вашего проекта и переименовывают их в .tsx . Это все равно, что сказать своим файлам: «Добро пожаловать в мир TypeScript!»


2. Ввод компонентов

Переименовав наши файлы, давайте займемся кодом. Начнем с простого функционального компонента на JavaScript:

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


Теперь давайте проведем рефакторинг для использования 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>; }


Что мы здесь делали?


Мы определили интерфейс MyComponentProps для описания свойств нашего компонента, обеспечивая безопасность типов. Говоря, что greeting — это строка, TypeScript будет кричать на нас, если мы попытаемся вместо этого передать, скажем, число. Мы также использовали тип FC (сокращение от Functional Component ) из определений типов React, чтобы убедиться, что TypeScript знает, что это компонент React.


3. Строгая типизация useState и useEffect

Давайте усовершенствуем наши компоненты, добавив типы к состояниям и эффектам, общие черты функциональных компонентов.


Вот компонент с состоянием и эффектом:

 // 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> ); }


Давайте добавим сюда немного магии TypeScript:

 // 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> ); }


В нашем рефакторинговом компоненте мы явно указали TypeScript ожидать number для нашего состояния count .


Эта деталь предотвращает досадные ошибки, из-за которых мы можем случайно получить строку, объект или, не дай бог, null вместо ожидаемого числа.


И вот мы идем!


Мы успешно провели рефакторинг наших компонентов React для использования TypeScript. Явно вводя наши компоненты, состояния и реквизиты, мы создаем более предсказуемую и простую в обслуживании кодовую базу. Мы не просто кодируем; мы создаем шедевр с точностью, которой он заслуживает.


Далее мы углубимся в более сложные сценарии и то, как TypeScript приходит нам на помощь!



Управление состоянием и контекстный API

Теперь давайте углубимся в тонкости управления состоянием в React с помощью TypeScript. Если вы использовали Context API в проекте JavaScript, вы знаете, что это мощная функция для передачи данных через дерево компонентов без необходимости вручную передавать реквизиты на каждом уровне. В TypeScript мы получаем дополнительное преимущество строгой типизации, что делает наши контекстные данные еще более надежными и предсказуемыми.


Готовы прыгнуть? Пойдем!


1. Создание типизированного контекста

Сначала мы собираемся создать новый контекст с помощью TypeScript. Этот контекст гарантирует, что любое значение по умолчанию, значение поставщика или потребительский компонент соответствует нашему ожидаемому типу.


Вот как можно определить базовый контекст в 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> ); };


Теперь давайте напечатаем этот контекст с помощью 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> ); };


Здесь мы создали интерфейс TypeScript DataContextState , который строго типизирует наши контекстные данные. Мы также ввели функцию createContext и компонент DataProvider , гарантируя, что все, от переменных состояния до значений контекста, соответствует нашим определенным типам.


2. Использование типизированного контекста

Теперь, когда у нас есть типизированный DataContext , давайте посмотрим, как мы можем использовать его в компоненте.


Нам нужно будет использовать хук useContext , и вот как это делается:

 // 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> ); };


В ComponentUsingContext мы получаем доступ к контексту и ожидаем, что TypeScript проверит соответствие значения DataContextState . Наша функция handleUpdateData демонстрирует, как можно обновить общее состояние — любые компоненты, использующие DataContext , будут повторно отображаться с новыми данными при вызове setData .


Используя TypeScript с Context API, мы получаем уверенность в том, что наше общее управление состоянием единообразно во всем приложении. Компилятор улавливает любые несоответствия между тем, что предоставляет наш контекст, и тем, что ожидают наши компоненты. Эта синергия делает наш код более надежным, а процесс разработки — более плавным, позволяя нам избежать целых категорий ошибок, с которыми мы могли бы столкнуться в противном случае.


Продолжайте в том же духе и помните: небольшой набор текста сейчас позволяет сэкономить массу времени на отладку в будущем!



Тестирование маршрутизации и асинхронных операций в TypeScript >

Теперь, когда мы увидели, как TypeScript улучшает различные аспекты нашего приложения React, пришло время поговорить о другой важной области: тестировании.


Тестирование имеет основополагающее значение для обеспечения правильной работы нашего приложения, а TypeScript может сделать наши тесты более надежными и эффективными. Давайте углубимся в то, как TypeScript играет роль в тестировании, особенно в проекте React.


1. Подготовка почвы для тестирования

Прежде чем мы перейдем к коду, убедитесь, что у вас установлены необходимые библиотеки для тестирования в проекте React. Вот быстрая настройка Jest и библиотеки тестирования React, широко используемой вместе для тестирования приложений React:

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


Эти библиотеки предоставляют надежную среду для написания модульных и интеграционных тестов. Теперь давайте для ясности рассмотрим реальный сценарий.


2. Реальный сценарий тестирования: компонент приветствия пользователя

Представьте, что в нашем приложении есть простой компонент, который приветствует пользователей в зависимости от времени суток. Это функциональный компонент, который принимает имя пользователя в качестве реквизита и текущее время в качестве состояния.


Вот как может выглядеть наш компонент 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;


Теперь нам нужно написать тесты, чтобы убедиться, что наш компонент ведет себя должным образом в различных условиях. Наши тестовые примеры подтвердят, что соответствующее приветствие отображается в зависимости от времени суток.


Вот как мы можем написать эти тесты, используя Jest и библиотеку тестирования 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. });


В этом скрипте мы визуализируем наш компонент с заданным временем (по образцу 14:00) и проверяем, выводит ли он «Добрый день», как ожидалось. Мы можем написать больше тестов для другого времени суток (утро, вечер), чтобы убедиться, что наш компонент полностью охвачен.


С помощью TypeScript мы гарантируем, что реквизиты, которые мы передаем нашим компонентам в наших тестах, соответствуют ожидаемым типам. Таким образом, мы избегаем проблем с неправильными реквизитами, которые могут привести к ложноотрицательным результатам в наших тестах, гарантируя, что наши тесты являются надежными и надежными.


Использование TypeScript при тестировании помогает выявить проблемы на ранних этапах процесса разработки, делая наши приложения более надежными и удобными в обслуживании. Это беспроигрышная ситуация! Помните, что последовательное и всестороннее тестирование является отличительной чертой высококачественной разработки программного обеспечения. Так держать!




Обработка пакетов, не относящихся к TypeScript

Хорошо, давайте займемся областью, которая часто сбивает с толку людей при переходе на TypeScript в проекте React: работе с библиотеками и пакетами JavaScript, которые не написаны на TypeScript. Это обычный сценарий; у вас есть запущенный проект TypeScript, а затем вы устанавливаете сторонний пакет только для того, чтобы обнаружить, что ваш компилятор TypeScript жалуется. Не волнуйся; есть решения.


1. Встреча с проблемой

Вот типичный сценарий: вы пытаетесь использовать пакет, который не имеет встроенной поддержки TypeScript, а компилятор TypeScript начинает выдавать ошибки типа «Не удалось найти файл объявления для модуля «имя-модуля». Звучит знакомо?


Эта проблема возникает потому, что TypeScript использует определения типов для понимания структуры библиотек и пакетов. Если эти определения типов отсутствуют, TypeScript немного теряется. Но не бойтесь, у нас есть стратегии, как справиться с этим.

2. Использование DefiniteTyped

Первое, что вы можете сделать, — это проверить, предоставило ли сообщество определения типов для пакета через DefiniteTyped. DefinitelyTyped — это огромный репозиторий определений типов, поддерживаемый сообществом.


Вот как можно проверять и использовать типы из DefinitelyTyped:


  1. Найдите определения типов для вашего пакета, попытавшись установить их с помощью npm. Определения типов в DefinitelyTyped обычно имеют префикс @types/ .
 npm install @types/package-name


Например, если бы вы использовали библиотеку lodash , вы бы запустили:

 npm install @types/lodash


  1. После установки вам не нужно явно импортировать типы куда-либо в ваш проект. TypeScript автоматически обнаруживает и использует их, позволяя вам импортировать и использовать библиотеки как обычно, а также получать автодополнение и проверку типов.


Но что, если в DefinitelyTyped нет определения типа?


3. Создание собственного файла декларации

Если в DefinitelyTyped нет необходимых вам определений типов, пришло время создать собственный файл объявлений. Хотя этот подход требует больше усилий, он гарантирует бесперебойную работу вашего проекта TypeScript с библиотекой JavaScript.


Вот упрощенная версия того, что вы можете сделать:


  1. Создайте новый файл с расширением .d.ts в исходном каталоге (или каталоге types ) вашего проекта. Это может быть что-то вроде declarations.d.ts .


  2. В этом файле вы захотите объявить модуль и, возможно, обрисовать базовую структуру, которую вы ожидаете от библиотеки. Например:

 // 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. }


Этот самодельный файл объявлений не будет таким полным, как полный набор определений типов, но он сообщает TypeScript: «Поверьте мне, я знаю, что этот модуль существует, и он предоставляет эти функции/переменные». Отсюда вы можете при необходимости построить более подробные определения.


Помните, что работа с пакетами, отличными от TypeScript, может быть некоторым препятствием, но эти стратегии гарантируют, что ваш проект TypeScript останется надежным и будет обладать той безопасностью типов и предсказуемостью, которые нам нужны. Все дело в уверенности в вашей кодовой базе!



Лучшие практики и распространенные ошибки

Переход на TypeScript в вашем проекте React — это не просто изменение расширений файлов и добавление аннотаций типов. Речь также идет об адаптации вашего мышления и методов разработки, чтобы максимально эффективно использовать возможности TypeScript, избегая при этом распространенных камней преткновения. Итак, давайте обсудим некоторые лучшие практики и распространенные ошибки, с которыми вы можете столкнуться на этом пути.

1. Лучшие практики

1.1. Опирайтесь на вывод типа

Хотя может возникнуть соблазн аннотировать все, одна из сильных сторон TypeScript — это вывод типа. Часто нет необходимости добавлять явные типы в каждый фрагмент вашего кода.

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

Чрезмерное аннотирование может сделать ваш код многословным, не добавляя при этом ценности. Доверяйте TypeScript для вывода типов там, где это возможно.

1.2 Используйте типы утилит

Типы служебных программ предоставляют гибкие способы обработки типов в различных сценариях. Они могут сэкономить вам массу усилий и сделать обработку типов более эффективной.

 // 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 и другие типы утилит могут быть невероятно удобными.

1.3. Использование перечислений для известных наборов констант

Если у вас есть свойство, которое может принимать только определенные значения, использование enum может прояснить ваше намерение, обеспечивая при этом проверку этих значений.

 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 Предпочтительные интерфейсы для определения структуры объекта

Хотя type и interface часто можно использовать как взаимозаменяемые, использование interface для определения структуры объектов или классов делает ваш код более читабельным и обеспечивает более качественные сообщения об ошибках.

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


2. Распространенные ошибки

2.1 Злоупотребление any

Использование any сводит на нет преимущества TypeScript, минуя проверку типов. Хотя это может показаться быстрым решением, оно делает ваш код менее безопасным и предсказуемым.

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

2.2 Игнорирование предупреждений компилятора

Предупреждения компилятора TypeScript помогут вам. Игнорирование этого может привести к тем же ошибкам и проблемам, которых вы пытаетесь избежать, используя TypeScript.

2.3 Заблудиться в сложных типах

Иногда, пытаясь сделать типы точными, разработчики создают невероятно сложные определения типов, которые трудно понять и поддерживать. Если ваши типы становятся запутанными, возможно, пришло время упростить или реорганизовать ваш код.

2.4 Забывание типов сторонних библиотек

Если вы используете сторонние библиотеки, всегда проверяйте, есть ли существующие типы TypeScript в DefinitelyTyped. Невыполнение этого требования может означать потерю функций безопасности типов для этих библиотек.

В заключение отметим, что внедрение TypeScript — это больше, чем просто использование нового синтаксиса; речь идет о внедрении новых методов, которые помогают избежать ошибок, делают код более читабельным и улучшают обслуживание. Избегайте распространенных ловушек и помните: цель — писать более чистый, надежный и удобный в сопровождении код!




Заключение

Итак, ребята, мы подошли к концу нашего пути по миграции TypeScript. Это было настоящее путешествие, не так ли? Мы начали с большого вопроса «почему» и углубились в детали фактического перехода проекта React с JavaScript на TypeScript. От настройки среды TypeScript до рефакторинга компонентов, управления состояниями, обработки маршрутов и даже работы с надоедливыми пакетами, отличными от TypeScript, мы рассмотрели много вопросов.


Размышляя об этом путешествии, становится ясно, что переход на TypeScript — это не просто «поиск и замена» файлов .js на .tsx . Это стратегический шаг, который предполагает изучение новых соглашений, глубокое понимание типов и, что наиболее важно, изменение нашего подхода к надежности и согласованности нашего кода.


Вот несколько выводов в завершение:

  1. Сеть безопасности : TypeScript ввел в наш проект уровень безопасности, выявляя ошибки до того, как они нанесут ущерб во время выполнения. Эта система безопасности, как только вы к ней привыкнете, изменит правила игры с точки зрения уверенности в вашем коде и общей скорости разработки.


  2. Более четкое общение . Благодаря типам наш код теперь взаимодействует более явно. Независимо от того, просматриваете ли вы свой код или новый член команды пытается понять структуру ваших компонентов, TypeScript служит дополнительным уровнем документации.


  3. Уверенность в рефакторинге : боитесь рефакторинга? Что ж, TypeScript вас поддержит. Благодаря типам, обеспечивающим контракты внутри вашего кода, многие потенциальные ошибки выявляются на этапах рефакторинга, что делает процесс менее сложным.


  4. Сообщество и экосистема . Использование TypeScript открывает двери в процветающую экосистему. От типизированных библиотек на DefinitelyTyped до бесконечной поддержки на форумах сообщества и более упрощенной интеграции сторонних пакетов — вы в хорошей компании.


  5. Кривая обучения : Да, TypeScript вводит кривую обучения. Вероятно, были моменты разочарования, путаницы в отношении типов и интерфейсов или проблем с компилятором. Но оглянитесь назад на свое путешествие, и вы увидите, насколько лучше вы теперь понимаете свой код и его поведение.


Помните, переход на TypeScript — это не спринт; это марафон. На начальном этапе могут возникнуть некоторые препятствия, но долгосрочное улучшение качества кода, предсказуемости и удобства сопровождения стоит затраченных усилий.


Продолжая свой путь разработки, продолжайте исследовать, изучать и делиться своим опытом работы с TypeScript. Каждое испытание — это возможность учиться. Вы в будущем (и ваша команда) будете благодарны вам за надежную, типобезопасную и значительно более удобную в обслуживании кодовую базу, которую вы развиваете сегодня.


Спасибо, что присоединились ко мне в этом исследовании TypeScript с React. Продолжайте программировать, продолжайте совершенствоваться и, самое главное, наслаждайтесь процессом!


Оставайся на связи

Если вам понравилась эта статья и вы хотите узнать больше о веб-разработке, свяжитесь со мной на различных платформах:

dev.to

hackernoon.com

hashnode.com

Twitter.com


Ваши отзывы и вопросы всегда приветствуются.

Продолжайте учиться, программировать и создавать потрясающие веб-приложения.


Приятного кодирования!



Дополнительные ресурсы

Несмотря на то, что наше руководство подошло к концу, ваше приключение с TypeScript на этом не заканчивается. Мир TypeScript огромен и содержит множество ресурсов, которые можно исследовать, учиться и вносить свой вклад. Ниже приведены некоторые ценные ресурсы, которые помогут вам улучшить понимание и держать вас в курсе событий сообщества TypeScript.


  1. Официальная документация TypeScript : нет лучшего места для изучения TypeScript, чем его официальный сайт . Он наполнен подробной документацией, примерами и объяснениями различных функций.


  2. DefinitelyTyped : при работе со сторонними библиотеками DefinitelyTyped спасает жизнь. Это огромный репозиторий высококачественных определений типов TypeScript.


  3. Шпаргалка по React TypeScript : эта подробная шпаргалка предназначена специально для разработчиков React, переходящих на TypeScript, и охватывает общие шаблоны и практики.


  4. TypeScript Deep Dive : отличная онлайн-книга, предлагающая подробное изучение TypeScript. Deep Dive объясняет все тонкости TypeScript с упором на практические сценарии.


  5. Репозиторий TypeScript GitHub : общайтесь с сообществом и будьте в курсе последних событий в TypeScript, посещая официальный репозиторий TypeScript GitHub .


  6. Переполнение стека . Тег TypeScript в Stack Overflow — это центр распространенных (и необычных) запросов и нюансов использования, с которыми сталкиваются разработчики по всему миру. Это золотая жила практических идей.


  7. TypeScript Weekly : курируемый информационный бюллетень TypeScript Weekly доставляет последние статьи, советы и ресурсы прямо на ваш почтовый ящик.


  8. Каналы Reddit и Discord . В сообществах на таких платформах, как r/typescript Reddit и различных каналах Discord, проводятся активные дискуссии, новости и темы по решению проблем, связанных с TypeScript.


  9. Официальный блог TypeScript : объявления, подробные сведения и учебные пособия от команды TypeScript можно найти в официальном блоге .


  10. Онлайн-платформы для программирования . Интерактивное обучение на таких платформах, как Codecademy , freeCodeCamp и Scrimba, предоставляет практические курсы по TypeScript.


Помните, что сообщества процветают благодаря участию. Не стесняйтесь задавать вопросы, предлагать ответы или делиться своими решениями и опытом. Коллективная мудрость форумов сообщества, официальная документация и постоянная практика помогут вам овладеть TypeScript.


Приятного кодирования!