aheenam / laravel-package-cli
一个用于为Laravel框架搭建包的小型CLI工具
Requires
- php: ^7.0
- league/flysystem: ^1.0
- nesbot/carbon: ^1.22
- symfony/console: ^4.0
- symfony/process: ^4.1
- symfony/var-dumper: ^4.0
Requires (Dev)
- league/flysystem-memory: ^1.0
- phpunit/phpunit: ^7.0
- spatie/phpunit-snapshot-assertions: ^1.1
README
本项目提供了一组简单的控制台命令,用于生成用于laravel包开发的目录结构。
例如,只需通过调用以下命令即可创建一个新的包的完整目录结构:laravel-package generate vendor/package-name
安装
将此命令作为全局composer包安装
$ composer global require aheenam/laravel-package-cli
使用
然后,您可以通过以下命令创建一个新的仓库
$ laravel-package generate vendor/package-name
此命令将创建一个名为 package-name
的目录,并设置一个基本的Laravel包创建环境。
目录结构如下
├── database/ │ ├── .gitkeep ├── config/ │ ├── package-name.php ├── src/ │ ├── PackageNameServiceProvider.php ├── tests/ │ ├── TestCase.php ├── .gitignore ├── CHANGELOG.md ├── composer.json ├── LICENSE ├── phpunit.xml ├── README.md
所有文件和类都将设置正确的名称和命名空间,但请记住,生成器只是创建一个起点。您应该检查文件并添加缺少的内容。
传递自定义路径
您还可以传递第二个参数,指定包应生成的路径。
$ laravel-package generate vendor/package-name packages/aheenam/
上面的例子会在 ./packages/aheenam/packages-name
生成包。如果您想在现有的Laravel项目中使用此生成器,这会很方便。
使用 --force
选项
默认情况下,如果已存在具有给定包名的目录,您将收到错误通知。您可以使用 --force
标志忽略现有目录。
$ laravel-package generate vendor/package-name --force
安装composer依赖
使用 --install
标志,您可以在生成包完成后,使命令切换到新目录并运行 composer install
以安装依赖项。
生成LICENSE
您可以通过传递选项来不仅创建一个空的LICENSE文件,还可以填充适当的LICENSE内容。
$ laravel-package generate vendor/package-name --license=MIT
目前实现了3种LICENSE类型: MIT
、Apache 2.0
和 GNU GPL v3
。只需传递名称,您就应该得到生成的LICENSE。
变更日志
查看变更日志
测试
要运行测试,请使用
$ composer test
如果您在Windows机器上工作,请使用
vendor\bin\phpunit
贡献
相关信息将随后提供
安全
如果您发现任何与安全相关的问题,请通过电子邮件rathes@aheenam.com或使用GitHub的问题跟踪器。
关于
Aheenam 是一家来自德国NRW的小公司,致力于创建定制的数字解决方案。访问我们的网站了解更多关于我们的信息。
许可协议
MIT许可协议(MIT)。请参阅许可文件获取更多信息。