hiqdev / hidev
自动化工具与代码生成器相结合,简化持续开发
Requires
- hiqdev/yii2-collection: *
- symfony/yaml: ^3.0 || ^2.0
- yiisoft/yii2: ^2.0 || ^3.0
- yiisoft/yii2-twig: ^2.0
Requires (Dev)
- hiqdev/composer-config-plugin: dev-master
- yiisoft/yii2: dev-master
This package is auto-updated.
Last update: 2024-08-31 11:39:06 UTC
README
自动化工具与代码生成器相结合,简化持续开发
简化并自动化
- 包管理: Composer, Packagist
- 发布: README, LICENSE, CHANGELOG, 版本升级
- CI服务集成: Travis, Scrutinizer
- 测试: PHPUnit, Codeception
- 代码质量检查: PHP-CS-Fixer, VersionEye
- 版本控制管理: .gitignore, GitHub
- 使用Box构建PHAR
- 使用php和twig模板进行代码生成
功能提供并可扩展插件。
安装
有多种安装方式,以下为推荐顺序
- 从http://hiqdev.com/hidev/hidev.phar下载PHAR
- 在项目composer.json中添加
hiqdev/hidev
- 全局安装
composer global require "hiqdev/hidev:*"
理念
HiDev的核心理念是将代码生成器和构建工具结合,停止在不同项目间复制配置文件。当然,也要自动化所有重复性任务。但首先生成所有可以生成的文件,例如:
.gitignore
,README.md
,LICENSE
,CHANGELOG.md
composer.json
.travis.yml
,.scrutinizer.yml
phpunit.xml
,codeception.yml
.php_cs
您只需编写一个简单的配置文件,指定您的包和要使用的插件的一般信息。HiDev本身不会做任何事情!您需要指定它在配置文件中要做什么,或使用插件。有一些预设的插件,带有通用的配置,或者您可以自己创建插件。
例如,hiqdev/hidev-php
插件为PHP项目提供了一个通用配置,将使HiDev能够创建上述所有文件,并添加使用目标
hidev default
或简单地hidev
将根据您所做的更改更新配置文件hidev fix
:将更新.php_cs
文件并运行php-cs-fixer
以修复PHP文件的代码风格hidev test
:将更新phpunit.xml
并使用phpunit
运行您的测试hidev build
:将一起执行修复和测试hidev bump
和hidev release
将升级项目版本并将发布到GitHub
HiDev可以生成不同的文件:源代码、测试、基于模板和配置文件或其它地方中的所有可用信息的任何内容。
现在,我正在努力让HiDev做更多的事情
- 项目初始化和部署
- 与其他构建工具集成:robo、grunt、gulp、...
- 更多Python功能:pep8、测试、...
配置
主要配置文件是:hidev.yml
。
您可以使用 init 命令生成基本配置文件
hidev init the-vendor/my-new-package
您将收到
package: type: project name: my-new-package title: My New Package keywords: my, new, package vendor: name: the-vendor authors: hiqsol: name: Andrii Vasyliev email: sol@hiqdev.com
包部分包含有关包的信息
- name:您的包名称,与包管理器中的名称相同,但不包含供应商名称
- title:您的包的单行描述(在 composer.json 中的描述)
- type,keywords:与包管理器中的相同
您还可以添加更多信息以生成更好的 README
- headline:您项目的简短用户友好名称,用于 README 标题
- description:更长的描述
供应商部分包含有关您或您公司的信息
- name:与包管理器中的相同
- title:完整的供应商名称,将用于 README、LICENSE 等
- github,homepage,forum,email:显然
- license:如果包未指定,将使用此许可证
- authors:作者数组,见:HiQDev 的配置
配置供应商的最佳方式是创建并使用您的 HiDev 插件。这很简单,只需fork hiqdev/hidev-hiqdev
,进行适当的更改,并发布到 Packagist。
有关 HiDev 配置的示例,您可以在 我们的 GitHub 仓库 中查看,它们都使用 HiDev 自动化。
用法
hidev goal[/action]
许可证
本项目根据 BSD-3-Clause 许可证发布。更多信息请参见 此处。
版权所有 © 2015-2018,HiQDev (http://hiqdev.com/)