devshop/composer-template

为Drupal 8项目提供的Composer模板,可在Aegir & DevShop上运行

8.x-dev 2023-04-27 21:52 UTC

This package is auto-updated.

Last update: 2024-08-29 22:39:27 UTC


README

此项目模板为使用Composer管理网站依赖提供了一个启动套件,针对Aegir或DevShop进行了优化。

它基于 drupal-composer/drupal-project

使用方法

首先您需要 安装Composer

注意:以下说明参考的是 全局Composer安装。您可能需要根据您的配置将composer替换为php composer.phar(或类似)。

之后您可以创建项目

composer create-project devshop/composer-template:8.x-dev --no-interaction mynewproject

使用 composer require ... 您可以下载新的依赖到您的安装中。

cd some-dir
composer require drupal/devel:~1.0

composer create-project 命令将所有文件的所有权传递给创建的项目。您应该创建一个新的git仓库,并提交所有未被 .gitignore 文件排除的文件。

此模板做了什么?

  • 添加了一个 composer drupal:upgrade 命令作为 composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies 的别名
  • 降级到drush 8。(非常抱歉。我保证很快解决。)
  • 将aegir文件添加到 .gitignore。
  • 将config.platform.php设置为5.5以实现最佳兼容性。
  • 添加一个包含Drupal Behat测试的 /tests 文件夹。 (待办事项)
  • 使用 drupal-scaffold 插件将模板文件(如index.php,update.php等)下载到项目的web/目录。有关更多信息,请参阅下文标题为“是否应该提交模板文件?”的部分。

父项目(drupal-composer/drupal-project)做了什么?

安装指定的 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.phpservices.yml 的默认可写版本。
  • 创建 web/sites/default/files 目录。
  • 在本地安装最新版本的drush,以便在 vendor/bin/drush 中使用。
  • 在本地安装最新版本的DrupalConsole,以便在 vendor/bin/drupal 中使用。
  • 根据您的 .env 文件创建环境变量。请参阅 .env.example

更新Drupal核心

本项目将尝试保持您所有Drupal核心文件的最新状态;使用drupal/core-composer-scaffold项目以确保在更新drupal/core时,您的框架文件也会更新。如果您自定义了任何“框架”文件(通常是 .htaccess),那么在Drupal核心的新版本中更新您修改的文件时,您可能需要合并冲突。

按照以下步骤更新您的核心文件。

  1. 运行composer update drupal/core drupal/core-dev --with-dependencies以更新Drupal核心及其依赖项。
  2. 运行git diff以确定是否有框架文件已更改。检查文件中的更改,并将任何对.htaccessrobots.txt的自定义设置恢复。
  3. 将所有内容合并到一个提交中,这样在检出分支或运行git bisect时,web将与core保持同步。
  4. 如果第二步中有非平凡的冲突,您可能希望在分支上执行以下步骤,并使用git merge将更新的核心文件与您的自定义文件合并。这便于使用kdiff3等三路合并工具。如果您的更改很简单,则不需要此设置;保持所有更改在文件的开始或结尾是一个保持合并简单的良好策略。

从现有项目生成composer.json

使用"Composer Generate" drush扩展,您现在可以从现有项目生成基本的composer.json文件。请注意,生成的composer.json可能与本项目文件不同。

常见问题解答(FAQ)

我应该提交我下载的贡献模块吗?

Composer建议不要提交。他们提供了反对的理由,但如果项目决定这样做,也提供了解决方案

我应该提交框架文件吗?

Drupal Composer Scaffold插件可以将框架文件(如index.php、update.php等)下载到项目的web/目录。如果您没有自定义这些文件,可以选择不将其提交到您的版本控制系统(例如git)。如果您的项目是这样,自动在项目的安装或更新后运行drupal-scaffold插件可能很方便。您可以通过在composer.json中将@composer drupal:scaffold注册为post-install和post-update命令来实现这一点。

"@composer 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上的说明

如何指定PHP版本?

本项目支持PHP 7.0作为最低版本(见Drupal 8 PHP需求),但是,在运行composer update时,可能需要升级某些包,这可能导致需要PHP 7+。

为了防止这种情况,您可以将以下代码添加到composer.jsonconfig部分中,以指定您要使用的PHP版本:

"config": {
    "sort-packages": true,
    "platform": {
        "php": "7.0.33"
    }
},

支持

本项目由ThinkDrop Inc和DevShop.Support服务支持。更多信息请参见https://devshop.support