feat: include `values` inside the attributes when generating `docs-vscode`output target

オープン
#5,014 コメント 4 件 リアクション 3 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript
領域
tooling

調査の方向性

まず docs-vscode の出力先をたどり、生成されるコンポーネント JSON の構築方法を確認します。Issue に示されている attributes エントリに注目してください。JSDoc の @type または @typedef 情報がどのように表現されているかを確認し、続いて primary や secondary などの可能な値が生成された attributes 出力に現れることを検証します。

索引モデルが issue の本文から書いたものです。

説明

Feature: Want this? Upvote it!
Prerequisites
Describe the Feature Request

When generating the docs-vscode output target, I am unable to get generate values inside the generated json.

Example output:

{
      "name": "evo-card",
      "description": {
        "kind": "markdown",
        "value": "Displays a card with a shadow."
      },
      "attributes": [
        {
          "name": "focused",
          "description": ""
        },
        {
          "name": "variant",
          "description": "The variant of the card."
        }
      ]
    }

attributes.values remain empty when trying jsdoc attributes like @type of @typdefs

Describe the Use Case

It would add intellisense of all possible values. Example: primary, secondary,...

Describe Preferred Solution

No response

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

主要言語
TypeScript
スター
13.2k
フォーク
865
平均マージ
2日 16時間
マージ済み PR(30日)
29

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

stenciljs/core のほかの issue

stenciljs/core の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。