README

此 Composer 插件将安装扩展到您的 Joomla 安装中。

用法

定义一个包

开始使用最简单的方式是在您的 composer.json 文件中定义一个自定义包。您只需要您要安装的扩展的包文件。（例如，从供应商网站上下载的安装程序文件）

通过在 Joomla 安装根目录的 composer.json 文件中添加以下属性来更新该文件

{
    	"repositories": [
        	{
            	"type": "package",
            	"package": {
                	"name": "vendor/extension",
                	"type": "joomlatools-extension",
                	"version": "1.0.0",
                	"dist": {
                    	"url": "file:////Users/johndoe/Downloads/com_extension.1.0.0.tar.gz",
                    	"type": "tar"
                	},
                	"require": {
                    	"joomlatools/composer": "*"
                	}
            	}
        	}
    	],

        ...

    	"require": {
	        ...
    		"vendor/extension": "1.0.0"
    	}
}

使用此 JSON 文件，我们已定义了自己的自定义包。请注意以下设置

• type 必须设置为 joomlatools-extension
• 确保 url 指令指向安装包的位置。

执行 composer install 将会检索 joomlatools/composer 插件并使用它来将包安装到您的 Joomla 安装中。

有关创建不支持 Composer 的项目的自定义包的更多信息，请参阅 Composer 文档。

创建自定义包

要使用 Composer 的所有功能，例如升级到较新版本，您最好使用您扩展的源代码创建包。

包定义应包含以下基本信息，以便它可以安装到 Joomla 中

{
    	"name": "vendor/my-extension",
		"type": "joomlatools-extension",
    	"require": {
        	"joomlatools/composer": "*"
    	}
}

如果您想从 Github 或任何其他 VCS 直接提供您的扩展，请确保您的存储库中的文件布局与您的安装包相似。

如果您想在运行安装之前将主要的 Joomla 安装程序清单移动到存储库根目录，请在您的 composer.json 文件中提供以下信息

{
	"extra": {
    	"manifest": "path/to/manifest/joomlatools.xml"
	}
}

如果该包是为 Joomlatools 框架的可重用组件，请在您的 composer.json 文件中提供以下信息

{
	"extra": {
    	"joomlatools-component": "component-name"
	}
}

您现在可以在 Packagist 上发布您的扩展或使用您自己的 Satis 存储库提供服务。

有关创建自定义包的更多信息，请参阅 Composer 文档。

更多信息

有关更多信息、常见问题解答和示例，请参阅我们的 开发者文档。

开发

请参考维基页面了解如何设置本地开发环境。

调试

遇到问题？您可以增加Composer的详细程度设置（-v|vv|vvv）来收集更多信息。增加Composer的详细程度也会启用Joomla的日志消息。

要求

• Composer
• Joomla版本3.6+

贡献

joomlatools/composer插件是一个开源、社区驱动的项目。我们欢迎所有人贡献。我们有一份贡献指南来帮助您开始。

贡献者

查看贡献者列表。

许可

joomlatools/composer插件是免费和开源软件，受GPLv3许可许可。

社区

跟踪开发社区新闻。

• 关注@joomlatoolsdev在Twitter上
• 加入joomlatools/dev在Gitter上
• 阅读Joomlatools开发者博客
• 订阅Joomlatools开发者通讯