如何创建自己的composer拓展包

Vinchan
289 阅读3分钟

注意：要先安装Composer，现在我们假定你已经安装了 Composer。

章节一：创建拓展包

1. 创建存放拓展包的目录

如图，我们创建一个名称为test-package的文件夹，用于存放拓展包的文件。建议:文件夹的命名与包的名称相同。

mkdir test-package

image.png

2. 进入test-package目录之后，然后开始创建拓展包的脚手架

1.进入目录注意：确保【终端】已经进入到拓展包文件夹的目录

cd test-package

image.png 2. 创建脚手架

1. composer init 
说明：在输入上面的命令'composer init'按回车，会弹出下面「2」的内容

2. Package name (<vendor>/<name>) [vinchan/test-package]: 
说明：这里是输入拓展包的名称，如：`vinchan/test-package`，然后按回车，弹出下面「3」的内容

3. Description []:
说明：这里是填写包的描述说明，然后按回车，弹出下面「4」的内容

4. Author [Vinchan <mail@mail.com>, n to skip]:
说明：这里是填写作者的基本信息，如: Vinchan<mail@mail.com>，然后按回车，弹出下面「5」的内容

5. Minimum Stability []:
说明：这里是设定最低的稳定版本。选项为：stable, RC, beta, alpha, dev。版本默认的稳定性依次从左到右从大到小，越左边越稳定bug越少。输入设定的版本后按回车，弹出下面「6」的内容

6. Package Type (e.g. library, project, metapackage, composer-plugin) []:
说明：这里是设定包的类型，如：library，按回车，弹出下面「7」的内容

7. License []:
说明：这里是设定包的协议，如：MIT，按回车，弹出下面「8」的内容

8. Would you like to define your dependencies (require) interactively [yes]?
说明：这里是选择是否对包的运行设定依赖。输入：yes/no，如果输入yes按回车，弹出下面「9」的内容，否则跳过「9」，弹出下面「11」的内容

9. Search for a package:
说明：这里是输入包的运行设定依赖。如：php (设定运行的php版本最低版本)。按回车，弹出下面「10」的内容

10. Enter the version constraint to require (or leave blank to use the latest version):
说明：这里声明依赖的版本号，如：>=7.4.*，按两次回车后，弹出下面「11」的内容

11. Would you like to define your dev dependencies (require-dev) interactively [yes]?
说明：这里是引入非生产拓展包，如：用于IDE提示的包。一直按回车，直到完成我们的根目录下分别生成了下面「12」的内容

12.
｜-composer.json composer拓展配置  
｜-src   拓展包代码存放目录  
｜-vendor

composer.json 目录详情

{
    "name": "vinchan/test-package",
    "autoload": {
        "psr-4": {
            "TestPackage\": "src/"
        }
    },
    "authors": [
        {
            "name": "Vinchan",
            "email": "mail@mail.com"
        }
    ],
    "require": {}
}

接下来就可以开发包内容了。要怎么安装本地的包到项目中呢？请看 章节三的本地包安装

章节二：发布拓展包

1. 发布公有包

  1. 把我们的包上传到github、gitee上面，并且打好标签。

  2. 在packagist提交我们的包，即可发布公有包啦。

image.png

2. 发布私有包

略过…

章节三：安装拓展包

1. 本地包安装

  1. 在项目中引入本地的包名称，如图：

image.png

具体的配置：

"require": {
    "vinchan/test-package": "dev-master"   此处引入引入包名，版本为 `dev-master`
},
"repositories": [ 
    {
        "type": "path",
        "url": "./test-package" 此处引入包的本地路径
    }
]
  1. 配置好之后执行composer update即可看到项目的vendor目录下生成test-package包的内容了。

2. 公有包安装

composer require vinchan/test-package

avatar
文章
阅读
粉丝