Support package keywords / categories

Đang mở
  • Có gì không ổn?
#650 0 bình luận 5 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
api, backend

Hướng nghiên cứu

Start by reviewing the existing purs publish registry compatibility code at src/Language/PureScript/Publish/Registry/Compat.hs and the related Pursuit issues 147, 431, and 416. Determine whether the registry should preserve deprecation or arbitrary keywords, then define the accepted metadata and verify that published purs.json packages expose the intended information.

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

Mô tả

discussion pursuit

You can currently deprecate packages on Pursuit by setting the keywords field in your bower.json file to contain the keyword pursuit-deprecated. A package with this keyword automatically gets a banner:

image

The above screenshot shows a deprecated banner because that keyword is set:

https://github.com/purescript-deprecated/purescript-node-fs-aff/blob/56414801882dd23de272bf0bd927160b13b6e86f/bower.json#L11-L15

Pursuit knows of the keyword because the compiler, in purs publish, will copy the contents of the Bower file into the JSON payload sent to Pursuit. See, for example, the contents of the package upload for a deprecated package here:

https://github.com/purescript/pursuit-backups/blob/c2b55e73ece4105759007acbd6681b03d6991d4a/purescript-symbols/3.0.1.json

Of course, any package published by the registry will use a purs.json file, itself derived from the bowerfile, or the spago.dhall file, or the spago.yaml file. In this case, purs publish will create a Bower package out of the purs.json file, which of course has no keywords field:

https://github.com/purescript/purescript/blob/4afea2fbefeebd5e89c67d5a951efee870bcf2f2/src/Language/PureScript/Publish/Registry/Compat.hs#L16-L36

The end result is that it is currently impossible to indicate a package is deprecated via the registry. This raises the bigger question: do we want to allow package deprecation?

Package Deprecation and Keywords

A "deprecated" package is really a social category (it's still usable at its published version, of course, but the author is encouraging you not to use it). We may choose to let authors indicate this, or we may not. Advantages of letting a user indicate information like deprecation include:

  • For keywords we support, we can display extra information in documentation (such as the deprecation badge)
  • For arbitrary keywords, we can support a keyword search on Pursuit

One possible approach is a fixed list of keywords or categories that we know mean something; Crates, for example, has a specific list of categories you can put a package in: https://crates.io/category_slugs

But you can also put arbitrary keywords (up to 5, I believe) in your cargo.toml. We could also support this, allowing people to self-describe with whatever keywords they want.

Related Issues

This has certainly come up before. See:

Ngôn ngữ chính
PureScript
Star
95
Fork
79
Merge trung bình
16 giờ 13 phút
Pull request đã merge (30 ngày)
14

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 purescript/registry-dev

Tất cả issue của purescript/registry-dev

Issue tương tự

Thêm issue về Backend & API Design

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.