krystalcode/drupal8-krystal-project

为使用Composer的Drupal 8项目提供的Krystal项目模板

8.x-dev 2020-09-27 04:42 UTC

This package is auto-updated.

Last update: 2024-09-27 13:35:33 UTC


README

Build Status

此项目模板提供了一个起始套件,用于使用Composer管理您的站点依赖项。

如果您想了解如何将其用作Drush Make的替代品,请访问drupal.org上的文档

用法

首先您需要安装Composer

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

之后您就可以创建项目了

composer create-project drupal-composer/drupal-project:8.x-dev some-dir --no-interaction

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

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

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

模板做了什么?

在安装给定的composer.json时,会处理一些任务

  • Drupal将被安装在web目录。
  • 实现了Autoloader,使用vendor/autoload.php中生成的Composer Autoloader,而不是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 Core

此项目将尝试保持您的所有Drupal Core文件是最新的;使用项目drupal/core-composer-scaffold确保每次drupal/core更新时,您的scaffold文件都会更新。如果您自定义了任何“scaffolding”文件(通常是.htaccess),则当您的修改文件在新版本的Drupal core中更新时,可能需要解决合并冲突。

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

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

从现有项目生成 composer.json

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

常见问题解答(FAQ)

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

Composer 推荐 提交。他们提供了反对的理由,同时也提供了如果项目决定这样做的话的解决方案。

我应该提交脚手架文件吗?

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

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

我如何应用下载的模块的补丁?

如果您需要应用补丁(根据要修改的项目,pull request 常常是更好的解决方案),您可以使用composer-patches 插件。

要将补丁应用到名为 foobar 的 Drupal 模块中,请将补丁部分插入到 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.json 的 config 部分中,以指定您想要使用的 PHP 版本:

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