happiness / drupal-project
使用composer的Happiness Drupal 8项目模板
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.6.0
- drush/drush: ^9.0.0
- vlucas/phpdotenv: ^2.4
- webflo/drupal-finder: ^1.0.0
- webmozart/path-util: ^2.3
Requires (Dev)
- webflo/drupal-core-require-dev: ^8.6.0
Conflicts
This package is auto-updated.
Last update: 2023-04-07 18:59:17 UTC
README
此项目模板提供了使用Composer管理您的网站依赖项的入门套件。
使用方法
首先,您需要安装composer。
之后,您可以创建项目
composer create-project happiness/drupal-project:8.x 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", "..." ] },
我如何应用下载的模块的补丁?
如果您需要应用补丁(根据要修改的项目,拉取请求通常是更好的解决方案),您可以使用 composer-patches 插件。
要将补丁应用到名为 foobar 的 drupal 模块中,请将补丁部分插入 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"} },