mylk / chronis
使用自然语言表达式的 crontab 生成器
0.8.1
2019-06-18 20:45 UTC
Requires
- php: >=7.0.0
- bentools/natural-cron-expression: ^1.0
- symfony/config: ^4.3
- symfony/console: ^4.3
- symfony/dependency-injection: ^4.3
- symfony/yaml: ^4.3
Requires (Dev)
- phpmd/phpmd: ^2.6
- phpunit/phpunit: 8.2.*
- squizlabs/php_codesniffer: ^3.4
README
由于cron表达式不易理解和编写,Chronis可以帮助您使用自然语言定义cron作业,并将为您生成crontab文件。
这还将允许您在结构化文件(YAML)中版本控制
cron作业定义,并在您的部署
过程中生成crontab。
用法
先决条件
Chronis运行需要PHP 7。
安装
将Chronis包含到您的PHP项目中
composer require mylk/chronis
您也可以将Chronis作为全局命令安装,而不是作为项目的依赖项
composer global require mylk/chronis
运行
执行Chronis并获取帮助
vendor/bin/chronis list
当Chronis作为全局命令安装时,首先确保$HOME/.config/composer/vendor/bin/
已添加到您的系统$PATH
。然后您可以从任何地方执行Chronis
chronis list
然后,您需要一个yaml
文件来定义您的cron作业。您可以从这里作为示例开始。
导出crontab
vendor/bin/chronis dump --config=YOUR_YAML_FILE_PATH
导出crontab
vendor/bin/chronis export --config=YOUR_YAML_FILE_PATH --output=my_crontab
使用--output
参数不是必需的。如果没有提供,crontab将被导出到当前目录中名为crontab
的文件。
贡献
Chronis是开源的,当然您可以贡献。只需fork项目,享受其中,然后创建一个pull request。
已创建一个Makefile
来分组开发所需的一些任务。以下是一些任务。
运行测试
make tests
语法检查
make check-syntax
编码风格检查
遵循的编码风格是PSR-2。
make check-style
质量检查
make check-quality
构建工具
- symfony/console - 用于命令行界面的库
- bpolaszek/natural-cron-expression - 将自然语言转换为cron表达式的库
- symfony/yaml - 用于读取cron作业YAML配置的库
- symfony/dependency-injection - 实例化项目中使用的服务的库
版本控制
使用SemVer
进行版本控制。有关可用的版本,请参阅tags。
作者
请参阅贡献者列表。
许可证
本项目受GPLv2许可证的许可 - 有关详细信息,请参阅LICENSE文件。