dxcmalaga / drupal-project
使用composer的Drupal 8项目模板
Requires
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6
- drupal-composer/drupal-scaffold: ^2.2
- drupal/console: ^1.0.2
- drupal/core: ~8.4
- drush/drush: ~8.0|^9.0.0-beta8
- webflo/drupal-finder: ^1.0.0
- webmozart/path-util: ^2.3
Requires (Dev)
- behat/mink: ~1.7
- behat/mink-goutte-driver: ~1.2
- jcalderonzumba/gastonjs: ~1.0.2
- jcalderonzumba/mink-phantomjs-driver: ~0.3.1
- mikey179/vfsstream: ~1.2
- phpunit/phpunit: >=4.8.28 <5
- symfony/css-selector: ~2.8|~3.0
Conflicts
This package is not auto-updated.
Last update: 2024-09-22 13:10:27 UTC
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
中使用。
更新Drupal核心
此项目将尝试保持所有Drupal核心文件的最新状态;使用drupal-composer/drupal-scaffold项目确保在drupal/core更新时,您的scaffold文件也会更新。如果您自定义了任何“scaffolding”文件(通常是.htaccess),在Drupal核心的新版本中,如果您的修改文件有任何更新,您可能需要解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core --with-dependencies
以更新Drupal核心及其依赖项。 - 运行
git diff
以确定是否有任何scaffolding文件已更改。检查文件以确定任何更改,并将任何自定义设置恢复到.htaccess
或robots.txt
。 - 将所有内容合并到一个提交中,以便在检出分支或运行
git bisect
时,web
与core
保持同步。 - 如果在第2步中存在非平凡的冲突,您可能希望在分支上执行以下步骤,并使用
git merge
将更新的核心文件与您的自定义文件合并。这有助于使用 像kdiff3这样的三方合并工具。如果您所做的更改很简单,则不需要此设置;将所有修改保持在文件的开头或结尾是一个保持合并简单的良好策略。
从现有项目生成 composer.json
使用 "Composer Generate" drush 扩展,您现在可以从现有项目生成基本的 composer.json
文件。请注意,生成的 composer.json
可能与该项目文件不同。
常见问题解答(FAQ)
我应该提交我下载的贡献模块吗?
Composer 建议 不 要这样做。他们提供 反对的理由,但如果项目决定这样做,也提供了解决方案。
我应该提交脚手架文件吗?
drupal-scaffold 插件可以将脚手架文件(如 index.php、update.php 等)下载到您项目的 web/ 目录。如果您没有自定义这些文件,可以选择不将它们提交到版本控制系统(例如 git)。如果您的项目是这样,在每次安装或更新项目后自动运行 drupal-scaffold 插件可能很方便。您可以通过在 composer.json 中注册 @drupal-scaffold
作为安装后和更新后命令来实现这一点。
"scripts": { "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold", "post-install-cmd": [ "@drupal-scaffold", "..." ], "post-update-cmd": [ "@drupal-scaffold", "..." ] },
如何应用下载的模块的补丁?
如果您需要应用补丁(根据要修改的项目,pull request 通常是一个更好的解决方案),可以使用 composer-patches 插件。
要将补丁添加到 drupal 模块 foobar,请在 composer.json 的 extra 部分中插入 patches 部分。
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL to patch" } } }
如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?
请参阅 drupal.org 上的 文档说明。