実行されないソースとなるシェルスクリプトを定義する方法

ユーザーsourceが実行するのではなく、シェルスクリプトを定義しています。

たとえばファイル拡張子を使用して、これが事実であることをユーザーに示唆する従来の方法またはインテリジェントな方法はありますか？

ファイル自体に書き込むことができるシェルコードはありますか？これにより、ソースの代わりにメッセージがエコーされ、実行されると終了するため、ユーザーがこの明らかな間違いを避けるのを助けることができますか？

bashを実行していると仮定して、ソースにしたいが実行したくないスクリプトの先頭近くに次のコードを配置します。

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

bashの下${BASH_SOURCE[0]}には、ソースであるか実行されているかに関係なく、シェルが読み取っている現在のファイルの名前が含まれます。

対照的に、$0は実行中の現在のファイルの名前です。

-efこれら2つのファイルが同じファイルかどうかをテストします。存在する場合、ユーザーに警告して終了します。

POSIX -efでもBASH_SOURCEありません。一方で-efkshの、ヤシュ、zshのとダッシュでサポートされて、BASH_SOURCEbashのを必要とします。 ではzsh、ただし、${BASH_SOURCE[0]}置き換えることができます${(%):-%N}。

非実行可能ファイルはソースにできますが、実行できません。そのため、防御の第一線として、実行可能フラグを設定しないことが良いヒントになるはずです...

編集：私はつまずいたトリック：シェバンをシェルインタープリターではない実行可能ファイルにし/bin/false、スクリプトにエラーを返します（rc！= 0）

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

このStack Overflowの投稿で提案されているいくつかの方法がありますが、そのうち、Wirawan Purwantoとmr.spuraticが提案した関数ベースの方法が最も気に入りました。

Wirawan Purwantoが提案する最も堅牢な方法はFUNCNAME[1] 、関数内でチェック することです：

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

次に：

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

これは、の出力caller、値 main、およびsource呼び出し元のコンテキストを確認することと同等です。を使用 FUNCNAME[]すると、caller出力をキャプチャして解析します。ただし、ローカルの通話深度を正確に把握または計算する必要があります。別の関数またはスクリプト内からソースされるスクリプトのようなケースでは、配列（スタック）が深くなります。（FUNCNAME特別なbash配列変数であり、決してない限り、呼び出しスタックに対応する連続したインデックスを持つ必要がありますunset。）

したがって、スクリプトの先頭に追加できます。

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

スクリプトを実行するのは有害ではなく、単に役に立たないと仮定して、追加することができます

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

スクリプトの最後まで。return関数の外部には、ファイルがソースされていない限り、ゼロ以外の終了コードがあります。

シェルスクリプトのソースを作成すると、shebang行は無視されます。無効なシバンを入れることで、スクリプトが誤って実行されたことをユーザーに警告できます。

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

エラーメッセージは次のようになります。

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

（任意の）引数名はすでに強力なヒントを提供しますが、エラーメッセージは100％明確ではありません。次の場所にあるユーティリティスクリプトsource-this-scriptでこれを修正できますPATH。

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

エラーメッセージは次のようになります。

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

他のアプローチとの比較

他の回答と比較して、このアプローチは各スクリプトへの最小限の変更のみを必要とします（また、シェバン行を使用すると、エディターでのファイルタイプの検出に役立ち、シェルスクリプトの方言が指定されるため、メリットもあります）。欠点は、やや不明瞭なエラーメッセージ、または別のシェルスクリプトの（一度限りの）追加です。

bash path/to/script.shただし、による明示的な呼び出しは妨げられません（@muruに感謝します！）。