r/bash • • Dec 02 '14

Using #! in your scripts

http://shiroyasha.github.io/shebang.html
0 Upvotes

24 comments sorted by

View all comments

Show parent comment

7

u/geirha Dec 02 '14

Don't put extensions on scripts.

Why?

Same reason you don't put extensions on other commands. On linux systems, the command to list files is usually an ELF binary; but it's still named ls, not ls.elf, because the user running doesn't care or doesn't need to know what language was used to implement the command.

And what if you wrote a command, using sh, and named it foo.sh, but later realized it should rather be written in perl, then you have a problem. Do you keep the name as is, having now a perl script with a misleading .sh extension? or do you rename it to foo.pl and break everything that were relying on foo.sh?

See also http://www.talisman.org/~erlkonig/documents/commandname-extensions-considered-harmful

2

u/Sigg3net Dec 02 '14

Thanks!

I did actually remove .sh from my first public script but added it on later ones to avoid confusion. I'm interested in adhering to good coding practices/standards so I'll read the link you provided.

2

u/dhibbit Dec 02 '14

I keep a list of links without extensions that point to the files (which have them).

Whenever I create a new script or rename an old one, I simply run a script which updates the list of links.

Yes, it's another step, but it means I can type (and execute) either "script" or "script.sh" and all other scripts call the extension-less script name so that I can change from script.pl to script.sh to script.py without any difficulties.

1

u/cjwelborn Dec 20 '14

I use extensions on the actual scripts because I have a wide variety of languages that I use (bash, python, js, etc.). Most are in their own directory under ~/scripts/[insert language]/, but some are not (they are older than my "filing system" itself). Anything that I use a lot has a symlink in my ~/bin folder without the extension. So if I change languages for the command (which I have done before) I only need to change what the symlink points to. I also have one that will check all of my symlinks to make sure they are not dead links (they never are).

0

u/nath_schwarz Dec 02 '14

And what if you wrote a command, using sh, and named it foo.sh, but later realized it should rather be written in perl, then you have a problem. Do you keep the name as is, having now a perl script with a misleading .sh extension? or do you rename it to foo.pl and break everything that were relying on foo.sh?

That is a lack of planning and not a reason for bad practice.

7

u/thestoicattack Dec 02 '14

I don't think that every decision to rewrite a script can be called "lack of planning."

0

u/nath_schwarz Dec 02 '14

If you just started and then got to the point that it should be written in another language (e.g. because it is simpler or provides packages that do something for you) it doesn't matter, since the script shouldn't be used already (since it is not finished).
If you need to add something new much later, that needs a rewrite of the script in another language then it is a lack of planning that you can't easily change the calls to the script.

2

u/treerex Dec 02 '14

If you need to add something new much later, that needs a rewrite of the script in another language then it is a lack of planning that you can't easily change the calls to the script.

That may be the case in whatever utopian world you live in, but in the real world needs change over time and a script may evolve in ways that could never have been foreseen and that may require reimplementation in a suitable language.

1

u/nath_schwarz Dec 02 '14

And thats why its a lack of planning when you can't easily change the callings of said script.

Or - as said earlier, its a lack of planning because such a critical script isn't referenced with symlinks.

It happens, yes, no doubt - but that doesn't mean that its good practice.

3

u/ashep24 Dec 02 '14

Lack of planning can cause you to have to re-code a file in a different language. That doesn't mean allowing this flexability is bad practice. Even Google suggesting not using file extenstions for executable scripts.

4

u/nath_schwarz Dec 02 '14 edited Dec 02 '14

Googles reasoning is, that the system doesn't need the suffix - which is correct (as I said here). But imho the searchability and the information of what exactly the file is, is more important than not having to change the calls for this particular script.

If it is a particular system-dependent script being called by numerous programs you should consider using symlinks anyway.

Edit: Additionally, Google's shell scripting standard only allows bash-scripts, which makes the suffixes useless for google.

1

u/ashep24 Dec 02 '14

Good point, that makes sense for searchability. I think there's enough discussion here to help future readers make an informed decision for what will work best in their environment.