Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Feature: Actually explain shell constructs

Aperta
#282 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python, shell
Ambito
cli

Direzione di ricerca

L’issue non indica file, test o punti di ingresso. Inizia individuando il percorso esistente per la spiegazione dei flag e degli argomenti della riga di comando, quindi definisci quali costrutti della shell e varianti della shell rientrano nell’ambito; il lavoro è completo quando i costrutti supportati sono spiegati con distinzioni corrette tra le semantiche della shell.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
14.3k
Fork
851
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di idank/explainshell

Tutte le issue di idank/explainshell

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.