ennerd/sourcedog

命令行工具,用于监控源树中的文件并执行代码风格检查和其他有用功能。

安装: 51

依赖: 1

建议者: 0

安全: 0

类型:项目

1.0.19 2021-07-23 08:56 UTC

This package is auto-updated.

Last update: 2024-08-23 15:26:36 UTC


README

监控您的源树。提供有用信息。在开发时请保持此工具运行!

全局安装

# Install globally
composer global require ennerd/sourcedog

# The file is located in ~/.config/composer/vendor/bin/sourcedog
# Add this to your path by appending the following to your ~/.profile or ~/.bashrc file
PATH=$PATH:~/.config/composer/vendor/bin

按项目安装

# Require sourcedog in your project
composer require --dev ennerd/sourcedog

# The file will be placed in your vendor/bin directory
# You should add this path to your PATH environment variable by appending this to your
# ~/.profile or ~/.bashrc file. Replace ~/vendor/ with your actual vendor path.
PATH=$PATH:~/vendor/bin

基本用法示例

扫描当前文件夹中的所有文件

# sourcedog

使用inotify监控所有文件以检测修改。

# sourcedog -m

其他选项

# sourcedog --help

选项文件

您可以在~/sourcedog.yaml创建一个选项文件。目前仅支持一个选项

tail:
  - /var/log/nginx/*.log
  - /var/log/mysql/*.log
  - /var/log/mysql*.log
  - /var/log/php*.log

这将导致SourceDog搜索匹配模式的文件,然后在后台运行tail -f -n 0 <your files>以输出任何新行。

代码风格检查

SourceDog将对受支持类型的所有修改文件进行代码风格检查。目前支持.css、.js、.json、.yaml和.php。

贡献

如果您希望为其他文件类型添加代码风格检查支持,创建一个依赖于ennerd/sourcedog的composer包,并在composer.json自动加载文件中注册您的代码风格检查器。

$GLOBALS['SourceDogLinters'][] = MyClassName::class;

您的类必须扩展SourceDog\Linters\Linter

我也接受pull请求。

想法

  • 用于记录元数据和错误预防的数据库?
    • 已更改的文件。花费的时间。(是否理解nano、vim、vi临时文件?)
    • 所有文件的备份?检测到.filename.ext.swp文件时的短时间内备份?
  • 对WordPress等常见开源软件提供特殊支持。漏洞数据库?
  • 针对后门和已知漏洞的启发式扫描。
  • 自动后处理各种文件类型
    • yourfile.ts -> yourfile.js(使用tsc)
    • yourfile.js -> yourfile.min.js(压缩)
    • yourfile.scss -> yourfile.css
    • yourfile.css -> yourfile.min.css
    • yourfile.js -> yourfile.js.map
    • yourfile.less -> yourfile.css
  • 监控错误和访问日志。
  • 在文件更改后输出git diff和/或git status。
  • 要求特殊ubuntu软件包(如php-mbstring等)的功能?以帮助在新服务器上安装。