LuaLS / LuaLS/lua-language-server

[Feature Request] Allow passing filters to `--doc`

Đang mở
#2,630 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.

Ngôn ngữ chính
Lua
Star
4.4k
Fork
442
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

It would be very nice if we were able to pass filters to the --doc command to only document specific namespaces.

Example:

lua-language-server --doc="../../.." --doc-filter="MyNameSpace" --doc_out_path="."

Would only output documentation for MyNameSpace and every member like MyNameSpace.Private etc.

For the json output formal I can do this easily via something like

jq '[.[] | select(.name | index("MyNameSpace") != -1)]' doc.json > output.json but for the markdown output, it would be fairly difficult.

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

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu từ lệnh --doc và so sánh cách tài liệu markdown và JSON được tạo. Truy vết đường dẫn xuất tài liệu hiện có, sau đó xác định nơi một giá trị --doc-filter có thể giới hạn một namespace và các member của nó. Hoàn tất khi đầu ra markdown và JSON đã lọc chỉ bao gồm phạm vi namespace được yêu cầu.

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

Đánh giá

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

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.