risse / pino-project
Pino项目的Composer模板
Requires
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6.5
- drupal-composer/drupal-scaffold: ^2.5
- drupal/console: ^1.0.2
- drupal/core: 8.7.*
- drush/drush: ^9.0.0
- risse/pino: ^8.1.4
- vlucas/phpdotenv: ^2.4
- webflo/drupal-core-require-dev: 8.7.*
- webflo/drupal-finder: ^1.0.0
- webmozart/path-util: ^2.3
Conflicts
README
此项目模板提供了一个入门套件,用于使用Composer管理您的网站依赖。
如果您想了解如何将其作为Drush Make的替代方案使用,请访问drupal.org上的文档。
用法
首先您需要 安装composer。
注意:以下说明参考了全局composer安装。您可能需要根据您的设置将
composer
替换为php composer.phar
(或类似)。
之后您可以创建项目
composer create-project risse/pino-project pino
使用composer require ...
,您可以将新的依赖项下载到您的安装中。
cd some-dir
composer require drupal/devel:~1.0
composer create-project
命令将所有文件的拥有权传递给创建的项目。您应该创建一个新的git仓库,并提交所有未被.gitignore文件排除的文件。
模板做了什么?
安装给定的composer.json
时,一些任务将被处理
- Drupal将安装在
web
目录。 - 实现了自动加载器,以使用位于
vendor/autoload.php
中生成的composer自动加载器,而不是Drupal提供的自动加载器(web/vendor/autoload.php
)。 - 模块(类型为
drupal-module
的包)将放置在web/modules/contrib/
。 - 主题(类型为
drupal-theme
的包)将放置在web/themes/contrib/
。 - 配置文件(类型为
drupal-profile
的包)将放置在web/profiles/contrib/
。 - 创建默认的可写版本的
settings.php
和services.yml
。 - 创建
web/sites/default/files
目录。 - 在本地安装最新版本的drush,以便在
vendor/bin/drush
中使用。 - 在本地安装最新版本的DrupalConsole,以便在
vendor/bin/drupal
中使用。 - 基于您的.env文件创建环境变量。请参阅.env.example。
更新Drupal核心
此项目将尝试保持所有Pino和Drupal核心文件的最新状态;使用drupal-composer/drupal-scaffold项目确保在每次drupal/core更新时,您的模板文件都会更新。如果您自定义了任何“模板”文件(通常是.htaccess),在Drupal核心的新版本中更新了您的修改文件时,您可能需要解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update risse/pino
以更新Pino及其依赖项。 - 运行
git diff
以确定是否有任何模板文件已更改。检查文件以查找任何更改,并将任何自定义修改恢复到.htaccess
或robots.txt
。 - 将所有内容作为一个单独的提交一起提交,这样在检查分支或运行
git bisect
时,web
将与core
保持同步。 - 如果在第2步中发生非平凡的冲突,您可能希望在这些步骤上创建一个分支,并使用
git merge
将更新的核心文件与您的自定义文件合并。这便于使用如kdiff3之类的三路合并工具。如果您的更改很简单,则不需要此设置;将所有修改保留在文件的开头或结尾是一种使合并变得容易的好策略。
从现有项目生成composer.json
使用"Composer Generate" drush 扩展,您现在可以从现有项目生成一个基本的composer.json
文件。请注意,生成的composer.json
可能与本项目的文件不同。
常见问题解答
我应该提交我下载的 contrib 模块吗?
Composer 推荐不提交。他们提供了反对的理由,但也提供了一些解决方案,如果项目决定这样做的话。
我应该提交脚手架文件吗?
drupal-scaffold 插件可以将脚手架文件(如index.php、update.php等)下载到您项目的web/目录。如果您没有自定义这些文件,您可以选择不将它们提交到您的版本控制系统(例如git)。如果您的项目是这样,在每次安装或更新您的项目后自动运行 drupal-scaffold 插件可能很方便。您可以通过在 composer.json 中注册 @composer drupal:scaffold
作为安装后和更新后的命令来实现这一点。
"scripts": {
"post-install-cmd": [
"@composer drupal:scaffold",
"..."
],
"post-update-cmd": [
"@composer drupal:scaffold",
"..."
]
},
我该如何应用下载的模块的补丁?
如果您需要应用补丁(根据要修改的项目,pull request 常常是一个更好的解决方案),您可以使用composer-patches 插件。
要向 drupal 模块 foobar 添加补丁,请将补丁部分插入 composer.json 的 extra 部分。
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL or local path to patch"
}
}
}
我如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?
请参阅 drupal.org 上的文档说明。
我该如何指定 PHP 版本?
目前 Drupal 8 支持 PHP 5.5.9 作为最低版本(见Drupal 8 PHP 要求),然而,执行 composer update
可能会升级某些包,这可能会使得需要 PHP 7+。
为了防止这种情况,您可以在 composer.json 的 config
部分添加以下代码来指定您想要使用的 PHP 版本:
"config": {
"sort-packages": true,
"platform": {"php": "5.5.9"}
},