krystalcode/drupal-krystal-project

为Drupal 9项目提供的krystal项目模板,支持Composer

9.x-dev 2021-12-17 16:40 UTC

This package is auto-updated.

Last update: 2024-09-17 22:17:20 UTC


README

Build Status

此项目模板提供了一套初始工具包,用于使用Composer管理您的站点依赖。

用法

首先您需要安装Composer

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

之后,您可以创建项目

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

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

cd some-dir
composer require drupal/devel

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.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-recommended drupal/core-dev --with-dependencies以更新Drupal核心及其依赖项。
  2. 运行git diff以确定是否有任何模板文件已更改。审查文件以查找任何更改,并将对.htaccessrobots.txt的任何自定义更改恢复。
  3. 将所有内容作为一个单独的提交提交,这样在检出分支或运行git bisect时,web将保持与core同步。
  4. 如果在第2步中存在非平凡冲突,您可能希望在分支上执行以下步骤,并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3这样的三路合并工具。如果您的更改很简单,则不需要此设置;将所有修改保持在文件的开始或结束部分是使合并变得容易的好策略。

常见问题解答(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",
        "..."
    ]
},

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

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

要将补丁添加到 drupal 模块 foobar,请将补丁部分插入 composer.json 的 extra 部分。

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL or local path to patch"
        }
    }
}

如何指定 PHP 版本?

此项目支持 PHP 7.3 作为最低版本(参见Drupal 9 的环境要求),然而,可能存在 composer update 升级某些包,然后需要 PHP 7.3+ 的情况。

为了防止这种情况,您可以在 composer.json 的 config 部分添加以下代码来指定您想要使用的 PHP 版本。

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