编程与软件工程google.github.io
Shell 风格指南
Shell Style Guide
2016 — 2018,它一次次回到首页
黑点是上首页(≥ 50 分)的那次投稿,空心点是没冲上去的投稿,点越大分数越高。
导读
这是 Google 的 Shell 脚本风格指南,讨论 shell 脚本的适用场景以及 bash 脚本的编写规范。评论区围绕严格模式选项、shebang 写法、静态检查工具和“不要把复杂逻辑写进 shell”等实践展开补充。
为什么经久不衰:它把 shell 脚本的边界和可维护性问题讲得很清楚,多年后仍是编写和评审 shell 脚本时值得参考的基准。
HN 评论精选
建议使用严格模式选项,同时要理解其取舍。
我很惊讶指南没有推荐使用 set -e 等选项。也许这些不算“风格”,但我认为它们是编写 bash 脚本时最重要的设置之一。不过,如果你的脚本要启动其他程序再检查错误码,这些选项确实会带来麻烦,需要临时关闭再打开。
benmmurphy查看英文原文
i'm surprised it doesn't recommend using set -e /other flags. [http://redsymbol.net/articles/unofficial-bash-strict-mode/] maybe it is not covered because it is not considered 'style' but i think those flags are some of the most important things you can set when writing a bash script. i guess if you are writing scripts that start other things, and then check their error codes it can be annoying because you have turn them off/on.
用 env bash 作为 shebang 更便于移植。
我很惊讶他们选择 #!/bin/bash,而不是 #!/usr/bin/env bash。后者在脚本被到处传递时感觉更灵活、更可靠。
_arvin查看英文原文
I'm really surprised they went with: #!/bin/bash as opposed to: #!/usr/bin/env bash the latter feels more flexible and dependable for a script to be passed around.
推荐用 ShellCheck 对 shell 脚本做静态检查。
顺带一提,shellcheck.net 是一个很棒的 shell 代码静态检查工具。它可以在线使用,也有命令行版本,但最重要的是可以作为你常用编辑器的插件。
ronjouch查看英文原文
Tangentially, http://www.shellcheck.net/ is an awesome static linter for shell code. Available online, as a command-line tool, but most importantly as a plugin for your favorite $EDITOR.
限制 shell 脚本复杂度,简单场景优先考虑可移植的 sh。
指南里“限制 shell 脚本的适用范围”是最佳建议。shell 脚本很难维护,逻辑复杂就应该用 Perl 或 Python。但限制适用范围也意味着你不会用到 bash 的高级特性,所以更应该写成 sh,可移植性无疑更好,也能强化“不要写复杂 shell 脚本”的观念。
nickysielicki查看英文原文
> Bash is the only shell scripting language permitted for > executables. > [...] > The only exception to this is where you're forced to by whatever > you're coding for. One example of this is Solaris SVR4 packages > which require plain Bourne shell for any scripts. > [...] > When to use Shell > > * If you're mostly calling other utilities and are doing > relatively little data manipulation, shell is an acceptable choice > for the task. > > * If performance matters, use something other than shell. > > * If you find you need to use arrays for anything more than > assignment of ${PIPESTATUS}, you should use Python. > > * If you are writing a script that is more than 100 lines long, > you should probably be writing it in Python instead. Bear in mind > that scripts grow. > > * Rewrite your script in another language early to avoid a > time-consuming rewrite at a later date. Limiting the domain of shell scripts is the best advice in here. Shell scripts are terrible to maintain, and you should use perl or python if it's complicated. But limiting the domain of shell scripts also probably means that you're not going to be using any advanced features of bash, so you should write it in sh instead. It's undoubtedly more portable, and it also serves to enforce the idea that you shouldn't write complicated shell scripts. I'll take a leap and say it outright, if you're using a feature of bash that isn't in bourne shell, you shouldn't be writing it in either of them. The internet is littered with bash scripts that are compatible with bourne shell, but the shebang says '#!/bin/bash'. Well some systems don't have bash! But everyone has bourne shell. I'm disappointed by their choice of bash and how this guide might reinforce that behaviour, but other than that, the actual style guidelines are great. [Edit: rewording]
历次讨论
同类还值得读
开源应用架构
The Architecture of Open Source Applications
《开源软件架构》(AOSA)是一本在线免费书,邀请知名开源项目的作者亲自剖析其内部设计,涵盖 SQLAlchemy、LLVM、Audacity、Apache、Bash 等系统。
编程与软件工程上首页 9 次 · 2011–2024aosabook.org编辑精选编程语言简史:简短、不完整且多半错误
A Brief, Incomplete, and Mostly Wrong History of Programming Languages
一篇以戏谑、故意不准确的方式回顾编程语言史的博客文章,用夸张轶事和讽刺定义串起 Lisp、C、C++、Java、JavaScript、PHP 等语言。
编程与软件工程上首页 8 次 · 2009–2021james-iry.blogspot.comSQLite 是如何测试的
How SQLite is tested
SQLite 官方文档页,系统介绍 SQLite 的测试体系:多种测试方法(TCL 测试、模糊测试、回归测试、静态分析等)和海量测试用例,展示了这个小型开源项目如何靠极致测试获得…
编程与软件工程上首页 8 次 · 2009–2025sqlite.org编辑精选高级编程语言(2009)
Advanced programming languages (2009)
Matt Might 的经典文章,按用途推荐“高级编程语言”:如果追求就业就选主流语言,如果追求表达力、学术研究或创业,则推荐 Haskell、OCaml、Scala 等函数式语…
编程与软件工程上首页 8 次 · 2009–2022matt.might.net我的 Forth 与栈机器经历
Yosefk - My history with Forth & stack machines
作者以亲身经历回顾了使用 Forth 语言和栈式机器的历程:既赞叹其简洁优雅、代码量小、可自举的优点,也坦率指出栈操作在实际编程中的痛苦,以及 Forth 社区文化中的问题。
编程与软件工程上首页 8 次 · 2010–2024yosefk.com编辑精选