رسائل الاستخدام

Usage Messages

practice ~18 دقيقة

رسائل الاستخدام — Usage Messages

رسالة الاستخدام الجيدة تحول الخطأ إلى تعليم. بدلاً من أن يفشل السكربت برسالة مثل unbound variable، قل للمستخدم كيف يشغله: Usage: backup.sh SOURCE TARGET. هذه الرسالة يجب أن تكون قصيرة، دقيقة، وتظهر عندما تكون المدخلات ناقصة أو غير مفهومة.

اكتب دالة usage بدلاً من تكرار النص في عدة أماكن. إذا تغيرت طريقة التشغيل لاحقاً، تعدلها في مكان واحد. اجعل الرسالة تذهب إلى stderr عندما تكون بسبب خطأ، ويمكن أن تذهب إلى stdout عندما يطلب المستخدم --help.

لا تجعل رسالة الاستخدام رواية طويلة. اذكر الصيغة، الخيارات المهمة، ومثالاً واحداً إذا لزم. التفاصيل الأكبر مكانها README أو درس، لا كل تشغيل خاطئ.

مثال مراجعة

script.sh

#!/usr/bin/env bash
set -euo pipefail

usage() {
	echo "Usage: greet.sh NAME TOPIC" >&2
}

if (($# < 2)); then
	usage
	exit 1
fi

name="$1"
topic="$2"

echo "أهلاً $name، موضوعك اليوم: $topic"

Output:

لاحظ أن الدالة لا تخرج بنفسها. في هذا المثال، المكان الذي يكتشف الخطأ هو الذي يقرر exit 1. هذا يجعل الدالة قابلة للاستخدام في سياقات مختلفة.

تحدي

أكمل التحقق بحيث يطبع السكربت missing name عندما لا توجد معاملات، ويطبع name=AzLearn عندما توجد قيمة.

تحدي — Challenge

#!/usr/bin/env bash
set -euo pipefail

set -- "AzLearn"

if (($# == 0)); then
	echo "missing name"
	exit 1
fi

# اطبع name=<القيمة> — Print name=<value>

بعد هذا الفصل، أصبحت سكربتاتك قادرة على استقبال مدخلات بشكل واضح. الفصل القادم يجعلها أكثر تنظيماً عبر الدوال.