bmartel/workshop

为网络工匠提供的包生成器。

1.0.7 2015-09-07 19:33 UTC

This package is not auto-updated.

Last update: 2024-09-24 03:02:58 UTC


README

Workshop 是一个命令行工具,用于快速生成基于 Laravel 的 composer 包。

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

用法

安装

composer global require "bmartel/workshop=~1.0"

构建某个东西

workshop build vendor/package

cd package,您将看到用于构建包的骨架结构。

Laravel 生成器

为了方便,大多数 Laravel 生成器都已包含在内,您可以快速构建基于 Laravel 的包。

您在 Laravel 项目中熟悉的所有 make: 生成器命令,如 php artisan make:{something},都可通过 workshop build:{something} 获取。所有命令也都可以通过 make 别名 workshop make:{something} 获取,因此您只需记住命令的 Laravel API。

默认情况下,所有生成器都将生成的类文件放置在基于您的命名空间和文件夹结构的最佳猜测位置。如果默认设置不适合您,您始终可以通过将完整的类命名空间作为名称参数提供给生成器命令来显式指定您想要生成的文件的位置。

迁移将始终生成到包的根级别 migrations 文件夹。这是由于所有 workshop 框架包中包含的 ServiceProvider 的结构和默认处理。

workshop build:console <name> [--command]
workshop build:controller <name> [--plain]
workshop build:event <name> 
workshop build:job <name> [--queued]
workshop build:listener <name> (--event) [--queued]
workshop build:middleware <name>
workshop build:migration <name> [--create] [--table]
workshop build:model <name> [--migration]
workshop build:request <name>

有关特定命令的更多信息,请参阅 Laravel 官方文档。

Laravel 包

您可以使用此包并在您可能拥有的本地 Laravel 应用程序中开发它。要将此包拉入您的本地开发应用程序,请将提供的 vendor/package 作为参数添加到 workshop build 命令中,并添加到应用程序的 composer.json 文件(假设创建的包为 acme/sprockets)

require: {
    "acme/sprockets": "dev-master"
},
"repositories": [
	{
		"type": "vcs",
		"url": "/path/to/where/acme/sprockets/was/created/locally"
	}
],

从您的 Laravel 应用程序的根目录运行 composer update acme/sprockets,您就可以轻松地进行本地包开发了。

开发工作流程简单到:在本地文件系统中更改包,转到您包含包的本地 Laravel 开发应用程序,并运行 composer update vendor/package。重复此过程,直到您准备好将其推送到 github 或 bitbucket,并将包添加到 Packagist。在此之后,您可以删除存储库条目,只需包含包的 composer require 条目即可。

就是这样。花更多的时间构建伟大的东西,而不是花时间命名、重命名和复制文件。

贡献

所有贡献,无论是功能还是修复,都应该由概述所做工作的测试来支持。拉取请求应提交到 develop 分支。

开发

要开始开发,请在项目的根目录中运行 composer install 并开始进行更改。在您开发过程中,您可以通过 vendor/bin/phpspec run -v 运行测试。

致谢

由 Brandon Martel 开发和维护