cyberlex404/drupal-project

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

安装: 1

依赖者: 0

建议者: 0

安全性: 0

星级: 0

关注者: 1

分支: 941

类型:项目

8.x-dev 2017-12-13 00:07 UTC

This package is auto-updated.

Last update: 2024-09-11 06:44:24 UTC


README

Build Status

该项目模板应提供使用Composer管理您的网站依赖项的起点。

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

使用方法

首先您需要安装Composer

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

之后您可以创建项目

composer create-project cyberlex404/drupal-project:8.x-dev some-dir --stability dev --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中使用。

更新Drupal核心

该项目将尝试保持所有Drupal核心文件都最新;使用drupal-composer/drupal-scaffold项目来确保每次drupal/core更新时,您的脚手架文件都会更新。如果您自定义了任何“脚手架”文件(通常是.htaccess),那么在Drupal核心的新版本中更新了您修改的任何文件时,您可能需要解决合并冲突。

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

  1. 运行composer update drupal/core --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 可能与本项目文件不同。

常见问题解答(FAQ)

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

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

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

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

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@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 上的文档说明