|
| 1 | +## Использование с TypeScript |
| 2 | + |
| 3 | +> Пример проекта для этой конфигурации доступен на [GitHub](https://github.com/vuejs/vue-test-utils-typescript-example). |
| 4 | +
|
| 5 | +TypeScript — популярное надмножество JavaScript, которое добавляет типы и классы поверх обычного JS. Vue Test Utils включает типы в распределённый пакет, поэтому он хорошо работает с TypeScript. |
| 6 | + |
| 7 | +В этом руководстве мы рассмотрим, как настроить тестовую конфигурацию для TypeScript-проекта с использованием Jest и Vue Test Utils из базовой настройки Vue CLI TypeScript. |
| 8 | + |
| 9 | +### Добавление TypeScript |
| 10 | + |
| 11 | +Сначала вам нужно создать проект. Если у вас нет Vue CLI, установите его глобально: |
| 12 | + |
| 13 | +```shell |
| 14 | +$ npm install -g @vue/cli |
| 15 | +``` |
| 16 | + |
| 17 | +И создайте проект, запустив следующую команду: |
| 18 | + |
| 19 | +```shell |
| 20 | +$ vue create hello-world |
| 21 | +``` |
| 22 | + |
| 23 | +В командной строке выберите `Manually select features`, выберите `TypeScript` и нажмите клавишу ввода. Это создаст проект с уже настроенным для работы TypeScript. |
| 24 | + |
| 25 | +::: tip ПРИМЕЧАНИЕ |
| 26 | +Если вы хотите получить более подробное руководство по настройке Vue с помощью TypeScript, ознакомьтесь с [руководством для начинающих по TypeScript во Vue] (https://github.com/Microsoft/TypeScript-Vue-Starter). |
| 27 | +::: |
| 28 | + |
| 29 | +Следующий шаг — добавить Jest к проекту. |
| 30 | + |
| 31 | +### Настройка Jest |
| 32 | + |
| 33 | +Jest — это программа для запуска тестов, разработанный Facebook и направленный на предоставление многофункционального решения для модульного тестирования. Вы можете узнать больше о Jest на его [официальной документации](https://facebook.github.io/jest/). |
| 34 | + |
| 35 | +Установить Jest и Vue Test Utils: |
| 36 | + |
| 37 | +```bash |
| 38 | +$ npm install --save-dev jest @vue/test-utils |
| 39 | +``` |
| 40 | + |
| 41 | +Затем определите команду `test:unit` в секции scripts в `package.json`. |
| 42 | + |
| 43 | +```json |
| 44 | +// package.json |
| 45 | +{ |
| 46 | + // .. |
| 47 | + "scripts": { |
| 48 | + // .. |
| 49 | + "test:unit": "jest" |
| 50 | + } |
| 51 | + // .. |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +### Обработка однофайловых компонентов в Jest |
| 56 | + |
| 57 | +Чтобы научить Jest обрабатывать файлы с расширением `.vue`, нам нужно установить и настроить препроцессор `vue-jest`: |
| 58 | + |
| 59 | +``` bash |
| 60 | +npm install --save-dev vue-jest |
| 61 | +``` |
| 62 | + |
| 63 | +Затем создайте блок `jest` в `package.json`: |
| 64 | + |
| 65 | +``` json |
| 66 | +{ |
| 67 | + // ... |
| 68 | + "jest": { |
| 69 | + "moduleFileExtensions": [ |
| 70 | + "js", |
| 71 | + "ts", |
| 72 | + "json", |
| 73 | + // указываем Jest обрабатывать файлы с расширением `*.vue` |
| 74 | + "vue" |
| 75 | + ], |
| 76 | + "transform": { |
| 77 | + // обработка файлов с расширением `*.vue` с помощью `vue-jest` |
| 78 | + ".*\\.(vue)$": "vue-jest", |
| 79 | + }, |
| 80 | + "testURL": "http://localhost/" |
| 81 | + } |
| 82 | +} |
| 83 | +``` |
| 84 | + |
| 85 | +### Настройка TypeScript для Jest |
| 86 | + |
| 87 | +Чтобы использовать файлы TypeScript в тестах, нам нужно настроить Jest для компиляции TypeScript. Для этого нам нужно установить `ts-jest`: |
| 88 | + |
| 89 | +``` bash |
| 90 | +$ npm install --save-dev ts-jest |
| 91 | +``` |
| 92 | + |
| 93 | +Затем нам нужно указать Jest обработать тестовые файлы TypeScript с помощью `ts-jest`, добавив запись в `jest.transform` в `package.json`: |
| 94 | + |
| 95 | +``` json |
| 96 | +{ |
| 97 | + // ... |
| 98 | + "jest": { |
| 99 | + // ... |
| 100 | + "transform": { |
| 101 | + // ... |
| 102 | + // обработка файлов с расширением `*.ts` с помощью `ts-jest` |
| 103 | + "^.+\\.tsx?$": "ts-jest" |
| 104 | + }, |
| 105 | + // ... |
| 106 | + } |
| 107 | +} |
| 108 | +``` |
| 109 | + |
| 110 | +### Размещение тестовых файлов |
| 111 | + |
| 112 | +По умолчанию Jest будет рекурсивно выбирать все файлы с расширением `.spec.js` или `.test.js` по всему проекту. |
| 113 | + |
| 114 | +Чтобы запустить тестовые файлы с расширением `.ts`, нам нужно изменить `testRegex` в разделе конфигурации файла `package.json`. |
| 115 | + |
| 116 | +Добавьте следующее в поле `jest` в `package.json`: |
| 117 | + |
| 118 | +``` json |
| 119 | +{ |
| 120 | + // ... |
| 121 | + "jest": { |
| 122 | + // ... |
| 123 | + "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$" |
| 124 | + } |
| 125 | +} |
| 126 | +``` |
| 127 | + |
| 128 | +Jest рекомендует создать каталог `__tests__` рядом с тестируемым кодом, но не стесняйтесь структурировать ваши тесты по своему усмотрению. Просто остерегайтесь того, что Jest создаст каталог `__snapshots__` рядом с тестовыми файлами, которые выполняют тестирование моментальными снимками. |
| 129 | + |
| 130 | +### Написание модульного теста |
| 131 | + |
| 132 | +Теперь у нас есть проект, пришло время написать тест. |
| 133 | + |
| 134 | +Создайте файл `src/components/__tests__/HelloWorld.spec.ts` и добавьте следующий код: |
| 135 | + |
| 136 | +```js |
| 137 | +// src/components/__tests__/HelloWorld.spec.ts |
| 138 | +import { shallowMount } from '@vue/test-utils' |
| 139 | +import HelloWorld from '../HelloWorld.vue' |
| 140 | + |
| 141 | +describe('HelloWorld.vue', () => { |
| 142 | + test('renders props.msg when passed', () => { |
| 143 | + const msg = 'new message' |
| 144 | + const wrapper = shallowMount(HelloWorld, { |
| 145 | + propsData: { msg } |
| 146 | + }) |
| 147 | + expect(wrapper.text()).toMatch(msg) |
| 148 | + }) |
| 149 | +}) |
| 150 | +``` |
| 151 | + |
| 152 | +Это все, что нам нужно сделать, чтобы заставить TypeScript и Vue Test Utils работать вместе! |
| 153 | + |
| 154 | +### Ресурсы |
| 155 | + |
| 156 | +- [Пример проекта для этой конфигурации](https://github.com/vuejs/vue-test-utils-typescript-example) |
| 157 | +- [Jest](https://facebook.github.io/jest/) |
0 commit comments