Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Feature: Actually explain shell constructs

Đang mở
  • Có gì không ổn?
#282 0 bình luận 2 reaction 0 người được giao Xem trên GitHub

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ệ
Công nghệ
python, shell
Lĩnh vực
cli

Hướng nghiên cứu

Issue không nêu tệp, kiểm thử hoặc điểm vào nào. Hãy bắt đầu bằng cách xác định luồng hiện có để giải thích các flag và đối số dòng lệnh, sau đó xác định những cấu trúc shell và biến thể shell nào nằm trong phạm vi; được xem là hoàn tất khi các cấu trúc được hỗ trợ được giải thích với những phân biệt chính xác giữa các ngữ nghĩa của shell.

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

Mô tả

Hello @idank and thank you so much for making such a useful project!

One of its limitations is that, currently, it supports explaining command-line flags and arguments, from various things which have man-pages.

It does NOT support explaining basic shell contracts, let alone complicated shell constructs -- and is not opinionated on WHICH shell is being explained (sh/bash/dash/ksh/csh/zsh/etc.).

It would be nice to be able to paste in something like this:

if (( VARIABLE )); then

To inform me that the condition is taken IFF the variable $VARIABLE has been set.

This is distinct from e.g.

if [ -n "$VARIABLE" ]; then

Which takes the "true" condition only when $VARIABLE is defined AND has a nonzero content.

A similar shell construct might be

if [ -v VARIABLE ]; then

Which is identical to the first -- the -v flag returns true if its argument (VARIABLE) is a shell variable that is set at all --even if it's empty.

Do you have any plans to support something like this?

A stretch goal would be to support complicated shell expansion, e.g.

for k v in "${(@kv)zsh_associative_array}"; do

Which iterates over an associative array (in zsh, and possibly ksh) where k and v are set to the key and value of each entry.

Ngôn ngữ chính
Python
Star
14.3k
Fork
851
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 idank/explainshell

Tất cả issue của idank/explainshell

Issue tương tự

Thêm issue về Python

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.