`create-plugin-scaffold` documents unsupported `marketplace.json` metadata fields

Đang mở Phù hợp với người mới
#281 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
92/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, json, markdown
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Đọc bước 6 của create-plugin/skills/create-plugin-scaffold/SKILL.md cùng với schemas/marketplace.schema.json và schemas/plugin.schema.json. Cập nhật các trường Marketplace đã được ghi chép và làm rõ các trường manifest của plugin, sau đó chạy scripts/validate-plugins.mjs; hoàn tất khi các hướng dẫn chỉ mô tả những thuộc tính Marketplace được schema hỗ trợ và quá trình validation thành công.

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

Mô tả

Description

The create-plugin-scaffold skill instructs users to add keywords, category and tags as optional metadata on entries in .cursor-plugin/marketplace.json:

6. If repository uses `.cursor-plugin/marketplace.json`, add plugin entry:
   - `name`
   - `source`
   - optional metadata (`description`, `keywords`, `category`, `tags`)

This conflicts with the marketplace schema. A marketplace plugin entry has additionalProperties: false and permits only:

  • name
  • source
  • description
  • minClientVersions

The keywords, category and tags fields are supported by .cursor-plugin/plugin.json, not by an individual marketplace.json plugin entry.

Affected files

  • create-plugin/skills/create-plugin-scaffold/SKILL.md, lines 50–53
  • schemas/marketplace.schema.json, lines 54–79
  • schemas/plugin.schema.json, lines 59–71
  • scripts/validate-plugins.mjs, lines 34–49

Steps to reproduce

  1. Add a plugin entry containing one of the documented fields to .cursor-plugin/marketplace.json:

    {
      "name": "example-plugin",
      "source": "example-plugin",
      "keywords": ["example"]
    }
    
  2. Run the repository validator.

  3. Validation fails because keywords is an additional property:

    marketplace.json schema validation failed:
      /plugins/0: must NOT have additional properties
    

The same failure occurs with category or tags.

Expected behavior

The scaffold instructions should produce a marketplace entry that conforms to schemas/marketplace.schema.json.

Actual behavior

Following the skill as written can generate an invalid marketplace entry that fails repository validation.

Proposed fix

Update step 6 of create-plugin-scaffold/SKILL.md to state that a marketplace plugin entry accepts:

  • Required: name, source
  • Optional: description, minClientVersions

Clarify that keywords, category and tags belong in the plugin's .cursor-plugin/plugin.json manifest.

Acceptance criteria

  • The skill no longer recommends unsupported properties in a marketplace plugin entry.
  • The skill clearly distinguishes marketplace entry metadata from plugin manifest metadata.
  • An entry created by following the documented instructions passes scripts/validate-plugins.mjs.
Ngôn ngữ chính
TypeScript
Star
8.2k
Fork
751
Merge trung bình
12 giờ 1 phút
Pull request đã merge (30 ngày)
43

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 cursor/plugins

Tất cả issue của cursor/plugins

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.