如何使用 shfmt 更好地格式化 Shell 脚本

您所在的位置:网站首页 Shell脚本格式化u盘 如何使用 shfmt 更好地格式化 Shell 脚本

如何使用 shfmt 更好地格式化 Shell 脚本

2024-07-15 15:28:18| 来源: 网络整理| 查看: 265

如何使用 shfmt 更好地格式化 Shell 脚本

是的,格式化是必要的,并且对理解复杂代码有很大帮助。然而,对于经常编写 shell 脚本的人来说,双重检查格式可能会成为一项繁琐的工作。本文将向您展示如何使用 shfmt 简化工作!

什么是 shfmt?

shfmt 由 Dustin Krysak 开发,是一个 Shell 格式化程序、解析器和解释器。该项目本身托管在 GitHub 上,并具有清晰的自述文件和清晰呈现的存储库。该工具是用 Go 语言开发的,支持 POSIX、Bash 和 mksh shell。这使得 shfmt 成为真正的通用程序,而不是仅限于 Bash。

安装 shfmt

要在支持 snap 的 Linux 发行版(如 Ubuntu 和 Mint)上安装 shfmt,请在终端中执行以下命令:

sudo snap install shfmt

要在基于 RedHat/Yum 的 Linux 发行版(如 RHEL、Centos 和 Fedora)上安装 shfmt,请在终端中执行以下命令:

注意:在执行第一个命令后和执行下一个命令之前,您必须重新启动计算机(或注销并重新登录)。

sudo dnf install snapd sudo snap install snap-store sudo snap install shfmt

在 RHEL 和 Centos 上,您可能还必须先安装 EPEL 存储库。

使用 shfmt

安装 snap 包后,您可以开始使用 shfmt。

让我们定义一个格式和编写都很糟糕的脚本 test.sh 如下:

#!/bin/bash__ echo 'not well formatted line 1' echo 'not well formatted line 2' echo 'this line has extra spaces on the end > ' func() { echo 'more unneeded spaces' echo 'way out' } func ()

这个脚本有几个问题,最突出的是它的格式。但是脚本中也有一个错误/错误:最后一行的函数调用 func 后面跟着更多的括号。 Bash 中的函数调用(而不是函数定义)应该只有名称,而不是方括号。发生正确的函数定义要高一些。

让我们看看 shfmt 对此有何看法。

shfmt test.sh

虽然输出看起来有点神秘,但请注意术语 foo(此处使用)和 bar(此处未使用)经常在 IT 圈子中用来指示/表示任何像成语或元素。 foo 这里实际上是指 func。

即便如此,消息仍然有点神秘,直到我们意识到,查看最后一行,真正发生的是函数定义的开始(而不是函数调用),因为包含了两个括号。这就解释了为什么消息告诉我们还有更多的期待; 后面必须跟一个声明。 shmft 在这里寻找类似 func(){ some_command[s]; 的东西}。

答对了!这将 shfmt 的功能增加为一个 shell 脚本验证/检查工具,尽管可能远不及我们在使用 shellcheck 查找和修复脚本错误时所写的那样全面。不过,确实非常方便!

我们修复了错误,现在输入脚本 test.sh 如下所示:

#!/bin/bash__ echo 'not well formatted line 1' echo 'not well formatted line 2' echo 'this line has extra spaces on the end > ' func() { echo 'more unneeded spaces' echo 'way out' } func

我们再次对代码执行 shfmt 并收到更合适且格式良好的输出:

伟大的。我们现在可以更进一步,并向 shfmt 表明我们希望使用两个空格的缩进/制表符宽度而不是完整的制表符。我总是使用两个空格作为缩进/制表符宽度来编写代码,并在下一行的命令与上一行密切相关的地方使用额外的空格,例如连续命令等,尽管这种情况并不经常发生。十多年来,我发现这两个空间是个人和共享项目的理想之选。

每个人和每个项目都必须找到自己理想的语法,但请注意,如果您使用像上面示例中 shfmt 所呈现的格式那样的大制表符(8 个空格),您的代码可能会变得更难阅读容易地。

我们将使用 -i 选项将缩进/制表符宽度设置为两个空格(--help 定义为 indent: 0 for tabs(默认), >0 表示空格数):shfmt -i 2 test.sh 将按如下方式呈现脚本:

#!/bin/bash__ echo 'not well formatted line 1' echo 'not well formatted line 2' echo 'this line has extra spaces on the end > ' func() { echo 'more unneeded spaces' echo 'way out' } func

伟大的!然而,我们注意到 shfmt 没有发现我们故意的错误:#!/bin/bash__ 不正确,应该读作 #!/bin/bash 代替。

因此,除了使用 shfmt 更好地格式化脚本之外,还有一个使用 shellcheck 来查找脚本错误的用例。然而,有趣的是,在这种特殊情况下,即使 shellcheck 也没有注意到这个问题。这个缺点已报告给 shellcheck 团队,因此可能会在适当的时候修复。

如果您有兴趣了解有关 Linux 的更多信息,可以查看 Bash 自动化和脚本基础系列,以及 Bash 循环:for、while 和 until Bash 循环:for、while 和 until 以及在 Bash 中导出变量:the为什么和如何文章。

包起来

当您使用像 shfmt 这样的 shell 格式化工具和像 shellcheck 这样的错误/错误检查器时,能够编写干净、格式良好且没有错误的脚本变得更容易.即便如此,正如我们所见,有些事情甚至在您第一次运行脚本的那一刻都可能被忽视。 shfmt 是一个小巧但有效的实用程序,可帮助您根据所选的缩进来格式化脚本和代码。 尽情享受吧!



【本文地址】

公司简介

联系我们

今日新闻


点击排行

实验室常用的仪器、试剂和
说到实验室常用到的东西,主要就分为仪器、试剂和耗
不用再找了,全球10大实验
01、赛默飞世尔科技(热电)Thermo Fisher Scientif
三代水柜的量产巅峰T-72坦
作者:寞寒最近,西边闹腾挺大,本来小寞以为忙完这
通风柜跟实验室通风系统有
说到通风柜跟实验室通风,不少人都纠结二者到底是不
集消毒杀菌、烘干收纳为一
厨房是家里细菌较多的地方,潮湿的环境、没有完全密
实验室设备之全钢实验台如
全钢实验台是实验室家具中较为重要的家具之一,很多

推荐新闻


图片新闻

实验室药品柜的特性有哪些
实验室药品柜是实验室家具的重要组成部分之一,主要
小学科学实验中有哪些教学
计算机 计算器 一般 打孔器 打气筒 仪器车 显微镜
实验室各种仪器原理动图讲
1.紫外分光光谱UV分析原理:吸收紫外光能量,引起分
高中化学常见仪器及实验装
1、可加热仪器:2、计量仪器:(1)仪器A的名称:量
微生物操作主要设备和器具
今天盘点一下微生物操作主要设备和器具,别嫌我啰嗦
浅谈通风柜使用基本常识
 众所周知,通风柜功能中最主要的就是排气功能。在

专题文章

    CopyRight 2018-2019 实验室设备网 版权所有 win10的实时保护怎么永久关闭