this post was submitted on 26 Jun 2024
88 points (96.8% liked)

Linux

48287 readers
652 users here now

From Wikipedia, the free encyclopedia

Linux is a family of open source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991 by Linus Torvalds. Linux is typically packaged in a Linux distribution (or distro for short).

Distributions include the Linux kernel and supporting system software and libraries, many of which are provided by the GNU Project. Many Linux distributions use the word "Linux" in their name, but the Free Software Foundation uses the name GNU/Linux to emphasize the importance of GNU software, causing some controversy.

Rules

Related Communities

Community icon by Alpár-Etele Méder, licensed under CC BY 3.0

founded 5 years ago
MODERATORS
88
submitted 4 months ago* (last edited 4 months ago) by t0mri@lemmy.ml to c/linux@lemmy.ml
 

i didnt care about how i wrote my bash scripts, coz i know theyd ultimately be used just by myself. but for the past few day, i've been working on this project, mk-blog which uses some bash scripts, there are chances that others might look at them. besides in work they're asking me maintain a server. so why not learn the standards. but i couldn't find anything good online (i'm gonna blame my search engine lol). so...

i'd appreciate redirections to (official or community) bash coding standards

you are viewing a single comment's thread
view the rest of the comments
[–] demizerone@lemmy.world 10 points 4 months ago (4 children)

If your bash script gets longer than 200 lines (including argument handling), use Python. I have to support bash APPLICATIONS at work and it's a fucking nightmare to maintain.

[–] Zucca@sopuli.xyz 5 points 4 months ago* (last edited 4 months ago) (3 children)

I would then assume those scripts weren't written properly to begin with.

But yes, shell scripts should be used (normally) to automate some simple tasks (file copying, backups...) or as an wrapper to exec some other program. I've written several shell scripts to automate things on my personal machines.

However shell script can be complex program while at the same time being (somewhat) easy to maintain:

  • functions, use functions, alot
    • comment every function and describe what it expects in stdin or as an arguments
    • also comment what it outputs or sets

This way at least I don't break my scripts, when I need to modify a function or some way extend my scripts. Keeping the UNIX philosophy inside shell scripts: let one function do one thing well.

And of course: YMMV. People have wastly different coding standards when it comes to personal little(?) projects.

[–] barsquid@lemmy.world 1 points 4 months ago (2 children)

How do you unit test something like that?

[–] Zucca@sopuli.xyz 2 points 4 months ago

I had several tests at the beginning of the script. These tests define the "low-level" functions based the capability of the shell. To test new features I "simply" ran all the necessary commands on the test environments (bash, busybox, toybox+mksh).

The script would error out if some necessary capability was missing from the host system. It also had a feature to switch shell if it found a better one (preferring busybox and its internal tools).

Yeah... It was tedious process. It was one of those "I'll write a simple script. So simple that it'll work on almost every posixy shell."... rest is history.

load more comments (1 replies)
load more comments (1 replies)
load more comments (1 replies)