Come definire uno script di shell da cui provenire non eseguito

Sto definendo uno script di shell che un utente dovrebbe sourcepiuttosto che eseguire.

Esiste un modo convenzionale o intelligente per suggerire all'utente che è così, ad esempio tramite un'estensione di file?

Esiste un codice shell che posso scrivere nel file stesso, il che lo farà eco a un messaggio e si chiuderà se viene eseguito invece di origine, in modo da poter aiutare l'utente a evitare questo errore evidente?

Supponendo che tu stia eseguendo bash, metti il ​​seguente codice vicino all'inizio dello script che vuoi ottenere ma non eseguito:

if [ "${BASH_SOURCE[0]}" -ef "$0" ]
then
    echo "Hey, you should source this script, not execute it!"
    exit 1
fi

Sotto bash, ${BASH_SOURCE[0]}conterrà il nome del file corrente che la shell sta leggendo, indipendentemente dal fatto che sia di provenienza o eseguita.

Al contrario, $0è il nome del file corrente in esecuzione.

-efverifica se questi due file sono lo stesso file. In tal caso, avvisiamo l'utente e usciamo.

Né -efné BASH_SOURCEsono POSIX. Mentre -efè supportato da ksh, yash, zsh e Dash, BASH_SOURCErichiede bash. Inzsh , tuttavia, ${BASH_SOURCE[0]}potrebbe essere sostituito da ${(%):-%N}.

Un file non eseguibile può essere fornito ma non eseguito, quindi, come prima linea di difesa, non impostare il flag eseguibile dovrebbe essere un buon suggerimento ...

Modifica: trucco che mi sono appena imbattuto: fai in modo che lo shebang sia un eseguibile che non sia un interprete di shell, /bin/falsefa in modo che lo script restituisca un errore (rc! = 0)

#!/bin/false "This script should be sourced in a shell, not executed directly"

Ci sono diversi metodi suggeriti in questo post Stack Overflow , di cui mi è piaciuta quella basata sulle funzioni suggerita da Wirawan Purwanto e mr.spuratic best:

Il modo più robusto, come suggerito da Wirawan Purwanto, è controllare FUNCNAME[1] all'interno di una funzione :

function mycheck() { declare -p FUNCNAME; }
mycheck

Poi:

$ bash sourcetest.sh
declare -a FUNCNAME='([0]="mycheck" [1]="main")'
$ . sourcetest.sh
declare -a FUNCNAME='([0]="mycheck" [1]="source")'

Ciò equivale a controllare l'output di caller, i valori maine sourcedistinguere il contesto del chiamante. L'utilizzo FUNCNAME[]consente di salvare l'acquisizione e l'analisi callerdell'output. Tuttavia, è necessario conoscere o calcolare la profondità della chiamata locale per essere corretti. Casi come uno script proveniente da un'altra funzione o script causano una maggiore profondità dell'array (stack). ( FUNCNAMEè una variabile di array bash speciale, dovrebbe avere indici contigui corrispondenti allo stack di chiamate, purché non lo sia mai unset.)

Quindi puoi aggiungere all'inizio dello script:

function check()
{
    if [[ ${FUNCNAME[-1]} != "source" ]]   # bash 4.2+, use ${FUNCNAME[@]: -1} for older
    then
        printf "Usage: source %s\n" "$0"
        exit 1
    fi
}
check

Supponendo che sia solo inutile, piuttosto che dannoso, eseguire lo script, è possibile aggiungere

return 0 || printf 'Must be sourced, not executed\n' >&2

fino alla fine della sceneggiatura. returnal di fuori di una funzione ha un codice di uscita diverso da zero a meno che il file non sia di provenienza.

Quando si genera uno script di shell, la riga shebang viene ignorata. Inserendo uno shebang non valido, è possibile avvisare l'utente che lo script è stato eseguito erroneamente:

#!/bin/bash source-this-script
# ...

Il messaggio di errore sarà questo:

/bin/bash: source-this-script: No such file or directory

Il nome dell'argomento (arbitrario) fornisce già un forte suggerimento, ma il messaggio di errore non è ancora chiaro al 100%. Possiamo risolvere questo problema con uno script di utilità source-this-scriptposizionato da qualche parte nel tuo PATH:

#!/bin/sh
echo >&2 "This script must be sourced, not executed${1:+: }${1:-!}"
exit 1

Ora, il messaggio di errore sarà questo:

This script must be sourced, not executed: path/to/script.sh

Confronto con altri approcci

Rispetto alle altre risposte, questo approccio richiede solo modifiche minime a ciascuno script (e avere una riga shebang aiuta con il rilevamento del tipo di file negli editor e specifica il dialetto dello script shell, quindi ci sono anche vantaggi). Il rovescio della medaglia è un messaggio di errore in qualche modo poco chiaro, o l'aggiunta (una tantum) di un altro script di shell.

bash path/to/script.shTuttavia, non impedisce l'invocazione esplicita tramite (grazie @muru!).