keytec / drupal-base
为KEY TEC drupal项目使用composer的项目模板
Requires
- burdamagazinorg/thunder: ~8.2
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6
- drupal-composer/drupal-scaffold: ^2.2
- drupal/console: ^1.2
- drush/drush: ~8.0|^9.0.0-beta8
- oomphinc/composer-installers-extender: ^1.1
- webflo/drupal-finder: ^1.0.0
- webmozart/path-util: ^2.3
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-13 01:23:01 UTC
README
该项目模板应该能够帮助您使用Composer管理网站依赖。
如果您想了解如何将其用作Drush Make的替代方案,请访问drupal.org上的文档。
使用方法
注意:以下说明针对全局Composer安装。您可能需要将
composer替换为php composer.phar(或类似)以适应您的设置。
之后,您可以创建项目
composer create-project burdamagazinorg/thunder-project thunder
使用composer require ...,您可以下载新的依赖到您的安装中。
cd thunder
composer require drupal/devel:1.*
composer create-project命令将所有文件的所有权传递给创建的项目。您应该创建一个新的git仓库,并提交所有由.gitignore文件排除的文件。
模板做什么?
当安装指定的composer.json时,一些任务会得到处理
- Drupal将被安装在
docroot目录中。 - 实现了自动加载器,使用
vendor/autoload.php中生成的composer自动加载器,而不是Drupal提供的自动加载器(docroot/vendor/autoload.php)。 - 模块(类型为
drupal-module的包)将被放置在docroot/modules/contrib/ - 主题(类型为
drupal-theme的包)将被放置在docroot/themes/contrib/ - 配置文件(类型为
drupal-profile的包)将被放置在docroot/profiles/contrib/ - 下载Drupal脚手架文件,如
index.php或.htaccess - 创建
sites/default/files目录。 - 在
bin/drush处安装最新的drush版本。 - 在
bin/drupal处安装最新的DrupalConsole版本。
安装Thunder
创建项目将安装Thunder到docroot目录中。您现在可以像任何Drupal 8站点一样安装Thunder。请参阅:Drupal安装指南。
更新Thunder
要更新Thunder、Drupal或任何模块到最新版本,请执行composer update。此命令将检查每个依赖项的新版本,下载它并相应地更新composer.lock。之后,您可以在docroot文件夹中运行drush updb来更新您的网站数据库。
文件更新
此项目将尝试保持Thunder和Drupal核心文件的最新状态;项目drupal-composer/drupal-scaffold用于确保在drupal/core更新时,您的脚手架文件也会更新。如果您自定义了任何“脚手架”文件(通常是.htaccess),则可能在Drupal核心的新版本中更新了您的修改文件时需要合并冲突。
按照以下步骤更新您的Thunder文件。
- 运行
composer update burdamagazinorg/thunder - 运行
git diff以确定是否有任何脚手架文件已更改。检查文件以查找任何更改,并恢复对.htaccess或robots.txt的任何自定义设置。 - 将所有内容一起提交为一个单一提交,这样在检出分支或运行
git bisect时,web将与core保持同步。 - 如果在第 2 步中出现非平凡冲突,您可能需要在分支上执行以下步骤,并使用
git merge将更新的核心文件与您的自定义文件合并。这有助于使用 像 kdiff3 这样的三路合并工具。如果您的更改很简单,则不需要这种设置;在文件的开始或末尾保留所有修改是一种保持合并简单的良好策略。
常见问题解答
我应该提交我下载的贡献模块吗?
Composer 建议不要提交。他们提供了 反对的论据,但也提供了一些替代方案,即使项目决定这样做也是如此。
我如何应用下载模块的补丁?
如果您需要应用补丁(根据要修改的项目,pull request 通常是一个更好的解决方案),您可以使用 composer-patches 插件。
要将补丁添加到 Drupal 模块 foobar,请在 composer.json 的 extra 部分中插入 patches 部分。
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL or local path to patch" } } }
我应该提交脚手架文件吗?
drupal-scaffold 插件可以将脚手架文件(如 index.php、update.php 等)下载到您的项目的 web/ 目录。如果您没有自定义这些文件,您可以选择不将它们提交到您的版本控制系统(例如 git)。如果您的项目是这样的情况,在每次安装或更新您的项目后自动运行 drupal-scaffold 插件可能会很方便。您可以通过在 composer.json 中将 @drupal-scaffold 注册为 post-install 和 post-update 命令来实现这一点。
"scripts": { "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold", "post-install-cmd": [ "@drupal-scaffold", "..." ], "post-update-cmd": [ "@drupal-scaffold", "..." ] },
我如何防止下载我不需要的来自 Thunder 的模块?
要防止下载 Thunder 提供但您不需要的模块,请向您的 composer.json 中添加一个 replace 块。
"replace": { "drupal/features": "*" }
此示例阻止了任何版本的 feature 模块被下载。