Параметры компилятора в MSBuild

Обзор

При работе с проектом на основе MSBuild, использующим TypeScript (например, проектом ASP.NET Core), можно настроить TypeScript двумя способами. Либо через tsconfig.json , либо через настройки проекта.

Использование tsconfig.json

Рекомендуется использовать tsconfig.json для вашего проекта, когда это возможно. Чтобы добавить его в существующий проект, добавьте новый элемент в проект, который называется «Файл конфигурации TypeScript JSON» в современных версиях Visual Studio.

Новый tsconfig.json затем будет использоваться в качестве источника информации о сборке, специфичной для TypeScript, таких как файлы и настройки. Вы можете узнать о работе TSConfigs здесь, а также есть полная справка здесь.

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

Вы также можете определить конфигурацию TypeScript внутри настроек вашего проекта. Это делается путем редактирования XML в вашем .csproj для определения PropertyGroups , которые описывают, как может работать сборка:

<PropertyGroup>
  <TypeScriptNoEmitOnError>true</TypeScriptNoEmitOnError>
  <TypeScriptNoImplicitReturns>true</TypeScriptNoImplicitReturns>
</PropertyGroup>

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

Сопоставления параметров командной строки

Дополнительные флаги

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

Например, это включит noPropertyAccessFromIndexSignature:

<TypeScriptAdditionalFlags> $(TypeScriptAdditionalFlags) --noPropertyAccessFromIndexSignature</TypeScriptAdditionalFlags>

Debug и Release сборки

Вы можете использовать условия PropertyGroup для определения различных наборов конфигураций. Например, распространённая задача — удаление комментариев и sourcemap в производственной сборке. В этом примере мы определяем группы свойств debug и release, которые имеют различные конфигурации TypeScript:

<PropertyGroup Condition="'$(Configuration)' == 'Debug'">
  <TypeScriptRemoveComments>false</TypeScriptRemoveComments>
  <TypeScriptSourceMap>true</TypeScriptSourceMap>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)' == 'Release'">
  <TypeScriptRemoveComments>true</TypeScriptRemoveComments>
  <TypeScriptSourceMap>false</TypeScriptSourceMap>
</PropertyGroup>

<Import
    Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets"
    Condition="Exists('$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets')" />

ToolsVersion

Значение свойства <TypeScriptToolsVersion>1.7</TypeScriptToolsVersion> в файле проекта определяет версию компилятора, используемую для сборки (1.7 в этом примере). Это позволяет проекту строиться на основе одних и тех же версий компилятора на разных машинах.

Если TypeScriptToolsVersion не указано, для сборки будет использоваться последняя версия компилятора, установленная на компьютере.

Пользователи, использующие более новые версии TS, увидят запрос на обновление проекта при первом запуске.

TypeScriptCompileBlocked

Если вы используете другой инструмент сборки для сборки своего проекта (например, gulp, grunt и т.д.) и VS для разработки и отладки, установите <TypeScriptCompileBlocked>true</TypeScriptCompileBlocked> в вашем проекте. Это должно предоставить всю поддержку редактирования, но не сборку при нажатии F5.

TypeScriptEnableIncrementalMSBuild (TypeScript 4.2 Beta и новее)

По умолчанию MSBuild попытается запустить компилятор TypeScript только тогда, когда исходные файлы проекта были обновлены с момента последней компиляции. Однако, если это поведение вызывает проблемы, такие как при включенном параметре TypeScript incremental, установите <TypeScriptEnableIncrementalMSBuild>false</TypeScriptEnableIncrementalMSBuild> для обеспечения запуска компилятора TypeScript при каждом запуске MSBuild.