microsoft / microsoft/TypeScript

JSDoc for file/directory autocompletion

Đang mở
#43,445 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.

Awaiting More Feedback Suggestion
Ngôn ngữ chính
Go
Star
111k
Fork
14.3k
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
132

Mô tả

Suggestion

🔍 Search Terms

directory autocompletion
file autocompletion
path autocompletion
path intellisense
cwd autocompletion

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

An new JSDoc like /* @ts-ignore */ for directory/file autocompletion for an folder (e.g. default: cwd)
e.g.:
Plugin Options:

interface PluginOptions {
  /* @ts-path-autocompletion (optional define path; default: cwd) */
  file: string
}

📃 Motivating Example

It can help to choose the path instead of typing it.
And maybe warn if the path does not exist. (Disabling would be handy for files and folders that are still being created)

💻 Use Cases

IntelliSense for an path in another folder for e.g. webpack plugin options.

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

Đề xuất không đề cập đến bất kỳ tệp, bài kiểm thử hay điểm vào nào. Hãy bắt đầu bằng việc xác định nơi xử lý các tùy chọn JSDoc/plugin và tính năng hoàn thành đường dẫn, sau đó xác định trước khi triển khai hành vi chú thích được hỗ trợ, phạm vi đường dẫn và cách xử lý các tệp bị thiếu; hoàn thành nghĩa là tính năng hoàn thành được yêu cầu hoạt động עבור các trường hợp sử dụng được mô tả.

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, typescript
Lĩnh vực
developer-experience
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
25/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.