stratoserp/stratos-drupal-project

StratosERP的项目模板

0.2.4 2021-05-17 10:36 UTC

This package is auto-updated.

Last update: 2024-09-29 06:08:54 UTC


README

基于Drupal项目的composer模板 - https://github.com/drupal-composer/drupal-project

该项目模板为使用Composer管理站点依赖提供了一个启动套件。

用法

首先您需要安装Composer

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

之后您就可以创建项目

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

或为开发环境

composer create-project stratoserp/stratos-drupal-project:9.x-dev some-dir --prefer-source --keep-vcs

本文件的其余部分来自上面链接的drupal主项目仓库。

使用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时,您的scaffold文件都会更新。如果您自定义了任何“scaffold”文件(通常是.htaccess),那么在Drupal核心的新版本中更新您的修改文件时,可能需要解决冲突。

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

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

常见问题解答

我应该提交我下载的 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 插件。

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

"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"
    }
},