Где хранить переиспользуемые интерфейсы typescript?

Question

[Андрей Охотников]

Разворачиваю проект на реакт. Где и как хранить переиспользуемые по всему проекту интерфейсы? Если в корне проекта создать файл interfaces.d.ts и складывать все в него - это законно? И создать директорию models и по отдельным файлам кидать туда ?

Answer 1

[Антон Швец]

Незаконно, файлы d.ts это для библиотек, написанных на js, которым нужны тайпинги.
Если проект на typescript, то типы и интерфейсы следует импортировать явно.
Либо из models(interfaces, types, ...whatever), либо из сервисов, которые с этими типами работают.
Я склоняюсь к модульной структуре, т.е. интерфейсы лежат в отдельной папке, рядом с тем местом, где они применяются.

Comments

[Robur]

Я однажды использовать .d.ts в проекте на тайпскрипт и за мной никто не приехал!

А если серьезно то это не правда

файлы d.ts это для библиотек, написанных на js, которым нужны тайпинги.

Они могут быть полезны и в других случаях.

В самом тайпскрипте лежит очень много всего в d.ts что не относится к библиотеками написанным js и вообще к какому-либо JS коду никаким боком.

[Антон Швец]

Robur, использовать я тоже могу многое, но это не значит что так и надо.
Я тоже когда начинал писать на ts делал для себя файлы деклараций, но быстро стало понятно что это неправильно.

В самом тайпскрипте лежит очень много всего в d.ts

Серьезно?
там d.ts для описания типов стандартных объектов, например DOM. Плюс декларации для тестов, написанных на js.

А в основном везде нормальные экспорты интерфейсов и типов. Везде в тайпскрипте типы импортируются.

[Robur]

Антон Швец, Серьезно, вы когда отвлечетесь от мыслей о прекрасном коде, сходите посмотрите.
И мне кажется вы не поняли о чем я говорю. Там в моем ответе подробнее, повторяться не буду.

[Антон Швец]

Robur, из моего коммента вроде понятно, что я именно что сходил посмотрел.

[Robur]

Антон Швец, нет, непонятно, плохо видимо смотрели, иначе вы бы знали что там не только

там d.ts для описания типов стандартных объектов, например DOM. Плюс декларации для тестов, написанных на js.

а еще и другие вещи, которые можно точно так же и в своем проекте ложить в свои d.ts. И если это нормально для людей которые разрабатывают TS, думаю и остальным такой подход сгодится.

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

[Антон Швец]

Robur, нет там других вещей.
Все типы, используемые в typescript файлах описаны в typescript файлах, я это уже говорил.
Дефиниции - для описания типов в js коде, и еще эталонные файлы для тестов.

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

[Robur]

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

Так и быть, я вам помогу с одним примером, самым простым:
https://github.com/Microsoft/TypeScript/blob/maste...
Остальные, я надеюсь, вы все же в состоянии найти сами.
Надеюсь вы понимаете разницу между интерфейсом к DOM объекту или какому-то js коду и чистым типом который ни какую конкретную сущность в js не описывает.

И зачем могут понадобиться d.ts в чистом тайпскрипте проекте, и какая от них польза, когда они нужны и когда нет, тоже со временем надеюсь поймете.

[Антон Швец]

Robur, Partial, Optional и прочие туда поместили, потому что эти типы стандартные для всего typescript и используются в проектах.
Фактически это глобальные библиотечные типы тайпскрипта и не относятся к исходникам. Надеюсь вы в состоянии осознать разницу. (тут я воспользуюсь вашим же милым стилем)

Не убедили.
Но попытка хорошая, я ожидал что вы меня в lib/typescriptServices.d.ts отправите.

Answer 2

[Robur]

Законно, по крайней мере пока еще не запретили, но возможно мы к этому когда-нибудь придем.
Храните как вам удобно - интерфейсы бывают разные, если это вообще глобальные - то в один файл в корне, но таких на самом деле обычно мало и больше тайп-конвертеры.
Чаще всего интерфейсы описывают какие-то сущности, кладите их туда же где и код который отвечает за эти сущности.
Например если у вас есть стор и в нем какие-то данные описанные интерфейсами - кладите рядом с данными и экспортируйте оттуда.
Если есть апи которое возвращает данные и для этих данных есть интерфейсы - кладите рядом с апи. И так далее.
Можно прямо в файлах с логикой, можно рядом в файле чисто с интерфейсами. Мне удобнее все в одном - так как если что-то меняется в интерфейсе то обычно меняется вместе с логикой.