@microsoft/api-extractor

Меня раздражают почти все потребительские продукты Microsoft, но то, что они делают для разработчиков, действительно воодушевляет.

Среди ассортимента крутых тулзов от них имеется api-extractor — утилита, которая, как следует из названия, "извлекает API" вашей библиотеки.

Под этим "извлечением" подразумевается сбор типов и комментариев в коде (для которых, кстати, разработана спецификация tsdoc) и формализация их в виде модели API библиотеки.

Возможно, звучит довольно скучно, но на практике эта модель позволяет без дополнительных телодвжений:

— упаковывать все *.d.ts файлы в один общий index.d.ts со всеми экспортируемыми типами;

— валидировать публичный API библиотеки и централизованно следить за его изменениями, чтобы по более явным критериям определять наличие "breaking changes" при очередном релизе (с помощью автоматически генерируемого файла api-report.md, который попадает в пулл реквесты и тоже становится предметом обсуждения);

— автоматически генерировать документацию по библиотеке (с помощью api-documenter);

— придумайте свой юзкейс.

Этот инструментарий уже зарекомендовал себя в опенсорс разработке и используется, например, в redux-toolkit.

#docs #tools #build