agiledrop / tdx-project
TDX项目模板
Requires
- agiledrop/tdx-distribution: 0.2.2
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6
- drupal-composer/drupal-scaffold: ^2.2
- drupal/console: ^1.0.2
- drupal/core: ~8.5
- drush/drush: ^9.0.0
- org/cotailored_base_drush_commands: dev-master
- 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
This package is not auto-updated.
Last update: 2024-09-19 11:36:41 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更新时,您的支架文件都得到更新。如果您自定义了任何“支架”文件(通常为.htaccess),您可能需要在Drupal核心的新版本中更新您的修改文件时解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core --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
可能与本项目文件不同。
常见问题解答(FAQ)
我应该提交我下载的贡献模块吗?
Composer建议不要这样做。他们提供反对的论据,但如果项目决定这样做,也提供了解决方案。
我应该提交脚手架文件吗?
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", "..." ] },
如何将补丁应用于下载的模块?
如果您需要应用补丁(根据要修改的项目,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上的说明。