Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Feature: Actually explain shell constructs

Abierto
#282 0 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python, shell
Área
cli

Línea de trabajo

El issue no menciona archivos, pruebas ni puntos de entrada. Empieza por localizar la ruta existente para explicar las flags y los argumentos de la línea de comandos, y después define qué construcciones de shell y variantes de shell están incluidas en el alcance; se considera terminado cuando las construcciones compatibles se explican con distinciones correctas entre las semánticas de shell.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
14.3k
Forks
851
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de idank/explainshell

Todos los issues de idank/explainshell

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.