assertwell/shellcheck

将ShellCheck作为供应商二进制文件暴露给PHP项目

维护者

详细信息

github.com/assertwell/shellcheck

源码

问题

安装量: 25,227

依赖者: 2

建议者: 0

安全性: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

语言:Shell

v1.0.2 2022-02-09 15:45 UTC

MIT a68b0e934a5746fcfc785bb635e72b9d98cdc939

This package is auto-updated.

Last update: 2024-09-09 21:13:38 UTC

README

Vidar Holen的ShellCheck是调试shell脚本的无价工具，此包使其轻松导入基于PHP项目的测试流程！

工作原理

此包包含一个bin/shellcheck脚本，作为系统已安装的ShellCheck副本的代理；如果找到ShellCheck二进制文件，则参数将正常传递给它。如果本地未找到ShellCheck，用户将看到以下通知

ShellCheck未在您的$PATH中找到！请访问https://github.com/koalaman/shellcheck#installing以获取安装说明。

通常，这会导致非零退出代码（2），尽管可以使用--ignore-missing选项抑制此行为

$ vendor/bin/shellcheck --ignore-missing some-script.sh

ShellCheck was not found in your $PATH!
Please visit https://github.com/koalaman/shellcheck#installing for installation instructions.

$ echo $?
0

安装

安装此包的最简单方法是使用Composer

$ composer require --dev assertwell/shellcheck

您可能希望添加一个Composer脚本，以便团队成员更容易运行ShellCheck

# composer.json
{
    // ...
    "scripts": {
        "test:shellcheck": [
            "shellcheck bin/*"
        ]
    },
    "scripts-descriptions": [
        "test:shellcheck": "Lint shell scripts via ShellCheck"
    ]
}

至于ShellCheck本身的安装，请参阅ShellCheck文档中最相关的安装说明。

许可证

assertwell/shellcheck Composer包在MIT许可证下可用.

ShellCheck本身由Vidar Holden拥有版权，并在GPLv3许可证下提供。