fafabedo/tree-platform-project

Tree Platform API Drupal 8项目的模板

dev-master 2020-09-23 16:41 UTC

This package is auto-updated.

Last update: 2024-09-24 01:19:53 UTC


README

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

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

用法

首先您需要安装Composer

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

之后您可以创建项目

composer create-project fafabedo/tree-platform-project 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目录。
  • 为使用vendor/bin/drush安装最新版本的drush。
  • 为使用vendor/bin/drupal安装最新版本的DrupalConsole。
  • 根据您的.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时,web将始终与core保持同步。
  4. 如果在步骤2中存在非平凡冲突,您可能希望在这些分支上执行以下步骤,并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3之类的三方合并工具。如果您的更改很简单,此设置不是必需的;将所有修改保存在文件的开始或结束部分是一个保持合并容易的好策略。

从现有项目中生成composer.json

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

常见问题解答

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

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

我如何从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"
    }
},