Ссылки на проекты в TypeScript

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

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


SVG-диаграмма: как работают ссылки на проекты Background Title Project References principle Main project Main project (app) package.json tsconfig.json references: [...] Arrow Referenced project 1 Component library (ui) Button, Modal, Input Referenced project 2 Utility library (utils) formatDate, request Referenced project 3 Type definitions (types) User, API Response Arrow marker

Зачем нужны ссылки на проекты

По мере роста проекта один tsconfig.json может замедлить компиляцию.

Ссылки на проекты позволяют разделить проект на независимые подпроекты, каждый из которых можно компилировать отдельно.

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

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


Создание проекта, на который ссылаются

Сначала создайте подпроект, на который будут ссылаться.

packages/utils/tsconfig.json

{
    // Наследовать базовую конфигурацию
    "extends": "../../tsconfig.base.json",

    // Параметры компилятора
    "compilerOptions": {
        // Каталог вывода
        "outDir": "./dist",

        // Каталог файлов объявлений
        "declarationDir": "./dist/types",

        // Генерировать файлы объявлений
        "declaration": true,

        // Сгенерировать sourcemap
        "sourceMap": true,

        // Является ли это библиотекой
        "composite": true
    },

    // Включаемые файлы
    "include": ["src/**/*"],

    // Исключаемые файлы
    "exclude": ["node_modules", "dist", "**/*.test.ts"]
}

composite:Установите значение true, чтобы включить функцию ссылок на проекты; это обязательный параметр для проектов, на которые ссылаются.


Конфигурация основного проекта

Настройте ссылки в tsconfig.json основного проекта.

tsconfig.json (основной проект)

{
    // Наследовать базовую конфигурацию
    "extends": "./tsconfig.base.json",

    // Параметры компилятора
    "compilerOptions": {
        // Каталог вывода
        "outDir": "./dist",

        // Каталог файлов объявлений
        "declarationDir": "./dist/types",

        // Генерировать файлы объявлений
        "declaration": true,

        // Сгенерировать sourcemap
        "sourceMap": true
    },

    // Конфигурация ссылок на проекты
    "references": [
        // Ссылка на проект utils
        { "path": "./packages/utils" },

        // Ссылка на проект ui
        { "path": "./packages/ui" },

        // Ссылка на проект types
        { "path": "./packages/types" }
    ],

    // Включаемые файлы
    "include": ["src/**/*"],

    // Зависимости включают модули node
    // "files": []
}

references:Каждый объект в массиве задаёт путь к проекту, на который делается ссылка; путь указывается относительно текущего проекта.


Ссылки на типы

Используйте типы из проектов, на которые есть ссылки, в коде.

src/index.ts

// Импорт вспомогательных функций (из пакета utils)
import { formatDate, formatCurrency } from '@my-utils/format';

// Импорт компонентов (из пакета ui)
import { Button, Modal, Input } from '@my-ui/core';

// Импорт типов (из пакета types)
import { User, ApiResponse } from '@my-types/common';

// Определить данные пользователя
const user: User = {
    id: 1,
    name: "Alice",
    email: "alice@example.com"
};

// Форматировать дату
const dateStr = formatDate(new Date(), "YYYY-MM-DD");
console.log("Дата: " + dateStr);

// Форматировать валюту
const price = formatCurrency(999);
console.log("Цена: " + price);

// Создать пользовательский интерфейс
const button = new Button({
    text: "Отправить",
    variant: "primary"
});

console.log("Приложение успешно инициализировано");

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


Инкрементальные сборки

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

Команды сборки

# Собрать весь проект (включая все ссылки)
npm run build

# Собрать только основной проект (не пересобирать зависимости)
npm run build -- --build

# Очистка и пересборка
npm run clean
npm run build

# Инкрементальная сборка (рекомендуется)
# После изменения пакета перекомпилируйте только этот пакет и пакеты, которые от него зависят
npx tsc -b packages/utils
npx tsc -b packages/ui
npx tsc -b .

Инкрементальная сборка:При использовании параметра -b (build) TypeScript автоматически определяет, какие проекты нужно перекомпилировать.


Примечания

  • Параметр composite:Проекты, на которые ссылаются, должны установить composite: true
  • Каталог вывода:Каждому проекту нужен независимый каталог вывода
  • Файлы объявлений:Проекты, на которые ссылаются, должны генерировать файлы объявлений
  • Порядок сборки:Проекты, от которых зависят другие, должны быть собраны первыми

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


Итог

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

  • references:Настройте взаимосвязи ссылок на проекты
  • composite:Включите ссылки на проекты
  • Инкрементальная сборка:Компилируйте только изменённые части
  • Организация кода:Разделите на независимые модули

Совет:В больших проектах используйте ссылки на проекты для организации кода и повышения эффективности разработки.

Другие расширения