hhabbous / socle-drupal
适用于使用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.5.1
- drush/drush: ^9.0.0
- hhabbous/dlone: dev-master
- vlucas/phpdotenv: ^2.4
- webflo/drupal-finder: ^1.0.0
- webmozart/path-util: ^2.3
Requires (Dev)
- webflo/drupal-core-require-dev: ~8.5.1
Conflicts
This package is not auto-updated.
Last update: 2024-09-21 00:19:23 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
目录。 - 为在
vendor/bin/drush
中使用,安装了最新的drush本地版本。 - 为在
vendor/bin/drupal
中使用,安装了最新的DrupalConsole本地版本。 - 基于您的.env文件创建环境变量。请参阅.env.example。
更新Drupal核心
此项目将尝试保持您的所有Drupal核心文件最新;项目drupal-composer/drupal-scaffold用于确保每次drupal/core更新时,您的scaffold文件都得到更新。如果您自定义了任何“scaffolding”文件(通常是.htaccess),则可能需要在发布中更新您的自定义文件时解决任何合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core webflo/drupal-core-require-dev symfony/* --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
可能与该项目的文件不同。
常见问题解答
我应该提交我下载的贡献模块吗?
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", "..." ] },
我如何应用下载的模块的补丁?
如果您需要应用补丁(根据修改的项目,拉取请求通常是更好的解决方案),您可以使用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版本?
目前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"} },