[RFC] Using a package manager for plugins
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 204
- Fork
- 82
- Merge trung bình
- 22 giờ 27 phút
- Pull request đã merge (30 ngày)
- 3
Mô tả
While it's still early days for plugins in Noteplan, it might make sense to keep all the "blessed" plugins in this Github repo, but longer term, that'll start to get untenable. Specially when it comes to releases.
Using a package manager like NPM might make a lot of sense. Using registry.npm.org URLs it's fairly straightforward to search, get details and download packages that can go directly to the Plugins folder.
Here are the benefits to this approach:
- Third party packages can all follow a naming convention (e.g. noteplan-plugin-commandName) and publish them on NPM and they will become easily discoverable for users.
- NPM packages have versioning built-in and it will become easy for different plug-ins to be updated independently and for Noteplan to periodically check for updates easily by package name.
- Since NPM allows for an independent
.npmignorefile it'll become easy to ignore built files for GitHub and ignore source files for the NPM package. This way Noteplan doesn't have to download any unnecessary files. - It should still be valid to use a Github URL to manually download plugins that aren't on NPM. (without all the extra feature though)
Possible downsides:
- Churn - NPM can be an additive feature so that the churn can be kept to a minimum.
- it slightly increases the barrier to entry, but it's really just an
npm publishcommand for a plug-in author. For advanced plugins this would be a total win.
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Issue không nêu rõ tệp, bài kiểm thử hoặc điểm vào nào cần kiểm tra. Trước tiên, hãy làm rõ các yêu cầu về việc phát hiện, tải xuống, quản lý phiên bản, cập nhật plugin và cơ chế dự phòng GitHub, sau đó đối chiếu các yêu cầu đó với luồng cài đặt plugin hiện có. Công việc được xem là hoàn tất khi có thiết kế package manager đã được thống nhất và kế hoạch triển khai với hành vi có thể kiểm thử.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript
- Lĩnh vực
- tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100