goodnovember/drupal-project

Victor的项目模板,用于Drupal 8项目,支持Composer

安装: 2

依赖: 0

建议者: 0

安全性: 0

星级: 0

关注者: 1

分支: 941

类型:项目

8.x-dev 2019-09-16 18:11 UTC

This package is auto-updated.

Last update: 2024-09-17 05:29:44 UTC


README

Build Status

此项目模板为使用Composer管理网站依赖提供了一个入门工具包。

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

使用方法

首先您需要安装Composer

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

之后您可以创建项目

composer create-project GoodNovember/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核心的新版本中,如果有任何修改的文件被更新,您可能需要解决合并冲突。

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

  1. 运行composer update drupal/core webflo/drupal-core-require-dev "symfony/*" --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-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",
        "..."
    ]
},

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

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

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

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