TypeScript 2: пользовательские типы для нетипизированного модуля npm

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

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

error TS2688: Cannot find type definition file for 'lodash'.

эта ошибка на самом деле не исходит от вашего импорта или ссылок или вашей попытки использовать lodash в любом месте ваших файлов ts. А это исходит из непонимания того, как использовать typeRoots и types свойства, поэтому давайте рассмотрим их немного подробнее.

дело в том, что typeRoots:[] и types:[] свойства заключается в том, что они не универсальные способы загрузки произвольного объявления (*.d.ts) файлов.

эти два свойства напрямую связаны с новой функцией TS 2.0, которая позволяет упаковывать и загружать объявления ввода из пакеты NPM.

это очень важно понимать, что они работают только с папками в формате NPM (т. е. папка, содержащая пакета.json или .д.ТС).

по умолчанию typeRoots - это:

{
   "typeRoots" : ["node_modules/@types"]
}

по умолчанию это означает, что typescript войдет в node_modules/@types папка и попробуйте загрузить каждую подпапку, которую он находит там как npm package.

важно понимать, что это произойдет, если папка не имеет структуры пакета npm.

это то, что происходит в вашем случае, и источник вашей первоначальной ошибки.

вы переключили typeRoot, чтобы быть:

{
    "typeRoots" : ["./typings"]
}

это означает, что typescript теперь будет сканировать на подпапках и попробуйте загрузить каждую подпапку, которую он находит в качестве модуля npm.

так давайте притворимся, что вы только чтоtypeRoots настройка, чтобы указать на ./typings но еще не было types:[] настройки собственность. Вы, вероятно, увидите эти ошибки:

error TS2688: Cannot find type definition file for 'custom'.
error TS2688: Cannot find type definition file for 'global'.

это так tsc сканирует ваш ./typings папка и поиск подпапок custom и global. Затем он пытается интерпретировать их как тип пакета npm, но нет index.d.ts или package.json в этих папках и так вы получите ошибку.

теперь давайте немного поговорим о types: ['lodash'] свойства. Что это делает? По умолчанию, машинопись будет загружаться все подпапки он находит в вашем typeRoots. Если вы укажете types: свойство он будет загружать только эти конкретные подпапки.

в вашем случае вы говорите это, чтобы загрузить ./typings/lodash папка, но она не существует. Вот почему вы получаете:

error TS2688: Cannot find type definition file for 'lodash'

Итак, давайте подведем итог тому, что мы узнали. Typescript 2.0 представил typeRoots и types для загрузки файлов объявлений, упакованных в npm-пакетов. Если у вас есть обычай typings или один свободный d.ts файлы, которые не содержатся в папке после соглашений пакета npm, то эти два новых свойства не то, что вы хотите использовать. Typescript 2.0 на самом деле не меняет, как они будут потребляться. Вам просто нужно включить эти файлы в контекст компиляции одним из многих стандартных способов:

1. непосредственно включая его в : ///<reference path="../typings/custom/lodash.d.ts" />

2. в том числе ./typings/custom/lodash.d.ts in ваш files: [] собственность.

3. в том числе ./typings/index.d.ts в своем files: [] свойство (которое затем рекурсивно включает в себя другие типы.

4. добавлять ./typings/** на includes:

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

EDIT:

одна вещь, которую я забыл упомянуть, что typeRoots и types свойства действительно полезны только для автоматическая загрузка глобальных деклараций.

например, если вы

npm install @types/jquery

и вы используете tsconfig по умолчанию, тогда этот пакет типов jquery будет загружен автоматически и $ будут доступны во всех ваших скриптах без необходимости делать что-либо дальше ///<reference/> или import

The typeRoots:[] свойство предназначено для добавления дополнительных местоположений из где типа пакетов будет загружен frrom автоматически.

The types:[] основной вариант использования свойства-отключить автоматическое поведение загрузки (установив его в пустой массив), а затем только перечислить конкретные типы, которые вы хотите включить глобально.

другой способ загрузки пакетов типа из различных typeRoots использовать новый