drupalcommerce/project-base

Commerce 2.x 项目模板

10.x-dev 2023-11-29 12:08 UTC

This package is auto-updated.

Last update: 2024-08-29 13:53:32 UTC


README

使用 Composer 来获取 Drupal + Commerce 2.x。

还可以查看 drupalcommerce/demo-project 了解带有演示内容的版本。

用法

首先您需要 安装 composer

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

之后您可以创建项目

composer create-project drupalcommerce/project-base some-dir --stability dev --no-interaction

完成!使用 composer require ... 下载额外的模块和主题

cd some-dir
composer require "drupal/devel:1.x-dev"

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

模板做什么?

  • 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 下使用。
  • 根据您的 .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 时,webcore 保持同步。
  4. 如果在第2步中存在非平凡的冲突,您可能希望在分支上执行以下步骤,并使用git merge将更新后的核心文件与您的自定义文件合并。这有助于使用像kdiff3这样的三路合并工具。如果您的更改很简单,则不需要此设置;将所有修改保持在文件的开头或结尾是一个保持合并简单的良好策略。

从现有项目生成composer.json

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

常见问题解答

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

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

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

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

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

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

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

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

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

我如何使用composer.json添加js/css库?

使用Composer安装JavaScript库是可能的,就像这个项目一样。我们之前依赖于asset-packagist来做这件事,但在仓库失效后不得不改变我们的方法。有关更多信息,请参阅这篇教程

我如何指定PHP版本?

此项目支持PHP 8.1作为最低版本(请参阅Drupal 10的环境要求),但是,可能存在一个composer update会升级某些包,然后需要PHP 8.1+的情况。

为了避免这种情况,您可以将以下代码添加到composer.json的config部分,以指定您要使用的PHP版本

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