Automation tool mixed with code generator for easier continuous development
Simplifies and automates:
Functionality is provided and can be extended with plugins.
There are several ways of installation in order of preference:
hiqdev/hidevin your project's composer.json
composer global require "hiqdev/hidev:*"
The main idea behind HiDev is to combine code generator and build tool to stop copying config files between your projects. And automate all the repeated tasks of course. But firstly generate all the files that can be generated, e.g.:
You write a simple config specifying general information about your package and plugins to be used. HiDev alone does nothing at all! You specify what you want it to do in config or use plugins. There are predefined plugins with generally usable configs or you can create plugins yourself.
hiqdev/hidev-php plugin is a general config for PHP projects and
will enable HiDev to create all the listed above files and adds goals to use:
hidev allor simply
hidevwill update config files according to the changes you made
hidev fix: will update
.php_csfile and run
php-cs-fixerto fix code style of your PHP files
hidev test: will update
phpunit.xmland run your tests with
hidev build: will do fix and test alltogether
hidev codeception: will bootstrap
codeception, update it's config and run tests with it
hidev bump/releasewill bump project version and publish release to GitHub
HiDev can generate different files: sources, tests, anything else based on templates and all the information available in config files or elsewhere.
Now I'm working to enable HiDev to do more:
HiDev keeps everything it needs: configs, plugins, intermediate files and so on
.hidev directory in the root of your project.
The main config file is:
You can generate basic config file with init command:
hidev init the-vendor/my-new-package
You will receive:
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: email@example.com plugins: hiqdev/hidev-php: "*"
Package section holds info about the package:
Also you can add more info for better README generation:
Vendor section holds info about you or your company:
Best way of configuring vendor is to create and use your vendor plugin for HiDev.
It's easy, just fork
hiqdev/hidev-hiqdev, change it appropriately and publish
Plugins section lists the plugins mentioning versions to be used for your package. Version constraints will be used with composer so must follow it's rules.
Good example of configuration is HiDev's own .hidev/config.yml.
Copyright © 2015-2017, HiQDev (http://hiqdev.com/)