hiqdev/hidev

自动化工具与代码生成器相结合,简化持续开发

0.6.2 2018-10-27 11:25 UTC

README

自动化工具与代码生成器相结合,简化持续开发

Latest Stable Version Total Downloads Build Status Scrutinizer Code Coverage Scrutinizer Code Quality Dependency Status

简化并自动化

功能提供并可扩展插件

安装

有多种安装方式,以下为推荐顺序

  1. http://hiqdev.com/hidev/hidev.phar下载PHAR
  2. 在项目composer.json中添加hiqdev/hidev
  3. 全局安装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 bumphidev 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 中的描述)
  • typekeywords:与包管理器中的相同

您还可以添加更多信息以生成更好的 README

  • headline:您项目的简短用户友好名称,用于 README 标题
  • description:更长的描述

供应商部分包含有关您或您公司的信息

  • name:与包管理器中的相同
  • title:完整的供应商名称,将用于 README、LICENSE 等
  • githubhomepageforumemail:显然
  • license:如果包未指定,将使用此许可证
  • authors:作者数组,见:HiQDev 的配置

配置供应商的最佳方式是创建并使用您的 HiDev 插件。这很简单,只需fork hiqdev/hidev-hiqdev,进行适当的更改,并发布到 Packagist。

有关 HiDev 配置的示例,您可以在 我们的 GitHub 仓库 中查看,它们都使用 HiDev 自动化。

用法

hidev goal[/action]

许可证

本项目根据 BSD-3-Clause 许可证发布。更多信息请参见 此处

版权所有 © 2015-2018,HiQDev (http://hiqdev.com/)