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

Đang mở
  • Có gì không ổn?
#5,014 4 bình luận 3 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu bằng cách lần theo đích đầu ra của docs-vscode và cách nó xây dựng JSON của component được tạo, tập trung vào các mục attributes được hiển thị trong issue. Kiểm tra cách thông tin JSDoc @type hoặc @typedef được biểu diễn, sau đó xác minh rằng các giá trị có thể có như primary và secondary xuất hiện trong đầu ra attributes được tạo.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
13.2k
Fork
865
Merge trung bình
2 ngày 16 giờ
Pull request đã merge (30 ngày)
29

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stenciljs/core

Tất cả issue của stenciljs/core

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.