risse / pino-dev
使用 Composer 进行 Pino 开发的项目模板
Requires
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6.5
- drupal-composer/drupal-scaffold: ^2.5
- drupal/coder: ^8.3
- drupal/console: ^1.0.2
- drupal/core: 8.7.*
- drush/drush: ^9.0.0
- risse/pino: dev-master
- squizlabs/php_codesniffer: ^3.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 drupal-composer/drupal-project:8.x-dev some-dir --stability dev --no-interaction
使用 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 核心版本
本项目将尝试保持所有 Drupal 核心文件的最新状态;使用 drupal-composer/drupal-scaffold 项目确保每次 drupal/core 更新时,您的支架文件都会更新。如果您自定义了任何“支架”文件(通常是 .htaccess),在 Drupal 核心新版本发布时,如果您的任何修改文件被更新,您可能需要解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies
来更新 Drupal 核心和其依赖项。 - 运行
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
作为post-install和post-update命令来实现这一点。
"scripts": {
"post-install-cmd": [
"@composer drupal:scaffold",
"..."
],
"post-update-cmd": [
"@composer drupal:scaffold",
"..."
]
},
如何应用下载的模块的补丁?
如果您需要应用补丁(根据要修改的项目,pull request通常是一个更好的解决方案),您可以使用composer-patches插件。
要将补丁添加到drupal模块foobar,请将patches部分插入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"}
},