scnx/drupal-project

用于Drupal 8项目的Composer项目模板

安装: 6

依赖者: 0

建议者: 0

安全: 0

星级: 0

关注者: 0

分支: 941

类型:项目

8.x-dev 2019-06-28 08:22 UTC

This package is auto-updated.

Last update: 2024-09-28 20:25:29 UTC


README

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

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

此包基于drupal-composer/drupal-project,以下为变更和添加的内容

  • webflo/drupal-core-strict用于修复Drupal核心依赖的确切版本
  • 除了/custom/外,还有/contrib/文件夹用于主题、模块和配置文件

使用方法

首先您需要安装Composer

注意:以下说明适用于全局Composer安装。您可能需要将composer替换为php composer.phar(或类似)以适应您的配置。

之后,您就可以创建项目了

composer create-project scnx/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目录中。
  • 实现了自动加载器,以使用在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-composer/drupal-scaffold确保每次drupal/core更新时,您的支架文件都得到更新。如果您自定义了任何“支架”文件(通常是.htaccess),则在Drupal核心的新版本中更新了您修改的文件时,您可能需要解决冲突。

此项目包含一个固定的Drupal版本,您必须自己将其升级或使其更加宽松,如果您不想锁定确切的Drupal版本。要缓解固定版本要求,可以运行composer require webflo/drupal-core-strict:^8.7

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

  1. 设置您想要安装的Drupal版本,如果它是固定的,例如composer require webflo/drupal-core-strict:8.7.3。如果您不使用固定版本,可以跳过此步骤。
  2. 运行 composer update webflo/drupal-core-strict webflo/drupal-core-require-dev composer/installers "symfony/*" --with-dependencies 以更新 Drupal 核心和其依赖。
  3. 运行 git diff 以确定是否有任何脚手架文件已更改。检查文件中的任何更改,并将对 .htaccessrobots.txt 的自定义设置恢复。
  4. 将所有内容合并到单个提交中,以便在检出分支或运行 git bisect 时,webcore 保持同步。
  5. 如果在步骤 2 中存在非平凡冲突,您可能希望在这些步骤上创建一个分支,并使用 git merge 将更新的核心文件与您的自定义文件合并。这便于使用如 kdiff3 这样的三向合并工具。如果您的更改很简单,则没有必要进行这种设置;将所有修改保持在文件的开头或结尾是一个保持合并容易的好策略。

从现有项目生成 composer.json

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

常见问题解答 (FAQ)

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

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

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

drupal-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 部分中插入 patches 部分

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

如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?

请遵循 drupal.org 上的文档 中的说明。

如何指定 PHP 版本?

该项目支持 PHP 5.6 作为最低版本(请参阅 Drupal 8 PHP 要求),但是,可能存在 composer update 会升级某些包,从而需要 PHP 7+ 的情况。

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

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