uutils / uutils/diffutils

How to approach --help implementation

Abierto
#96 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Rust
Estrellas
276
Forks
39
Merge medio
3 h 27 min
PR fusionados (30 d)
3

Descripción

I am working on the cmp implementation (https://github.com/uutils/diffutils/pull/88) and would like to have --help output something useful, which I think is important for our version to really replace GNU cmp on a system. We should figure out which way to go here so that we can apply it to the other diffutils tools.

I believe we have 2 main options:

  1. Basically copy/paste GNU cmp output, with minimal changes
  2. Write from scratch

Option 1 has the benefit of being familiar for people who are used to the GNU tooling, or for those crazy enough to have scripted parsing of this output, for some reason. I suppose the main concern for doing it like this is an argument could be made that the output is copyrighted. This is how I envision it looking (note the different links at the bottom):

    print!(
        indoc! {"
        Usage: {} [OPTION]... FILE1 [FILE2 [SKIP1 [SKIP2]]]
        Compare two files byte by byte.

        The optional SKIP1 and SKIP2 specify the number of bytes to skip
        at the beginning of each file (zero by default).

        Mandatory arguments to long options are mandatory for short options too.
          -b, --print-bytes          print differing bytes
          -i, --ignore-initial=SKIP         skip first SKIP bytes of both inputs
          -i, --ignore-initial=SKIP1:SKIP2  skip first SKIP1 bytes of FILE1 and
                                              first SKIP2 bytes of FILE2
          -l, --verbose              output byte numbers and differing byte values
          -n, --bytes=LIMIT          compare at most LIMIT bytes
          -s, --quiet, --silent      suppress all normal output
              --help                 display this help and exit
          -v, --version              output version information and exit

        SKIP values may be followed by the following multiplicative suffixes:
        kB 1000, K 1024, MB 1,000,000, M 1,048,576,
        GB 1,000,000,000, G 1,073,741,824, and so on for T, P, E, Z, Y.

        If a FILE is '-' or missing, read standard input.
        Exit status is 0 if inputs are the same, 1 if different, 2 if trouble.

        This utility is part of the uutils project: https://github.com/uutils/
        Report bugs here: https://github.com/uutils/diffutils/issues
    "},
        params.executable.to_string_lossy()
    );

Option 2 is slightly more work, but dodges any concerns related to using stuff directly from GNU cmp, and something we would probably want if we ever move to something like Clap, I suppose.

Thoughts? Concerns?

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Empieza revisando la implementación de cmp referenciada en el pull request #88 y compara su comportamiento actual en la línea de comandos con la salida de ayuda de GNU cmp que se muestra aquí. Determina si la ayuda debe seguir la redacción de GNU o escribirse de forma independiente y, a continuación, define cómo debe aplicarse esta decisión a las demás herramientas de diffutils; el issue no indica archivos ni pruebas que ejecutar.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.