Как настроить Webpack, TypeScript и ts-loader
4 месяца назад·8 мин. на чтение
Здесть вы узнаете, как правильно настроить Webpack с использованием TypeScript и ts-loader. Шаг за шагом мы проведем вас через процесс интеграции TypeScript в ваш проект с помощью ts-loader, расскажем об основных конфигурационных параметрах и поделимся советами по оптимизации сборки.
Используемый во многих современных проектах, Webpack, является инструментом, который оптимизирует ресурсы приложения, чтобы они работали более эффективно на любом устройстве. Webpack помогает компилировать и объединять модули в единый файл, уменьшая количество HTTP-запросов и, как следствие, повышая производительность приложения.
С помощью Webpack код TypeScript компилируется в файл JavaScript, который удобен для браузера. С помощью загрузчиков (loaders) Webpack вы также можете конвертировать файлы Sass и Less в один CSS файл.
В этой статье мы узнаем, как использовать Webpack для компиляции TypeScript в JavaScript, объединять исходный код в один JavaScript файл и использовать source map исходного кода для отладки. Мы также рассмотрим, как использовать плагины Webpack.
Чтобы следовать инструкциям в этом руководстве, вам потребуется следующее:
- npm
- Node.js (≥v8.x)
- Редактор кода на ваш выбор (например, Visual Studio Code)
- Базовые знания TypeScript
Содержание
- Загрузчики Webpack
- Настройка Webpack и TypeScript
- Конфигурация Webpack
- Конфигурация TypeScript
- Конфигурация пакета
- Создание HTML-страниц с помощью HtmlWebpackPlugin
- Объединение CSS с MiniCssExtractPlugin
- Минимизация CSS
- Минификация JavaScript
- Использование CopyWebpackPlugin
- Отладка с помощью source map
Загрузчики Webpack
По умолчанию Webpack понимает только файлы JavaScript, рассматривая каждый импортированный файл как модуль. Webpack не может компилировать или объединять файлы, отличные от JavaScript, поэтому он использует загрузчики. Загрузчики сообщают Webpack, как компилировать и объединять статические ресурсы. Они используются для компиляции модулей TypeScript в JavaScript, обработки стилей приложений и даже линтинга кода с помощью ESLint. Некоторые загрузчики Webpack включают ts-loader, css-loader, style-loader и другие. Мы обсудим их позже в этом руководстве.Настройка Webpack и TypeScript
Начнем с настройки нашего проекта. Во-первых, на вашем компьютере должен быть установлен TypeScript. Чтобы установить TypeScript глобально, используйте следующую команду:Глобальная установка TypeScript избавляет от необходимости устанавливать TypeScript каждый раз, когда вы начинаете новый проект. Далее мы установим пакеты webpack и ts-loader в качестве зависимостей в нашем проекте:npm install -g typescript
npm init -y npm install -D webpack webpack-cli ts-loader webpack-dev-server
Конфигурация Webpack
По умолчанию Webpack не нуждается в конфигурационном файле. Предполагается, что точкой входа для вашего проекта являетсяsrc/index.js
и выведет минимизированный и оптимизированный результат в dist/main.js
.
Если вы хотите использовать плагины или загрузчики, то вам нужно будет использовать конфигурационный файл Webpack, позволяющий указать, как Webpack будет работать с вашим проектом, какие файлы компилировать и где будет находиться выходной файл.
Давайте добавим конфигурационный файл Webpack в наш проект. В корневой папке проекта создайте webpack.config.js
со следующими конфигурациями:
Давайте рассмотрим некоторые параметры конфигурации Webpack. Во-первых, опцияconst path = require('path'); module.exports = { entry: './src/index.ts', module: { rules: [ { test: /\.ts?$/, use: 'ts-loader', exclude: /node_modules/, }, ], }, resolve: { extensions: ['.tsx', '.ts', '.js'], }, output: { filename: 'bundle.js', path: path.resolve(__dirname, 'dist'), }, devServer: { static: path.join(__dirname, "dist"), compress: true, port: 4000, }, };
entry
является отправной точкой для приложения, где Webpack начинает строить граф зависимостей. Webpack перейдет к другим модулям в зависимости от входного файла.
Опция output
указывает Webpack, куда сохранять бандлы (результаты сборки), и позволяет присвоить файлу имя. Наконец, опция module указывает Webpack, как обрабатывать модули с определенными правилами с помощью загрузчиков.
Конфигурация TypeScript
Конфигурационный файл TypeScript определяет, как TypeScript будет компилироваться в JavaScript, и определяет различные параметры компилятора, необходимые для транспиляции TypeScript. В корневой папке проекта создайтеtsconfig.json
и добавьте следующие конфигурации:
{
"compilerOptions": {
"noImplicitAny": true,
"target": "ES5",
"module": "ES2015"
}
}
target
— это версия JavaScript, в которую вы хотите транспилировать TypeScript, а module
— это формат используемого оператора импорта. Вы можете установить модуль на CommonJS, ES6 или UMD, так как Webpack будет работать со всеми системами модулей.
Конфигурация проекта
Теперь нам нужно добавить сценарий Webpack, который будет запускатьwebpack.config.js
файл для нас.
Чтобы добавить сценарий Webpack, откройте package.json
и добавьте следующие скрипты в опцию script
:
- "dev": "webpack-dev-server --mode development",
- "build" : "webpack --mode production"
package.json
теперь будет содержать следующие параметры конфигурации:
Теперь давайте создадим простую программу TypeScript, которая будет вычитать два числа. Внутри папки{ "name": "webpack-setup", "version": "1.0.0", "description": "", "main": "src/index.ts", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "webpack-dev-server --mode development", "build": "webpack --mode production" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "css-loader": "^6.7.1", "html-webpack-plugin": "^5.5.0", "mini-css-extract-plugin": "^2.6.1", "ts-loader": "^9.4.1", "webpack": "^5.74.0", "webpack-cli": "^4.10.0", "webpack-dev-server": "^4.11.1" } }
src
создайте index.ts
и добавьте следующий код TypeScript:
Затем создайте еще один файлimport { subtract } from "./app"; function init() { const form = document.querySelector("form"); form?.addEventListener("submit", submitHandler); } function submitHandler(e: Event) { e.preventDefault(); const num1 = document.querySelector("input[name='firstnumber']") as HTMLInputElement; const num2 = document.querySelector("input[name='secondnumber']") as HTMLInputElement; const result = subtract(Number(num1.value), Number(num2.value)); const resultElement = document.querySelector("p"); if (resultElement) { resultElement.textContent = result.toString(); } } init();
app.ts
и добавьте следующий код:
Запуск скрипта dev запустит приложение в режиме разработки:export function subtract(firstnumber: number, secondnumber: number): number { return firstnumber - secondnumber; }
Запуск скрипта build запустит приложение в режиме для продакшен сборки:npm run develop
После выполнения команды build Webpack транспилирует два файла TypeScript в код JavaScript и сгенерируетnpm run build
bundle.js
в папке dist
.
Создание HTML-страниц с помощью HtmlWebpackPlugin
HtmlWebpackPlugin позволяет Webpack генерировать стандартную HTML-страницу, которая будет обслуживать сгенерированные файлы пакета. Когда имя файла пакета изменяется или хэшируется, HTMLWebpackPlugin обновляет имена файлов на HTML-странице. Во-первых, чтобы установить HtmlWebpackPlugin, выполните следующую команду:Далее нам нужно импортировать и добавить HtmlWebpackPlugin в опцию плагина конфигурации Webpack следующим образом:npm install html-webpack-plugin --save-dev
Шаблон представляет собой пользовательский HTML-файл, сгенерированный HtmlWebpackPlugin для вставки в HTML-страницу. Чтобы создать пользовательский HTML-код, внутри папки src создайтеconst HtmlWebpackPlugin = require("html-webpack-plugin"); const path = require('path'); module.exports = { entry: './src/index.ts', module: { rules: [ { test: /\.ts?$/, use: 'ts-loader', exclude: /node_modules/, } ], }, resolve: { extensions: ['.tsx', '.ts', '.js'], }, output: { filename: 'bundle.js', path: path.resolve(__dirname, 'dist'), }, plugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }) ], devServer: { static: path.join(__dirname, "dist"), compress: true, port: 4000, }, };
custom.html
и добавьте следующий HTML-код:
Вам не нужно включать скрипт или теги ссылок в пользовательский HTML. HtmlWebpackPlugin позаботится об этом, связав URL-адрес файла пакета со сгенерированной страницей. При запуске приложения в продакшен режиме файл<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> </head> <body> <div class="cal"> <center> <form><br> <p>Result : <span id="display"></span></p> <input type="number" class="input" placeholder="Enter first number" name="firstnumber" value="1" min="1" min="9" /><br> <input type="number" class="input" placeholder="Enter second number" name="secondnumber" value="1" min="1" min="9" /><br><br> <button type="submit" class="button">Subtract</button> </form> </center> </div> </body> </html>
index.html
появится внутри папки dist
.
Собираем CSS с MiniCSSExtractPlugin
css-loader подсказывает Webpack, как работать с CSS. Он интерпретирует@import
и URL
как import/require
и резолвит их. css-loader позволяет Webpack скомпилировать все CSS файлы и конвертировать их в формат JavaScript.
Объединение CSS-файлов с загрузчиком стилей приводит к тому, что стили HTML-страниц не отвечают на запросы до тех пор, пока bundle.js
полностью не загружен. Загрузчик стилей внедряет CSS в DOM, но собранный JavaScript файл должен быть полностью загружен до внедрения стилей. Чтобы решить эту проблему, мы можем использовать MiniCssExtractPlugin.
MiniCssExtractPlugin извлекает файлы CSS и объединяет их в один bundle.css
файл. Это полезно для уменьшения размера ресурсов CSS и помогает избежать ненужных HTTP-запросов для их загрузки.
Мы можем установить css-loader и MiniCssExtractPlugin, выполнив в терминале следующие команды:
Теперь давайте добавим css-loader и MiniCssExtractPlugin вnpm install css-loader --save-dev npm install mini-css-extract-plugin --save-dev
webpack.config.js
файл.
В верхней части webpack.config.js
импортируйте модуль MiniCssExtractPlugin, используя приведенный ниже код:
Затем мы добавим новое правило в свойство rules следующим образом:const MiniCssExtractPlugin = require("mini-css-extract-plugin");
Когда css-loader компилирует все CSS файлы в JavaScript, MiniCssExtractPlugin.loader загружает CSS в CSS бандл. Далее мы добавим MiniCssExtractPlugin в опцию плагина следующим образом:… { test: /\.css$/, use: [MiniCssExtractPlugin.loader, "css-loader"] } …
Теперь, когда мы настроили css-loader и MiniCssExtractPlugin, давайте создадим CSS-файл и импортируем его вplugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }), new MiniCssExtractPlugin({ filename:"bundle.css" }) ]
index.ts
. Внутри папки src
создайте index.css
и добавьте следующий CSS-код:
Импортируйте CSS-стиль вform { background-color: pink; margin-top: 100px; border-radius: 40px; } .cal { width: 550px; height: 300px; margin-left: 400px; } .button { border-radius: 10px; margin-top: 20px; margin-bottom: 20px; } .input { border-radius: 10px; margin-top: 40px; }
index.ts
следующим образом:
Запускimport styles "./main.css"
npm run build
объединит CSS и применит его к index.html
. Когда вы запускаете приложение в режиме разработки и открываете http://localhost:4000
.
Минимизация CSS
Мы можем использовать css-minimizer-webpack-plugin, чтобы уменьшить размер файлов CSS, удалив неиспользуемые правила CSS и оставив только необходимые. css-minimizer-webpack-plugin находит все неиспользуемые стили. Затем этот плагин удалит эти неиспользуемые стили из вашего окончательного файла CSS, тем самым уменьшив его размер. Выполните приведенную ниже команду установки, чтобы установить css-minimizer-webpack-plugin:Добавим css-minimizer-webpack-plugin в конфигурацию Webpack. Во-первых, импортируйте плагин следующим образом:npm install css-minimizer-webpack-plugin --save-dev
Затем мы добавим новое свойство optimization в конфигурацию Webpack следующим образом:const CssMinimizerPlugin = require("css-minimizer-webpack-plugin");
Когда мы запускаем командуoptimization: { minimizer: [ new CssMinimizerPlugin() ], }
npm run build
, bundle.css
будет минифицироваться, но bundle.js
не будет. Стандартная минификация для bundle.js
была переопределена параметром minimizer
, который мы установили. Чтобы решить эту проблему, нам нужно минифицировать JavaScript с помощью TerserWebpackPlugin.
Минификация JavaScript
В текущей версии Webpack (на момент написания статьи 5.74.0) и более поздних, вам не нужно устанавливать TerserWebpackPlugin, так как он включен из коробки. Во-первых, мы должны импортировать TerserWebpackPlugin:Затем добавьте TerserPlugin в опцию минимизации следующим образом:const TerserPlugin = require("terser-webpack-plugin");
Если вы запустите скриптoptimization: { minimizer: [ new CssMinimizerPlugin(), new TerserPlugin() ], }
npm run build
и посмотрите на файлы в папке dist, вы увидите, что и JavaScript, и CSS минифицированы.
Использование CopyWebpackPlugin
Мы можем настроить Webpack для копирования ресурсов приложения из папки c исходными файлами в папку сборки dist с помощью CopyWebpackPlugin. Этот плагин может копировать такие файлы, как изображения, видео и другие ресурсы, в папкуdist
.
Установите CopyWebpackPlugin с помощью следующей команды:
Теперь добавим CopyWebpackPlugin в конфигурацию Webpack. Импортируйте плагин следующим образом:npm install copy-webpack-plugin --save-dev
Далее мы добавим CopyWebpackPlugin в опцию плагина. Свойствоconst CopyPlugin = require("copy-webpack-plugin");
from
— это папка, из которой мы будем копировать, а to
— это папка в каталоге dist, в которую нужно скопировать все файлы:
Создайте новую папку img и добавьте в нее изображения. После выполнения команды// ... plugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }), new MiniCssExtractPlugin({ filename: "bundle.css" }), new CopyPlugin({ patterns: [ { from: "src/img", to: "img" } ] }), ] // ...
npm run build
образы будут скопированы в dist/img
.
Отладка с помощью source map
Когда мы собираем пакет путем компиляции файлов TypeScript в файлы JavaScript (npm run build
), нам может потребоваться отладить и протестировать код с помощью DevTools нашего браузера.
При отладке кода инструментам разработки браузера вы заметите, что отображаются только собранные файлы. Всякий раз, когда в нашем коде TypeScript есть ошибка, она будет указана только в собранном файле, что затрудняет отслеживание ошибок в TypeScript для исправления. Тем не менее, с source map кода мы можем легко отлаживать TypeScript с помощью DevTools.
Source map кода отображают исходный файл, что упрощает отладку TypeScript и исправление кода и минимизированного кода JavaScript.
Файлы .map содержат сведения как об исходных файлах, так и о собранных файлах. DevTools использует этот файл для сопоставления исходного файла с собранным файлом.
Чтобы сгенерировать .map
для файлов пакета, нам нужно настроить как Webpack, так и TypeScript. В конфигурационном файле TypeScript добавьте sourceMap к параметру компилятора и присвойте ему значение true
:
Далее мы добавим свойство devtool в конфигурацию Webpack и установим его в{ "compilerOptions": { "noImplicitAny": true, "target": "ES5", "module": "ES2015", "sourceMap": true } }
true
, указав Webpack сгенерировать соответствующую карту исходного кода для каждого собранного файла:
Выполнив командуmodule.exports = { devtool: 'source-map', // ... }
npm run build
, вы сможете отлаживать исходный код напрямую.
Итоги
По мере того, как популярность TypeScript продолжает расти, Webpack стал важным вариантом для разработчиков, стремящихся оптимизировать свои проекты. С помощью плагинов Webpack мы можем оптимизировать ресурсы приложения TypeScript. В этом руководстве мы рассмотрели пошаговый процесс настройки Webpack с помощью TypeScript. Мы также узнали, как оптимизировать приложения TypeScript с помощью подключаемых модулей Webpack, и изучили отладку кода TypeScript с помощью карты исходного кода.Единицы измерения viewport в CSS. Все 24 комбинации.
год назад·5 мин. на чтение
В этой статье рассмотрим каждый из шести основных единиц измерения и три модификатора, чтобы вы могли уверенно использовать их во всех ситуациях.
Раньше в CSS было всего четыре единицы измерения, которые вам нужно было знать, и они могли охватить практически все мыслимые варианты использования. Однако со временем и изменением технологий этих четырех единиц уже не хватало для обработки всех вариантов использования. Из-за этого CSS добавил еще 20 единиц измерения области просмотра. Это много, но они разбиты на шесть основных с тремя уникальными модификаторами, что дает нам в общей сложности 24 комбинации.
Модификатор
Модификатор
Модификатор
Модификатор Модификатор
Модификатор
Оригинальные четыре единицы измерения
Основными единицами CSS являютсяvw
, vh
, vmin
и vmax
. Скорее всего, вы использовали или видели их раньше, поэтому рассмотрим их кратко.
vw
vw
расшифровывается как Viewport Width и представляет собой процент от ширины окна просмотра. Число, помещенное перед vw
, представляет собой процент от ширины области просмотра, которой будет эта длина. Например, если вы написали 10vw
, то это будет представлять 10%
от ширины вашего окна просмотра.
Окно просмотра (viewport) — это по сути размер вашего экрана, поэтому, если бы вы были на большом рабочем столе шириной 1920 пикселей, 10vw
означало бы 192 пикселя. Если бы вы вместо этого использовали мобильный телефон шириной 300 пикселей, то 10vw
был бы только 30 пикселей.
vh
vh
расшифровывается как Viewport Height. Он точно такой же, как vw
но для высоты, а не ширины. Эти две единицы можно использовать в комбинации, чтобы легко заставить элемент заполнять весь размер экрана.
.full-screen { width: 100vw; height: 100vh; }
vmin
и vmax
vmin
и vmax
представляют собой максимальное и минимальное измерение области просмотра. Например, если вы работаете на телефоне шириной 300 пикселей и высотой 800 пикселей, vmin
будет представлять ширину области просмотра, а vmax
— высоту устройства. Эти единицы действительно полезны, если вам нужно определить размер элемента на основе наименьшего/наибольшего размера экрана. Например, следующий CSS создаст квадрат, который будет максимально большим, не переполняясь ни в каком направлении, поскольку он никогда не будет больше 100% от наименьшего размера экрана.
.no-overflow { width: 100vmin; height: 100vmin; }
Две новых единицы
CSS пытается отойти от строгой модели верха/низа, слева/справа, высоты/ширины к более динамичной модели начала/конца, блочной/инлайн модели. Основная причина этого изменения заключается в том, чтобы упростить внедрение различных направлений написания в коде. Если все ваше приложение переключается с горизонтального направления письма на вертикальное, идея верха/низа или ширины/высоты не обязательно означает одно и то же, поскольку, если вы хотите добавить отступы выше и ниже текста, это будет представлено как отступы слева и справа в вертикальной системе, а не заполнение сверху и снизу. Вот почему CSS добавил модули просмотраvi
и vb
.
vi
vi
расшифровывается как Viewport Inline и представляет собой встроенное (инлайн) направление вашего документа. В горизонтальном направлении это соответствует ширине окна просмотра, а в вертикальном направлении это соответствует высоте окна просмотра. Самый простой способ запомнить направление встроенного текста — помнить, что это то же направление, в котором движется ваш текст. Еще один способ запомнить это: если у вас есть два встроенных элемента (например, два span
) рядом друг с другом, направление, в котором они складываются, является вашим встроенным направлением.
.horizontal { writing-mode: horizontal-tb; width: 10vi; /* То же, что и 10vw */ } .vertical { writing-mode: vertical-lr; height: 10vi; /* То же, что и 10vh */ }
vb
vb
расшифровывается как Viewport Block и представляет собой направление блока вашего документа. Это противоположно vi
, поэтому в горизонтальном направлении это будет соответствовать высоте окна просмотра, а в вертикальном документе это будет представлять ширину вашего окна просмотра. Если вы изо всех сил пытаетесь запомнить эту единицу, просто помните, что направление блока всегда будет направлением, в котором блочные элементы (например, два div
) будут складываться друг на друга.
.horizontal {
writing-mode: horizontal-tb;
width: 10vb; /* То же, что и 10vh */
}
.vertical {
writing-mode: vertical-lr;
height: 10vb; /* То же, что и 10vw */
}
Модификаторы единиц измерения вьюпорта
До сих пор мы рассмотрели шесть основных типов модулей области просмотра, но есть три различных модификатора, которые вы можете добавить к единицам, чтобы они вели себя по-разному, когда ваше окно просмотра может изменять размеры. Например, когда вы просматриваете веб-страницы на мобильном телефоне, вы можете заметить, что адресная строка исчезает при прокрутке вниз. Когда это происходит, ваше окно просмотра технически меняет размер, так как теперь строка URL-адреса больше не занимает часть вашего окна просмотра. Текущие блоки CSS не имеют возможности справиться с этим изменением размера области просмотра, поэтому были добавлены эти модификаторы. Этими модификаторами являютсяs
, l
и d
. Для того, чтобы использовать модификатор, вам просто нужно разместить модификатор после номера и перед единицей измерения, например 10svw
. Это дает нам 4 комбинации для каждого из 6 модулей области просмотра. vw
, svw
, lvw
и dvw
.
До сих пор все, что мы рассмотрели в этой статье, не использовало модификатор. Если вы не используете модификатор на устройстве, например 10vw
или 10vh
, браузер автоматически по умолчанию использует один из 3 модификаторов в зависимости от реализации браузера.
Модификатор s
Модификатор s
расшифровывается как Small и представляет собой минимально возможное окно просмотра. В нашем примере с мобильным телефоном это будет размер окна просмотра при отображении строки URL. Если вы установите для элемента значение 100svh
он будет занимать 100% высоты экрана в зависимости от размера экрана при отображении строки URL. Неважно, видна ли строка URL-адреса или нет, размер этого устройства всегда будет основываться на том, каким будет окно просмотра, если будет отображаться строка URL-адреса.
Модификатор l
Модификатор l
расшифровывается как Large и представляет собой максимально возможное окно просмотра. Это в значительной степени противоположно модификатору s
. В нашем примере с мобильным телефоном это будет размер окна просмотра, когда строка URL-адреса НЕ отображается. Если вы установите для элемента значение 100lvh
, он будет занимать 100% высоты экрана в зависимости от размера экрана, когда строка URL-адреса НЕ отображается. Неважно, видна ли строка URL-адреса или нет, это устройство всегда будет основывать свой размер на том, каким будет окно просмотра, если строка URL-адреса НЕ отображается. Это означает, что если вы установите элемент на 100lvh
, а строка URL-адреса показывается, то технически он будет больше, чем экран.
Модификатор d
Модификатор d
расшифровывается как Dynamic и представляет текущий размер области просмотра. Это похоже на комбинацию модификаторов s
и l
. В нашем примере с мобильным телефоном это всегда будет размер текущего окна просмотра, независимо от того, отображается ли строка URL-адреса или нет. Если наша строка URL-адреса отображается, то модификатор d
имеет тот же размер, что и модификатор s
, а если строка URL-адреса НЕ отображается, модификатор d
имеет тот же размер, что и модификатор l
.
Во время перехода между отображаемой и скрытой строкой URL-адреса это устройство будет динамически увеличиваться в размерах, поэтому оно всегда будет заполнять все доступное пространство. Это здорово, если вам нужно гарантировать, что размер элемента всегда зависит от области просмотра, но может быть обременительным, поскольку это вызовет много перерисовок, поскольку размер постоянно меняется.