Language-tools: Документирование компонентов с помощью строки документации, которая появляется в документации при наведении курсора

Поскольку это также может быть полезно для компонентов без тега сценария, я предлагаю использовать для этого HTML-комментарий. Затем svelte2tsx будет искать HTML-комментарии, начинающиеся со специального тега (например, @doc ), и помещать содержимое в виде jsdoc над экспортом по умолчанию.

Мнения? Другие идеи?

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

На ум приходит следующее:

/**
 * <strong i="6">@file</strong> Here is my documentation for this component
 */

В начале файла. Но я думаю, что там работают только HTML-комментарии, верно?

Кроме того, возможно, чтобы сделать его более похожим на другие теги, я чувствую, что тег <svelte:documentation> похожий на <svelte:head> может быть неплохим, но это необходимо реализовать в компиляторе.

Может, даже <svelte:options documentation="blabla" /> ?

Это также потребует некоторой доработки в компиляторе и утверждения основного репо. Параметры проверены компилятором.

Я создал аналогичную задачу на основном репо, посмотрим, сможем ли мы прийти к какому-то выводу: +1:

Половина этого делается после объединения https://github.com/sveltejs/language-tools/pull/282 . LSP не отображал строки документации при наведении курсора.

Теперь мне нужно получить строку документации из HTML-комментария @doc и добавить ее в addComponentExport в svelte2tsx.

@dummdidumm В настоящее время невозможно добавить строки документации к экспорту по умолчанию, поскольку они не имеют имени:

export default class {
    $$prop_def = __sveltets_partial(render().props)
    $$slot_def = render().slots
}

Я полагаю, поскольку единственное, что может происходить в корневой области каждого файла, - это render и экспорт по умолчанию, тогда безвредно давать ему общее имя, например Component ? А может ковырять по названию файла?

Да, это не должно быть проблемой.

Оказывается ли когда-либо в этом коде часть среды выполнения приложения, или он нужен только для поддержки инструментов?

Просто для инструмента.
Об этом экспорте по умолчанию: нам нужно проверить, как это влияет на автозаполнение импорта.

Правильно, хм. Я не понимаю, как это работает сейчас. Если я попытаюсь эмулировать его в среде только для TS, например:

// Component.ts
export default class {}

У меня нет автозаполнения для Component в других файлах, но на Svelte это как-то работает. Мне, вероятно, следует прочитать соответствующий код в LSP.

В любом случае, если я сделаю это вместо этого:

// Component.ts
export default class Component {}

Затем я получаю автозаполнение для экспорта по умолчанию как Component для других файлов. Поэтому я поддерживаю безопасную ставку - на данный момент назовите экспорт по умолчанию таким же, как файл, а затем протестируйте его вживую.

Хорошо, я пробовал два варианта, но с нашим LSP единственное, что работает для автозаполнения импорта компонентов, это:

export default class {
  // etc
}

Вещи, которые я пробовал:

• Объявление класса и его экспорт по умолчанию в другой строке.
• Добавление имени прямо в строку export default class Name .

~ Ни один из них не работает. Теперь я ищу поставщика завершения (https://github.com/sveltejs/language-tools/blob/master/packages/language-server/src/plugins/typescript/features/CompletionProvider.ts), чтобы узнать, где Причина в том, что в средах только с TS я получаю дополнения для экспорта именованных классов по умолчанию на основе имени класса. ~

Обновление: объявление класса и его экспорт по умолчанию в другой строке работает до тех пор, пока имя экспорта совпадает с именем файла. Собираюсь на этот вариант.

Да, в завершении импорта для svelte-компонентов есть дополнительный код, по сути, создающий предложение импорта. Возможно, этот код можно выбросить, если svelte2tsx имеет именованный экспорт по умолчанию, который совпадает с именем файла.

Исправлено через https://github.com/sveltejs/language-tools/pull/285