في المقال السابق، ، بحثنا كيفية بناء أداة CLI من البداية. الآن، دعونا نذهب إلى الخطوة التالية - كيف تجعلها جيدة؟ في نهاية المطاف، تكون المفتاح في سهولة الاستخدام. يشعر CLI مصممة بشكل جيد بالواقعية، قابلة للتنبؤ، وفعالة للمستخدم. ومع ذلك، يتم تحقيق هذا سهولة الاستخدام من خلال عدة مبادئ تصميم مختلفة، والتي سنستعرضها في هذه المقالة. تعلم فن خطة الأوامر: دليلك النهائي لتطوير أدوات قوية تعلم فن خطة الأوامر: دليلك النهائي لتطوير أدوات قوية من أجل التعبير، سوف نستخدم ولكن المبادئ تنطبق على تقريبا أي إطار CLI الذي تستخدمه. انقر فوق Python Library المعايير معظم أدوات CLI تستقبل الدخول من المستخدم.في معظم الحالات ، لا تكون هذه الدخول تعاملاً - يأتي في شكل هذا يحدد كيفية سلوك الأداة. parameters على سبيل المثال، فإن يجب أن يتطلب الأمر أقل من اثنين من المعايير: cp 
 
 
 الطريق إلى الملف أو المجلد للتسجيل، و الطريق إلى الوجهة. ويمكن أيضًا قبول التحديثات الاختيارية مثل: مما يتيح إدخال الفوركس. -v على نطاق واسع ، هناك نوعان من المراحل: و في معظم مكتبات CLI ، يتم تسمية المواد المطلوبة (أو أداة موقعية) ، وتسمى النماذج الاختيارية . required optional arguments options الأدلة الإيجابية وكما يظهر الاسم، يتم تحديدها عن طريق موقعها.إن المستخدم يقدم القيمة في ترتيب معين، ويترجم الأداة ذلك. positional arguments على سبيل المثال، إذا كان المبدأ يتوقع اثنين من الأدلة الواردة - و - يستخدم المستخدم اسمها ك: cp المصدر المكان cp source destination
 على الرغم من أن أداةك تتطلب إدراجًا، فمن المثير للاهتمام (وفي كثير من الأحيان غير الضروري) أن تجعل المستخدمين يحددون كل قيمة يدويًا. . if you can provide a sensible default, make it an option instead of an argument على سبيل المثال ، a يمكن أن يكون الحد الأدنى من تحرص المستخدمين على تذكير الوضع وتسليم المعلومات دائمًا لا تزيد قيمة - فإنه يزيد فقط عن التردد. --log-level info أسباب متعددة Sometimes a tool may need to accept  على سبيل المثال، يتم تحديد ملفات مصدر متعددة لتسجيلها إلى مكتبة وجهة واحدة، هذا يسمح للمستخدم بإجراء إجراءات واحدة بدلاً من عدة: multiple values cp source1 source2 destination
 هناك بعض التهديدات - عادة، يجب أن تتعامل الكود الخاص بك (لم تتمكن من تحليل المقارنة) مع تحديدات إضافية وإلغاء المنطق. only one argument الخيارات يسمح للمستخدمين بتحديد المعايير بواسطة الاسم ، غالبا في الشكل إذا لم يقدم المستخدم خيارًا، يستخدم الأداة القيمة المفتوحة. Options --option value مثال على ذلك: --log-level debug
 نوعًا خاصًا من الخيار هو الطائرات – لا تتطلب قيمة. --verbose
 Option names should be  , so users can easily understand their purpose. clear and descriptive مثال التطبيق : @click.command()
@click.option('--verbose', is_flag=True)
@click.option('--log-level', default="info")
@click.argument('srcs', nargs=-1)
@click.argument('dst')
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 الآن ، يمكن تسمية الأداة بطرق عديدة: cp --verbose --log-level trace source1 source2 destination
cp source destination
 خيارات قصيرة حتى الآن، لقد استخدمنا أسماء الخيارات الطويلة.هذه هي مثالية للكتابة، لأنها تُفيد نفسها وتُسهل فهمها على الفور. على سبيل المثال، في كثير من الأحيان، يفضل المستخدمون  — like  بدلا من لا تحتاج كل خيار إلى واحدة.إذا كان أداةك لديها العديد من الخيارات، ستتأخر بسرعة من الكلمات الذهنية، وخاصة لأن العديد من الخيارات قد تبدأ مع نفس الخيار. . short options -v --verbose frequently used options مثال : @click.command()
@click.option('-v', '--verbose', is_flag=True)
@click.option('--log-level', default="info")
@click.argument('srcs', nargs=-1)
@click.argument('dst')
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 الآن كلا الطريقة تعمل: cp -v source destination
cp --verbose source destination
 تصحيح الدخول المستخدم و الفشل بسرعة يجب أن يكون أداة CLI قوية و الفشل مع رسالة واضحة و فعالة. معظم إطار CLI يدعم هذا النموذج. validate user input early على سبيل المثال، يمكن أن تمنح Click مستويات التسجيل القابلة للتحقق وتقارير الطريق تلقائيًا: @click.command()
@click.option('-v', '--verbose', is_flag=True)
@click.option('--log-level', default="info", type=click.Choice(["debug", "info", "error"]))
@click.argument('srcs', nargs=-1, type=click.Path())
@click.argument('dst', type=click.Path())
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 ومع ذلك، قد تحتاج • في لدينا مثال : custom logic copy 
 
 
 إذا كان هناك مصدر واحد، قد يكون الهدف ملفًا أو مكتبة. إذا كان هناك مصادر متعددة ، يجب أن يكون الهدف كتابة - وإلا قد تتجاوز الملفات بعضها البعض بطريقة غير متوقعة. لن يتم معالجة مثل هذه الحالات تلقائياً في المكتبات CLI العادية ، لذلك يجب أن يعيش هذا التحقق في رمزك. رسالة مساعدة أداة جيدة تعمل دائمًا . help message يجب أن يكون المستخدم قادرًا على تشغيل شيء ما مثل للقيام : --help 
 
 
 
 ما هي النماذج المتاحة معناه أنواع أو القيم المقبولة (على سبيل المثال، مستويات التسجيل المناسبة) رسالة مساعدة واضحة تخزين الوقت، وتقليل الأخطاء وتحسين ثقة المستخدمين في أداةك. اتبع نظامك البيئي في النهاية ، أدوات CLI الجيدة تشعر دراسة الأدوات الأخرى في بيئتك وتتبع الاتفاقيات الخاصة بها - خاصة في . native naming options and arguments على سبيل المثال، في عالم Unix، أدوات مثل ، و و كل استخدام و وبالتالي، فإن الأدلة، مع دائمًا قبل . cp mv rsync source destination source destination الأدب والتصنيف الأدبي (  for verbose,  من أجل الاستيقاظ، من أجل الجلوس الجليد، لتقديم المساعدة) تجعل أداةك تتكيف بشكل مباشر مع تدفق العمل للمستخدم. -v -r -n -h/--help عندما يشعر أداةك بأنها جزء طبيعي من البيئة، فإن المستخدمين سيكونون أكثر عرضة لتنفيذها - ومتعة استخدامها. الجوانب الأخرى وبالإضافة إلى العناصر والمقاربات، هناك العديد من العناصر الأخرى التي تختلف عن بعضها البعض.  CLI tool from a merely functional one. These aspects affect how your tool integrates with scripts, how users debug issues, and how easily it fits into larger workflows. جيدة خرائط الخروج كل برنامج يعود إلى هذا الكود يتيح للمدير معرفة ما إذا كان البرنامج ناجحًا أم لا. exit code من خلال الاتفاقية : 
 
 
 0 يعني النجاح أي قيمة غير صغيرة تشير إلى خطأ على الرغم من أنه لا توجد معايير عامة للكودات الخلفية ، إلا أنه من المهم إجراء ذلك على الأقل. . exit with a non-zero code on any error لمزيد من التكامل، فكر في اتباع الاتفاقيات من وهي معروفة على نطاق واسع في عالم Unix. إستراتيجية Bash-Scripting المتقدمة يجب عليك أيضاً - تضمينها في عندما يفهم المستخدمون أو الأنظمة التحتية ما يعنيه الكود 3 ، يمكنهم التعامل مع الأخطاء بشكل أكثر ذكاءً (على سبيل المثال ، إعادة التدوير ، التخفيف أو الإشارة). document your exit codes --help ستودور vs ستودور يختلف أداة CLI المعروفة بين أدوات إرسالها القياسية: 
 
 
 STDOUT - لإنتاج منتظم ومتوقع STDERR – لخطأ أو تحذير أو رسائل التشخيص هذا الانفصال يسمح للمستخدمين والأطباق بتعامل كل سلة بشكل مستقل، على سبيل المثال، يمكن للمستخدم إعادة توجيه النتائج العادية إلى ملف مع الحفاظ على رسائل الأخطاء مرئية على القفل: mytool > output.txt
 أو إزالة الأخطاء: mytool 2>/dev/null
 إذا كتبت أداةك كل من البيانات والأخطاء إلى STDOUT ، فستحتاج المستخدمين إلى تصفية النتائج بشكل رئيسي - وهذا أمر صعب. خاصة إذا تم استهلاك إنتاج أداةك من قبل برامج أخرى ، فمن الضروري الحفاظ على STDOUT نظيفة ومحددة. نموذج النتائج إذا كان أداةك تنتج البيانات التي قد تستخدمها أدوات أو نصائح أخرى، فمن الأفضل دعمها. مثل JSON و YAML. machine-readable output مثال على ذلك: mytool --output json
 هذا يجعل التمويل أسهل بكثير - قد تستخدم أدوات أخرى تحليلات القياسية بدلاً من الاعتماد على تحليلات الشريان الضعيف التي تتكرر كلما تغير التراخيص أو التقييم أو التقييم. ومع ذلك ، لا تنسى القراءة البشرية. العديد من المستخدمين سيستخدمون أداةك بشكل تفاعلي. 
 
 
 النموذج المفتوح إلى النموذج المقرر قراءته للإنسان (لوحة مخصصة) عرض علامة (على سبيل المثال --json أو --format إذا كنت ترغب في دعم العديد من النماذج) لإنتاج تركيب بعض أدوات CLI أيضا توفر - إرسال النص المكتوب عند الكتابة إلى محفظة ولكن JSON عند إرسالها إلى عملية أخرى - مما يعني كيفية إرسالها. أو السلوك auto-detection kubectl gh رسائل خطيرة رسالة خطأ جيدة يجب أن تكون: 
 
 
 
 واضح - تحديد ما حدث خطأ العملية - نصائح كيفية إصلاحها متوافق - استخدم نفس الصوت والتصميم في جميع أنحاء مثال سيئ : Error: failed
 مثال أفضل : Error: Could not open file '/tmp/input.txt' — file not found.
Hint: Verify that the path is correct and you have read permissions.
 التعامل الصحيح مع الأخطاء يحافظ على وقت المستخدمين ويساعدهم على بناء الثقة في أداةك. التخطيط والتخطيط يستحق المستخدمون السيطرة على كمية المعلومات التي يرونها. 
 
 
 
 - الصمت للخسارة القصوى - إرسال رسائل مفصلة --debug لتتبع مستوى المطور تصميم مستويات التسجيل الخاص بك حتى يمكن للمستخدمين اختيار كمية المعلومات المناسبة لموضوعهم. عند الجمع بين الكودات الخلفية المناسبة ، فإن هذه المستويات تجعل التحقق والتصديق أسهل بكثير. الاستجابة والإنجازات إذا كان CLI الخاص بك يقوم بإجراء عمليات كبيرة ، فكر في تقديم أو على سبيل المثال: progress indicators spinners Downloading files... 45% complete
 في الوقت نفسه، تجنب التحرك غير الضروري أو النتائج عندما يتم تشغيل الأداة في وضع غير تفاعلية (على سبيل المثال كجزء من سجل). النتيجة بناء أداة CLI سهلة نسبيا. 1 – هذا هو الممارسة الحقيقية. يبدو أن أداة خطة الأوامر الجيدة طبيعية، تتصرف بشكل متوقع، وتختفي بسهولة في تدفق العمل للمستخدم.  — it adapts to how users already work. good هذه طوال هذه المقالة، لقد نظرنا إلى ما يساعد على هذه التجربة: 
 
 
 
 
 
 
 ميزات واضحة ومتوازنة توازن البساطة والمرونة الكودات الخلفية المعقدة التي تتواصل مع النجاح أو الفشل استخدام STDOUT و STDERR الصحيح لإزالة البيانات من التشخيص نموذجات النتائج القابلة للتعقيد والمستقرة للإنسان والآلات رسائل أخطاء مفيدة وممارسات متوقعة الامتثال إلى الاتفاقيات في بيئةك، بحيث تشعر الأداة المعروفة من المشي الأولى في نهاية المطاف، فإن أفضل أدوات CLI لها علاقة مشتركة: يبدأ بسرعة ، يتخطى بسرعة ، يتضح أنفسهم بشكل واضح ، ويتم دمجها بسهولة في الأنظمة والأشعار الكبيرة. respect the user’s time إذا كنت تبذل هذه المبادئ في الاعتبار - الشفافية والتوافق والتفاؤل بالنسبة للمستخدمين - فإن أداة CLI الخاصة بك ليست فقط وسوف يكون من الاهتمام استخدامها. العمل

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

Read My Stories

تم إنتاج هذا الصوت باللغة الأصلية للقصة!

كيفية تصميم أداة CLI التي يحبها التطوير

About Author

تعليقات

شنق العلامات

تم تقديم هذه المقالة في

Related Stories

Top Industries Which Can Benefit From Augmented Reality App Development

How can AR, IoT, Blockchain and Chatbots redefine Customer Experience

Top 10 IoT Application Development Companies

The shortage of women in tech

Top Industries Which Can Benefit From Augmented Reality App Development

How can AR, IoT, Blockchain and Chatbots redefine Customer Experience

Top 10 IoT Application Development Companies

The shortage of women in tech

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps