Создание tree-shaking библиотеки с Rollup и Vue

Почему не Webpack для создания библиотеки?

Webpack можно использовать для основного приложения (проекта), которое будет использовать нашу UI библиотеку (для которой выбрали Rollup). Мы используем Rollup для компиляции библиотеки, потому что Webpack не поддерживает формат вывода ES6 (пока) Webpack хорошо подойдет для сборки основного проекта, поскольку он поддерживает встроенное встряхивание дерева и может объединять код, отличный от JS. Единственное предостережение относительно алгоритма встряхивания дерева Webpack заключается в том, что он вряд ли может определить, вызывает ли код побочные эффекты при импорте, поэтому в package.json библиотеки следует добавить ключ sideEffects, для которого можно установить значение false, если библиотека не запускает побочные эффекты.

// В библиотеке нет сайд эффектов
{
  …
  "sideEffects": false
}

// Все *.scss, которые при импорте будут вызывать сайд эффекты
{
  …
  "sideEffects": [ "src/**/*.scss" ]
}

Некоторые понятия

Давайте определим некоторые понятия, чтобы пост был понятнее:

• Tree shaking (встряхивание дерева) - это термин, широко используемый в контексте JavaScript, чтобы описать удаление неиспользуемого кода. Он основан на операторах import и export в ES2015 для определения, были ли кодовые модули экспортированы и импортированы для использования в JavaScript-файлах.
• Однофайловые Vue компоненты (SFC) - это способ определения компонентов в VueJS с помощью файлов .vue, которые включают шаблон, скрипт и стиль в одном файле. Другие способы определения компонентов VueJS - это обычный JavaScript (с помощью Vue.extent(...)) и JSX.

Почему нужна поддержка tree shaking?

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

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

Требования к библиотеке для поддержки tree shaking

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

• Она должна быть экспортирована в формате ES6, конкретно с использованием синтаксиса import/export (а не синтаксиса require CommonJS). Таким образом, код статически анализируем, и поэтому можно определить, используется ли код или нет.
• Он не должен быть упакован (bundled). Это облегчает работу компилятора, изолируя код по модулям и не объединяя все в один файл.
• Модули, которые мы хотим встряхнуть, не должны вызывать побочных эффектов. Это означает, что они не должны изменять глобальные переменные или вызывать любые другие виды действий с побочными эффектами при импортировании.

Конфигурация Rollup

Обычно настройка Rollup для tree shaking довольно прямолинейна, но в этом случае есть некоторые ограничения:

• TypeScript нужно скомпилировать в ES6 JavaScript
• VueJS SFC нужно скомпилировать в ES6 JavaScript

Rollup может сохранить модули в отдельных файлах, но сохраняет оригинальное название (так что файлы TypeScript останутся .ts, то же самое для файлов .vue). Мы фактически получаем файлы TypeScript и Vue, но с содержимым JavaScript. Для этого нам нужно использовать некоторые плагины в Rollup:

• rollup-plugin-typescript2 для компиляции TypeScript в JavaScript
• rollup-plugin-vue для компиляции Vue SFC в JavaScript
• renameExtensions для переименования .ts и .vue в .js.

Файлы конфигурации

package.json

{
  "name": "your-library-name",
  "version": "0.1.0",
  "module": "dist/index.js",
  "sideEffects": false,
  "scripts": {
    "build": "rollup --config ./config/rollup.config.js",
    "serve": "rollup --config ./config/rollup.config.js --watch",
    "test": "jest --config ./config/jest.config.js --rootDir ."
  },
  "devDependencies": {
    "@betit/rollup-plugin-rename-extensions": "^0.0.4",
    "@types/jest": "^24.0.15",
    "@vue/test-utils": "^1.0.0-beta.29",
    "babel-core": "^6.26.3",
    "babel-loader": "^7.1.5",
    "babel-preset-vue": "^2.0.2",
    "jest": "^24.8.0",
    "jest-serializer-vue": "^2.0.2",
    "postcss": "^7.0.17",
    "rollup": "^1.16.7",
    "rollup-plugin-cleaner": "^1.0.0",
    "rollup-plugin-commonjs": "^10.0.1",
    "rollup-plugin-typescript2": "^0.22.0",
    "rollup-plugin-vue": "^5.0.1",
    "standard-changelog": "^2.0.18",
    "ts-jest": "^24.0.2",
    "ts-loader": "^6.0.4",
    "typescript": "^3.5.3",
    "vue": "^2.6.10",
    "vue-jest": "^3.0.4",
    "vue-loader": "^15.7.0",
    "vue-property-decorator": "^8.2.1",
    "vue-template-compiler": "^2.6.10"
  },
  "peerDependencies": {
    "vue": "^2.6.10"
  }
}

rollup.config.js

import vue from 'rollup-plugin-vue'
import typescript from 'rollup-plugin-typescript2'
import renameExtensions from '@betit/rollup-plugin-rename-extensions'
import cleaner from 'rollup-plugin-cleaner'
import commonjs from 'rollup-plugin-commonjs'
export default {
  input: 'index.js',
  output: {
    format: 'esm', // Это то, что говорит rollup использовать ES6 модули
    dir: 'dist'
  },
  external: [ 'vue', 'vue-class-component' ],
  plugins: [
    cleaner({ targets: [ 'dist' ] }),
    commonjs(),
    typescript({ rollupCommonJSResolveHack: true, clean: true }),
    // Это расширение переименовывает .vue и .ts в .js и обновляет импорты
    renameExtensions({
      include: ['**/*.ts', '**/*.vue'],
      mappings: { '.vue': '.vue.js', '.ts': '.js' }
    }),
    vue()
  ],
  // Предотвращает бандлинг, но не переименовывает файлы
  preserveModules: true
}

Содержание туториала по TypeScript Каждое значение в JavaScript имеет определенное поведение, которое можно наблюдать при выполнении различных операций. Звучит абстрактно, но в качестве быстрого примера рассмотрим некоторые операции, которые мы можем выполнять над переменной с именем message.

// Получение свойства 'toLowerCase' переменной 'message' и его вызов
message.toLowerCase();

// Вызов 'message'
message();

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

• Можно ли вызвать message?
• Есть ли у него свойство toLowerCase?
• Если это так, можно ли вызвать toLowerCase?
• Если оба эти значения можно вызвать, что они возвращают?

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

const message = 'Hello World!';

Как вы, наверное, догадались, если мы попытаемся запустить message.toLowerCase(), мы получим ту же строку, только в нижнем регистре. А как насчет второй строки кода? Если вы знакомы с JavaScript, вы знаете, что это вызовет исключение:

TypeError: message is not a function

Было бы здорово, если бы мы могли избежать подобных ошибок. Когда мы запускаем наш код, среда выполнения JavaScript выбирает, что делать, выясняя тип значения — каким поведение оно обладает и какие возможности у него есть. Это часть того, на что намекает TypeError — это говорит о том, что строку Hello World! нельзя вызывать как функцию. Для некоторых значений, таких как примитивы string и number, мы можем определить их тип во время выполнения с помощью оператора typeof. Но для других вещей, таких как функции, нет соответствующего механизма времени выполнения для определения их типов. Например, рассмотрим эту функцию:

function fn(x) {
  return x.flip();
}

Читая код, мы можем заметить, что эта функция будет работать только в том случае, если задан объект с вызываемым свойством flip, но JavaScript не отображает эту информацию таким образом, чтобы мы могли проверить ее во время выполнения кода. Единственный способ в чистом JavaScript узнать, что делает fn с конкретным значением — это вызвать его и посмотреть, что произойдет. Такое поведение затрудняет прогнозирование того, что будет делать код до его запуска, а это означает, что сложнее узнать, что будет делать ваш код, пока вы его пишете. С этой точки зрения тип — это понятие, описывающее, какие значения могут быть переданы в fn, а какие приведут к ошибке. JavaScript действительно обеспечивает только динамическую типизацию — нужно запустить код, чтобы увидеть, что происходит. Альтернативой является использование статической системы типов для предсказания того, какой код ожидается до его запуска.

Статическая проверка типов

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

const message = "hello!";

message();
This expression is not callable.
  Type 'String' has no call signatures.

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

Ошибки не вызывающие исключений

До сих пор мы обсуждали некоторые вещи, такие как ошибки времени выполнения — случаи, когда среда выполнения JavaScript сообщает нам, что считает что-то бессмысленным. Такие случаи возникают из-за того, что в спецификации ECMAScript есть четкие инструкции о том, как язык должен вести себя, когда он сталкивается с чем-то непредвиденным. Например, в спецификации сказано, что попытка вызвать что-то, что нельзя вызвать, должна выбросить ошибку. Возможно, это звучит как «очевидное поведение», но вы можете себе представить, что доступ к свойству, не существующему в объекте, также должен вызывать ошибку. Вместо этого JavaScript дает нам другое поведение и возвращает значение undefined:

const user = {
  name: 'Daniel',
  age: 26,
};
user.location; // возвращает undefined

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

const user = {
  name: 'Daniel',
  age: 26,
};

user.location;

// Property 'location' does not exist on type '{ name: string; age: number; }'.

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

const announcement = 'Hello World!';

// Как быстро вы можете заметить опечатку?
announcement.toLocaleLowercase();
announcement.toLocalLowerCase();

// Возможно, мы имели ввиду это...
announcement.toLocaleLowerCase();

невызванные функции,

function flipCoin() {
  // Имелось ввиду Math.random()
  return Math.random < 0.5;

  // Оператор '<' не может применяться к типам '() => number' и 'number'.
}

или простые логические ошибки.

const value = Math.random() < 0.5 ? 'a' : 'b';
if (value !== 'a') {
  // ...
} else if (value === 'b') {
  // Это условие всегда будет возвращать 'false', т.к. типы '"a"' и '"b"' не пересекаются.
  // Не достижимый код
}

IDE инструменты TypeScript

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

tsc компилятор TypeScript

Мы говорили о проверке типов, но мы еще не использовали его на практике. Давайте познакомимся с новым функционалом - это tsc - компилятором TypeScript. Сначала нам нужно установить его через npm.

npm install -g typescript

Эта команда устанавливает tsc - компилятор TypeScript - глобально. Вы можете использовать npx или аналогичные инструменты, если предпочитаете запускать tsc из локального node_modules. Теперь давайте перейдем в пустую папку и попробуем написать нашу первую программу на TypeScript: hello.ts:

// Приветствует мир
console.log('Hello world!');

Обратите внимание, что здесь нет никаких дополнений; эта программа «hello world» выглядит также, как написанная на JavaScript. А теперь давайте проверим эту программы на типы, выполнив команду tsc, которая была установлена пакетом typescript.

tsc hello.ts

Что произошло при вызове этого кода. Мы запустили tsc и ничего не произошло! Ошибок типов не было, поэтому мы не получили никакого сообщения в консоли, поскольку сообщать было не о чем. Но проверьте еще раз — вместо этого мы получили какой-то файл. Если мы посмотрим в текущий каталог, то увидим файл hello.js рядом с hello.ts. Это результат полученный из файла hello.ts после того, как tsc скомпилировал (или преобразовал) его в обычный файл JavaScript. И если мы проверим содержимое, то увидим, что выдал TypeScript после обработки файла .ts:

// Приветствует мир
console.log('Hello world!');

В этом случае очень мало того, что может преобразовать TypeScript, поэтому код выглядит идентично тому, что мы написали. Компилятор пытается создать чистый читаемый код, похожий на то, что написал бы человек. Хотя это не всегда так просто, TypeScript постоянно делает отступы, учитывает, когда наш код включает разные строки кода, и старается сохранять комментарии. А если бы мы добавили ошибку проверки типов? Давайте перепишем hello.ts:

function greet(person, date) {
  console.log(`Hello ${person}, today is ${date}!`);
}

greet('Brendan');

Если мы снова запустим tsc hello.ts, мы получим ошибку в командной строке.

Expected 2 arguments, but got 1.

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

Компиляция с отображением ошибок

В последнем примере вы могли не заметить, что наш файл hello.js снова изменился. Если мы откроем этот файл, мы увидим, что содержимое по-прежнему в основном выглядит так же, как наш входной файл. Это может показаться немного удивительным, учитывая тот факт, что tsc сообщил об ошибке в нашем коде, но это основано на одной из основных ценностей TypeScript: большую часть времени вы будете знать лучше, чем TypeScript. Повторим сказанное ранее: код проверки типов ограничивает количество программ, которые вы можете запускать, поэтому существует компромисс между тем, какие вещи программа проверки типов считает приемлемыми. В большинстве случаев это нормально, но бывают ситуации, когда эти проверки мешают. Например, представьте, что вы переносите код JavaScript на TypeScript и вносите ошибки проверки типов. В конце концов вы научитесь наводить порядок для системы проверки типов, но исходный код и так был JavaScript рабочим. Почему преобразование его в TypeScript должно помешать вам запустить его? Так что TypeScript не мешает вам. Конечно, со временем вы, возможно, захотите стать немного более защищенным от ошибок и заставить TypeScript действовать более строго. В этом случае вы можете использовать параметр компилятора noEmitOnError. Попробуйте изменить файл hello.ts и запустить tsc с этим флагом:

tsc --noEmitOnError hello.ts

Вы заметите, что hello.js больше не обновляется.

Явные типы

До сих пор мы не сообщали TypeScript, что такое person или date. Давайте отредактируем код, чтобы сообщить TypeScript, что person — это строка, а date должна быть объектом Date. Мы также будем использовать метод toDateString() для даты.

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

Что мы сделали, так это добавили аннотации типа для person и date, чтобы описать, с какими типами значений может быть вызвана функция greet. Вы можете прочитать эту сигнатуру как "greet принимает person типа string и date типа Date». Таким образом, TypeScript может рассказать нам о других случаях, когда greet могло быть вызвано неправильно. Например...

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

greet('Maddison', Date());
// Argument of type 'string' is not assignable to parameter of type 'Date'.

Хм? TypeScript сообщил об ошибке во втором аргументе, но почему? Удивительно, но вызов Date() в JavaScript возвращает строку. С другой стороны, создание Date с помощью new Date() фактически дает нам то, что мы ожидали. В любом случае, мы можем быстро исправить ошибку:

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

greet('Maddison', new Date());

Имейте в виду, что нам не всегда нужно писать явные аннотации типов. Во многих случаях TypeScript может даже просто вывести (или «вычислить») типы за нас, даже если мы их опустим.

let msg = 'hello there!';

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

Удаление типов

Давайте посмотрим, что произойдет, когда мы скомпилируем приведенную выше функцию greeting с помощью tsc для вывода JavaScript:

'use strict';
function greet(person, date) {
  console.log(
    'Hello '.concat(person, ', today is ').concat(date.toDateString(), '!')
  );
}
greet('Maddison', new Date());

Обратите внимание на две вещи:

• Параметры person и date больше не имеют аннотаций типа.
• Наш шаблонный литерал — та строка, в которой использовались обратные кавычки (символ ```), — была преобразована в простые строки с конкатенацией.

Подробнее о втором пункте поговорим позже, а сейчас давайте сосредоточимся на первом пункте. Аннотации типов не являются частью JavaScript (или ECMAScript, если быть точнее), поэтому на самом деле не существует браузеров или других сред выполнения, которые могут просто запускать TypeScript без изменений. Вот почему TypeScript в первую очередь нуждается в компиляторе — ему нужен какой-то способ удалить или преобразовать любой специфичный для TypeScript код, чтобы вы могли его запустить. Большая часть кода, специфичного для TypeScript, стирается, и точно так же здесь были полностью стерты аннотации типов. Помните: аннотации типов никогда не изменяют поведение вашей программы во время выполнения.

Понижение версии

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

`Hello ${person}, today is ${date.toDateString()}!`;

в

'Hello ' + person + ', today is ' + date.toDateString() + '!';

Почему это случилось? Шаблонный литерал — это фича версии ECMAScript под названием ECMAScript 2015 (он же ECMAScript 6, ES2015, ES6 и т.д.). TypeScript имеет возможность переписывать код с более новых версий ECMAScript на более старые, такие как ECMAScript 3 или ECMAScript 5 (также известные как ES3 и ES5). Этот процесс перехода от более новой или «более высокой» версии ECMAScript к более старой или «более низкой» версии иногда называют понижением уровня. По умолчанию TypeScript выводит ES3, чрезвычайно старую версию ECMAScript. Мы могли бы выбрать что-то более свежее, используя опцию target. Запуск с --target es2015 изменяет TypeScript на целевой ECMAScript 2015, что означает, что код должен работать везде, где поддерживается ECMAScript 2015. Таким образом, запуск tsc --target es2015 hello.ts дает нам следующий результат:

function greet(person, date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}
greet('Maddison', new Date());

Строгость

Разные пользователи приходят в TypeScript в поисках разных вещей в системе проверки типов. Некоторым людям нужно больше необязательности в применении TypeScript, которая может помочь проверить только некоторые части их программы и при этом иметь приличный инструментарий. Это стандартный опыт работы с TypeScript, где типы являются необязательными, для вывода используются самые мягкие типы, и нет проверки значений на потенциальные null/undefined. Подобно тому, как tsc выдает сообщения об ошибках, эти значения по умолчанию устанавливаются, чтобы не мешать вам. Если вы переносите существующий JavaScript, это может быть желательным первым шагом. Напротив, многие пользователи предпочитают, чтобы TypeScript проверял как можно больше сразу, и поэтому язык также предоставляет настройки строгости. Эти настройки строгости превращают статическую проверку типов из переключателя (независимо от того, проверяется ваш код или нет) во что-то более близкое к шкале. Чем больше вы поворачиваете этот переключатель, тем больше TypeScript будет проверять. Это может потребовать небольшой дополнительной работы, но в целом это окупается в долгосрочной перспективе и позволяет проводить более тщательные проверки и использовать более точные инструменты. Когда это возможно, новая кодовая база всегда должна включать эти проверки строгости. TypeScript имеет несколько флагов строгости проверки типов, которые можно включать и выключать, и все наши примеры будут написаны со всеми этими флагами, если не указано иное. Флаг strict в CLI "strict": true в tsconfig.json включает их все одновременно, но мы можем отказаться от них по отдельности. Вам следует знать о двух наиболее важных из них: noImplicitAny и strictNullChecks.

noImplicitAny

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

strictNullChecks

По умолчанию такие значения, как null и undefined, могут быть присвоены любому другому типу. Это может облегчить написание кода, но забывание обрабатывать null и undefined является причиной бесчисленных ошибок — некоторые считают это ошибкой на миллиард долларов! Флаг strictNullChecks делает обработку null и undefined более явной и избавляет нас от беспокойства о том, не забыли ли мы обработать null и undefined.