Çalıştırılmayacak kaynak bir kabuk betiği nasıl tanımlanır

Çalıştırmak sourceyerine bir kullanıcının çalışması gereken bir kabuk betiği tanımlıyorum .

Kullanıcıya, örneğin bir dosya uzantısı aracılığıyla durumun böyle olduğunu ima etmenin geleneksel veya akıllı bir yolu var mı?

Dosyanın kendisine yazabileceğim, mesajın yankılanmasına ve kaynak yerine çalıştırıldığında bırakılmasına neden olacak kabuk kodu var mı, böylece kullanıcının bu açık hatayı önlemesine yardımcı olabilirim?

Bash çalıştırdığınızı varsayarak, aşağıdaki kodu kaynak kodunu almak istediğiniz ancak yürütülmeyen komut dosyasının başlangıcına yakın bir yere koyun:

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

Bash altında, ${BASH_SOURCE[0]}kaynaklanıp çalıştırılmadığına bakılmaksızın, kabuğun okuduğu geçerli dosyanın adını içerecektir.

Buna karşılık, $0yürütülmekte olan dosyanın adı.

-efbu iki dosyanın aynı dosya olup olmadığını test eder. Eğer öyleyse, kullanıcıyı uyarır ve çıkarız.

Ne -efde BASH_SOURCEPOSIX vardır. İken -efKsh Yash, zsh ve Dash tarafından desteklenen, BASH_SOURCEBash gerektirir. Inzsh Ancak ${BASH_SOURCE[0]}yerini olabilir ${(%):-%N}.

Çalıştırılamayan bir dosya kaynak gösterilebilir ancak yürütülemez, bu nedenle, ilk savunma satırı olarak çalıştırılabilir bayrağın ayarlanmaması iyi bir ipucu olmalı ...

Düzenleme: sadece üzerinde tökezledi hile: Shebang bir kabuk tercüman olmayan herhangi bir çalıştırılabilir olması, /bin/falsekomut dosyası bir hata döndürmesini sağlar (rc! = 0)

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

Bu Yığın Taşması yazısında önerilen, Wirawan Purwanto ve mr.spuratic tarafından önerilen fonksiyon temelli olanı sevdiğim birkaç yöntem var :

Wirawan Purwanto tarafından önerildiği gibi en sağlam yöntem, FUNCNAME[1] bir işlev içinde kontrol etmektir :

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

Sonra:

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

Bu callerdeğerin çıktısını , değerlerini kontrol etmeye mainve sourcearayanın bağlamını ayırt etmeye eşdeğerdir . Kullanmak çıktı FUNCNAME[]yakalamanıza ve ayrıştırmanıza yardımcı olur caller. Doğru olmak için yerel arama derinliğini bilmeniz veya hesaplamanız gerekir. Bir komut dosyasının başka bir işlevden veya komut dosyasının içinden kaynaklandığı durumlar, dizinin (yığının) daha derin olmasına neden olur. ( FUNCNAMEözel bir bash dizi değişkenidir, hiçbir zaman olmadığı sürece çağrı yığınına karşılık gelen bitişik dizinlere sahip olmalıdır unset.)

Böylece betiğin başına ekleyebilirsiniz:

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

Senaryoyu çalıştırmanın zararlı değil, sadece yararsız olduğunu varsayarak,

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

için sonuna script. returnişlevin dışında, dosya kaynaklanmadıkça sıfır olmayan bir çıkış kodu bulunur.

Bir kabuk betiğini kaynakladığınızda, shebang satırı göz ardı edilir. Geçersiz bir shebang koyarak, kullanıcıyı komut dosyasının hatalı şekilde çalıştırıldığı konusunda uyarabilirsiniz:

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

Hata mesajı şöyle olacaktır:

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

(Rasgele) argüman adı zaten güçlü bir ipucu sağlar, ancak hata mesajı hala% 100 net değildir. Bunu, source-this-scriptsizin yerinize bir yere yerleştirilmiş bir yardımcı program betiği ile çözebiliriz PATH:

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

Şimdi, hata mesajı şöyle olacak:

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

Diğer yaklaşımlarla karşılaştırılması

Diğer cevaplarla karşılaştırıldığında, bu yaklaşım yalnızca her komut dosyasında minimum değişiklikler gerektirir (ve bir shebang satırına sahip olmak, editörlerde dosya türü algılamasına yardımcı olur ve kabuk komut dosyası lehçesini belirtir, bu nedenle faydaları da vardır). Dezavantajı biraz belirsiz bir hata mesajı veya (bir defalık) başka bir kabuk betiğinin eklenmesidir.

bash path/to/script.shOlsa da, açıkça istişareyi engellemez (teşekkürler @muru!).