pacifica / drupal-project
Drupal 8 Pacifica项目使用的composer模板
Requires
- php: >=7.0.8
- composer/installers: ^1.2
- drupal/core-composer-scaffold: ^8.8
- drupal/core-project-message: ^8.8
- drupal/core-recommended: ^8.8
- drush/drush: ^10
- pacifica/pacifica_profiles: ^0.1
Requires (Dev)
- drupal/core-dev: ^8.8
Conflicts
This package is auto-updated.
Last update: 2024-09-05 15:06:30 UTC
README
本项目模板提供了一套入门工具包,用于使用Composer管理您的站点依赖。
如果您想了解如何将其用作Drush Make的替代方案,请访问drupal.org上的文档。
用法
首先您需要 安装composer。
注意:以下说明适用于全局composer安装。您可能需要将
composer
替换为php composer.phar
(或类似)以适应您的设置。
之后,您可以通过以下两种方式之一创建项目。
对于使用版本化代码进行网站建设
composer create-project pacifica/drupal-project:8.x-dev some-dir --no-interaction
对于开发新平台功能和保持git仓库
composer create-project pacifica/drupal-project:8.x-vcs-dev some-dir --no-interaction --keep-vcs
使用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
作为安装和更新后的命令来实现。
"scripts": { "post-install-cmd": [ "@composer drupal:scaffold", "..." ], "post-update-cmd": [ "@composer drupal:scaffold", "..." ] },
我如何将补丁应用到下载的模块中?
如果您需要应用补丁(根据要修改的项目,拉取请求通常是更好的解决方案),您可以使用composer-patches 插件。
要将补丁添加到 drupal 模块 foobar,在 composer.json 的 extra 部分插入 patches 部分
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL or local path to patch" } } }
我如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?
请遵循drupal.org上的说明。
我如何指定 PHP 版本?
此项目支持 PHP 7.0 作为最低版本(请参阅Drupal 8 PHP 要求),然而,可能的情况是 composer update
将升级某些包,这将需要 PHP 7+。
为了避免这种情况,您可以在 composer.json 的 config
部分添加以下代码来指定您想要使用的 PHP 版本
"config": { "sort-packages": true, "platform": { "php": "7.0.33" } },