Run ShellCheck over bin/ in CI

Aperta
  • Qualcosa non va?
#792 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
shell
Ambito
ci-cd, tooling

Direzione di ricerca

Inizia ispezionando gli script in bin/, in particolare bin/clear-port, bin/replace e bin/bundler-search, poi verifica come è configurato CI in questo repository. Esegui ShellCheck su bin/ e decidi quali risultati il progetto dovrebbe imporre prima di far fallire la build. Aggiorna la descrizione della pull request #789 e fai in modo che il controllo CI copra gli script previsti, documentando le scelte relative alle regole.

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

Descrizione

bin/clear-port cites a ShellCheck rule by number, and the number is wrong.

The commit message for #789 says an unquoted $(...) "trips SC2086". It trips
SC2046. I checked with ShellCheck 0.11.0:

$ cat sc.sh
#!/bin/sh
kill $(lsof -ti4TCP:"$1" -sTCP:LISTEN)

$ shellcheck sc.sh
In sc.sh line 2:
kill $(lsof -ti4TCP:"$1" -sTCP:LISTEN)
     ^-- SC2046 (warning): Quote this to prevent word splitting.

SC2086 is the related rule for an unquoted variable. SC2046 is the one for an
unquoted command substitution.

Two things to do:

  1. Edit the pull request description on #789. That copy stays editable. The
    commit message does not, once the branch is merged.
  2. Run ShellCheck over bin/ in CI, so a cited rule can be checked rather
    than trusted.

The second point is the one that lasts. Nothing in this repo runs ShellCheck
today, so rules get cited from memory and no build disagrees. bin/clear-port
on main currently trips SC2181, and #789 happens to clear it:

$ shellcheck bin/clear-port   # before #789
In bin/clear-port line 9:
  if [ $? -eq 0 ]; then
       ^-- SC2181 (style): Check exit code directly.

$ shellcheck bin/clear-port   # after #789
(no findings)

Other scripts will have findings of their own. bin/replace and
bin/bundler-search both use &>, which is a bashism under a #!/bin/sh
shebang. A first pass should decide which rules this repo wants to enforce
before turning the build red.

Lingua principale
Shell
Stelle
8.2k
Fork
1.7k
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 thoughtbot/dotfiles

Tutte le issue di thoughtbot/dotfiles

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.