Programming guidelines and style Post: 303001684

Sponsored Content

Top Forums Shell Programming and Scripting Programming guidelines and style Post 303001684 by drl on Wednesday 9th of August 2017 11:38:33 AM

08-09-2017

Registered User

Hi.

This is a meta-answer for shell coding.

1) Write however you want, then run your code through a semantic and syntax checker:

Code:

shellcheck      analyse shell scripts (man)
Path    : /usr/bin/shellcheck
Version : ShellCheck - shell script analysis tool
Type    : ELF 64-bit LSB executable, x86-64, version 1 (SYSV ...)
Help    : probably available with -h
Repo    : Debian 8.8 (jessie) 
Home    : http://hackage.haskell.org/package/ShellCheck (pm)

As you progress, you can skip this as the first step, and go right to testing, coming back if your code fails.

then through a beautifier (which could easily apply to all languages):

Code:

beautysh        Tidy bash scripts, written in python3. (what)
Path    : ~/bin/beautysh
Version : - ( local: RepRev 1.4, ~/bin/beautysh, 2016-03-31 )
Length  : 174 lines
Type    : Python script, ASCII text executable
Shebang : #!/usr/bin/env python3
Home    : https://github.com/bemeurer/beautysh (doc)
Modules : (for python codes)
  re
  sys

2) Shell (as a programming language for more than trivial scripting) is dead. Perl rules in its place (though it is now being strongly challenged by Python). -- Basic Linux and Unix bibliography , especailly parts:

a) Books on Shell, Script, and Web Development

b) Good Programming Style

Best wishes ... cheers, drl

drl

View Public Profile for drl

Find all posts by drl

4 More Discussions You Might Find Interesting

1. Forum Support Area for Unregistered Users & Account Problems

Guidelines For Posting Here

This area is not for technical questions. It is reserved for unregistered users who have a question or registered users who have trouble with their account. Other posts will be deleted by the moderators.

2. What is on Your Mind?

Guidelines for Posting Here

This area is not for forum specific technical questions. Please post forum specific technical questions in the best forum, not in the lounge. However, if your idea or question is not covered clearly in a forum, please post it here. Discuss whatever is on your mind. Technical topics welcome...

3. Shell Programming and Scripting

Unix Shell Scripting Guidelines

Hi, I was wondering if any of you guys have developed shell scripting guidelines for writing unix shell scripts effectively. This includes naming standards, comments, indentation, error handing after unix comands, use of exported variables, sending notifications, functions, logging etc... ...

4. Programming

Building Block style programming Book

Hello to all, Here is my situation. Some time in the mid-80's I stumbled across a small white programming book - can't remember the name but it was unique in that it started right out giving instructions on creating building blocks in code as a foundation for a complete system. The book was...

LEARN ABOUT OSX

locale::script

Locale::Script(3pm)					 Perl Programmers Reference Guide				       Locale::Script(3pm)

NAME

       Locale::Script - standard codes for script identification

SYNOPSIS

	  use Locale::Script;

	  $script  = code2script('phnx');		      # 'Phoenician'
	  $code    = script2code('Phoenician'); 	      # 'Phnx'
	  $code    = script2code('Phoenician',
				 LOCALE_CODE_NUMERIC);	      # 115

	  @codes   = all_script_codes();
	  @scripts = all_script_names();

DESCRIPTION

       The "Locale::Script" module provides access to standards codes used for identifying scripts, such as those defined in ISO 15924.

       Most of the routines take an optional additional argument which specifies the code set to use. If not specified, the default ISO 15924
       four-letter codes will be used.

SUPPORTED CODE SETS

       There are several different code sets you can use for identifying scripts. A code set may be specified using either a name, or a constant
       that is automatically exported by this module.

       For example, the two are equivalent:

	  $script = code2script('phnx','alpha');
	  $script = code2script('phnx',LOCALE_SCRIPT_ALPHA);

       The codesets currently supported are:

       alpha, LOCALE_SCRIPT_ALPHA
	   This is a set of four-letter (capitalized) codes from ISO 15924 such as 'Phnx' for Phoenician.  It also includes additions to this set
	   included in the IANA language registry.

	   The Zxxx, Zyyy, and Zzzz codes are not used.

	   This is the default code set.

       num, LOCALE_SCRIPT_NUMERIC
	   This is a set of three-digit numeric codes from ISO 15924 such as 115 for Phoenician.

ROUTINES

       code2script ( CODE [,CODESET] )
       script2code ( NAME [,CODESET] )
       script_code2code ( CODE ,CODESET ,CODESET2 )
       all_script_codes ( [CODESET] )
       all_script_names ( [CODESET] )
       Locale::Script::rename_script  ( CODE ,NEW_NAME [,CODESET] )
       Locale::Script::add_script  ( CODE ,NAME [,CODESET] )
       Locale::Script::delete_script  ( CODE [,CODESET] )
       Locale::Script::add_script_alias  ( NAME ,NEW_NAME )
       Locale::Script::delete_script_alias  ( NAME )
       Locale::Script::rename_script_code  ( CODE ,NEW_CODE [,CODESET] )
       Locale::Script::add_script_code_alias  ( CODE ,NEW_CODE [,CODESET] )
       Locale::Script::delete_script_code_alias  ( CODE [,CODESET] )
	   These routines are all documented in the Locale::Codes::API man page.

SEE ALSO

       Locale::Codes
	   The Locale-Codes distribution.

       Locale::Codes::API
	   The list of functions supported by this module.

       http://www.unicode.org/iso15924/
	   Home page for ISO 15924.

       http://www.iana.org/assignments/language-subtag-registry
	   The IANA language subtag registry.

AUTHOR

       See Locale::Codes for full author history.

       Currently maintained by Sullivan Beck (sbeck@cpan.org).

COPYRIGHT

	  Copyright (c) 1997-2001 Canon Research Centre Europe (CRE).
	  Copyright (c) 2001-2010 Neil Bowers
	  Copyright (c) 2010-2012 Sullivan Beck

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.16.2							    2012-10-11						       Locale::Script(3pm)