Language-tools: 호버 문서에 나타나는 독스트링으로 구성 요소 문서화

이것은 스크립트 태그가 없는 구성 요소에도 유용할 수 있으므로 HTML 주석을 사용하는 것이 좋습니다. svelte2tsx 는 특수 태그(예 @doc )로 시작하는 HTML 주석을 찾고 기본 내보내기 위에 내용을 jsdoc로 넣습니다.

의견? 다른 아이디어?

나는 이것을 구현하는 데 정말로 관심이 있을 것입니다. 하지만 일부 개발자가 매일 _매우 자주_ 사용하는 기능이기 때문에 신중하게 설계해야 한다고 생각합니다.

생각나는 것은 다음과 같습니다.

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

파일의 시작 부분. 하지만 HTML 주석만 작동한다고 생각합니다. 맞나요?

또한 다른 태그와 더 유사하게 만들려면 <svelte:head> 와 유사한 <svelte:documentation> 태그가 좋을 수 있지만 컴파일러에서 구현해야 합니다.

아마도 <svelte:options documentation="blabla" /> ?

또한 컴파일러에서 약간의 작업과 기본 저장소의 승인이 필요합니다. 옵션은 컴파일러에 의해 확인되었습니다.

나는 메인 리포지토리에 유사한 문제를 만들었습니다. 우리가 어떤 결론에 도달할 수 있는지 봅시다 :+1:

https://github.com/sveltejs/language-tools/pull/282 가 병합되면 절반이 완료됩니다. LSP는 호버에 문서 문자열을 표시하지 않았습니다.

이제 내가 해야 할 일은 @doc HTML 주석에서 독스트링을 가져와 svelte2tsx의 addComponentExport 에 추가하는 것입니다.

@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 전용 환경에서 클래스 이름을 기반으로 명명된 클래스의 기본 내보내기를 완료하기 때문입니다.~

업데이트: 클래스를 선언한 다음 내보내기 이름이 파일 이름과 동일한 한 다른 줄에서 기본으로 내보내면 됩니다. 저는 이 옵션을 선택하겠습니다.

예, 얇은 구성 요소에 대한 가져오기 완료에는 기본적으로 가져오기 제안을 구성하는 몇 가지 추가 코드가 있습니다. svelte2tsx에 파일 이름과 동일한 명명된 기본 내보내기가 있는 경우 해당 코드를 버릴 수 있습니다.

https://github.com/sveltejs/language-tools/pull/285 를 통해 수정되었습니다.