README

该包通过将开发工具组合成一个包，帮助S10包的开发，并提供一个甜美的命令行工具，用于生成s10组件的常见元素（Makefile、文件夹、法律文档、phpunit等）

尽管这个工具主要针对s10组件，但其中可能包含一些对其他人有用的内容！如果觉得有用，请告诉我！

安装

$ composer require --dev solution10/devkit

通过使用--dev选项，您确保当人们在生产中安装和使用您的组件时，不会下载devkit。

安装的依赖

phpUnit
PHP代码检查器
PHP Coveralls（用于Travis生成的覆盖率报告）
APIgen

命令行工具

命令行工具可以创建您需要的所有项目文件，要么一次性创建，要么只创建部分。

该工具可以创建：

目录（src/ tests/ 和 docs/）
.gitignore
"法律"文档（贡献、许可证和readme）
Makefile（带生成API文档的快捷方式）
PHPUnit配置和启动文件
Travis配置文件

使用$ ./vendor/bin/s10devkit list查看单独的命令和使用信息

如何使用Devkit

在开始一个新的组件。

$ mkdir s10-mycomponent
$ touch s10-mycomponent/composer.json

然后在composer.json中填写名称、描述和require-dev行，如下所示

{
    "name": "solution10/(put the name of your component here)",
    "description": "(put your component description here)",
    "minimum-stability": "stable",
    "license": "MIT",
    "authors": [
        {
            "name": "Your Name",
            "email": "Your Email"
        }
    ],
    "require-dev": {
        "solution10/devkit": "@dev"
    }
}

通过填写标题、描述和作者，devkit可以自动生成诸如README、phpUnit配置和许可信息等，而无需您手动操作。

现在只剩下运行composer install和devkit了

$ composer install
$ ./vendor/bin/s10devkit bootstrap-component

您可以选择生成所需的内容，而不是使用bootstrap-component

$ ./vendor/bin/s10devkit makefile && ./vendor/bin/s10devkit gitignore

要查看所有可用的生成器，只需列出

$ ./vendor/bin/s10devkit

Travis配置文件

默认情况下，Travis文件设置为运行phpunit和phpcs，但您当然可以将其更改为执行任何操作！

作者

Alex Gisby alex@solution10.com

solution10 / devkit

维护者

详细信息

README

安装

安装的依赖

命令行工具

如何使用Devkit

Travis配置文件

作者