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

未关闭
#5,014 4 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
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 小时
30 天内合并 PR
29

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

stenciljs/core 的其他 Issue

查看 stenciljs/core 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。