README

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

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

使用方法

注意：以下说明适用于全局 composer 安装。您可能需要根据您的设置将 composer 替换为 php composer.phar（或类似）。

之后，您可以创建项目

composer create-project caxy/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 将安装在 docroot 目录。
实现了自动加载器，使用 vendor/autoload.php 中生成的 composer 自动加载器，而不是 Drupal 提供的自动加载器（docroot/vendor/autoload.php）。
模块（类型为 drupal-module 的包）将放置在 docroot/modules/contrib/
主题（类型为 drupal-theme 的包）将放置在 docroot/themes/contrib/
配置文件（类型为 drupal-profile 的包）将放置在 docroot/profiles/contrib/
创建 settings.php 和 services.yml 的默认可写版本。
创建 sites/default/files 目录。
在本地安装最新的 drush 版本，以在 vendor/bin/drush 下使用。
在本地安装最新的 DrupalConsole 版本，以在 vendor/bin/drupal 下使用。

更新 Drupal 核心文件

该项目将尝试保持所有 Drupal 核心文件的最新状态；使用 drupal-composer/drupal-scaffold 项目确保每次 drupal/core 更新时，您的模板文件都得到更新。如果您自定义了任何“模板”文件（通常为 .htaccess），则可能需要在 Drupal 核心新版本中更新您修改的文件时解决合并冲突。

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

运行 composer update drupal/core --with-dependencies 以更新 Drupal 核心和其依赖项。
运行 git diff 以确定是否有模板文件已更改。检查文件中的任何更改，并将任何自定义更改恢复到 .htaccess 或 robots.txt。
将所有内容作为一个单独的提交提交，这样在检查分支或运行 git bisect 时，docroot 将与 core 保持同步。
如果在第2步中出现非平凡冲突，您可能希望在一个分支上执行这些步骤，并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3等三路合并工具。如果您的更改很简单，则不需要此设置；将所有修改保持在该文件的开始或结束处是一种使合并变得容易的好策略。

从现有项目生成composer.json

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

创建站点配置文件

我们建议所有项目都作为Drupal 8配置文件创建，并在配置文件中使用Composer来管理Drupal依赖。

mkdir docroot/profiles/specialproject

在配置文件的目录中创建一个composer.json文件，例如

{
    "name": "my-company/special-project-profile",
    "type": "drupal-profile",
    "repositories": [
        {
            "type": "composer",
            "url": "https://packagist.drupal-composer.org"
        }
    ],
    "require": {
        "drupal/metatag": "~8.0@dev"
    }
}

将其添加到您的根级别的composer.json

{
    "require": {
        "wikimedia/composer-merge-plugin": "^1.3.0"
    },
    "extra": {
        "merge-plugin": {
            "include": [
                "docroot/profiles/specialproject/composer.json"
            ]
        }
    }
}

这将允许您为您的配置文件维护一个独立的composer.json文件，同时保持从根级别运行composer update以同时更新Drupal平台和配置文件的依赖项的简单性。

常见问题解答

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

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

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

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

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

如何在Acquia云上使用这个插件？

在部署到Acquia Cloud之前，将其添加到您的settings.php中。用Acquia Cloud中您的站点组名称替换AH_SITE_GROUP。

<?php

// On Acquia Cloud, this include file configures Drupal to use the correct
// database in each site environment (Dev, Stage, or Prod). To use this
// settings.php for development on your local workstation, set $db_url
// (Drupal 5 or 6) or $databases (Drupal 7 or 8) as described in comments above.
if (file_exists('/var/www/site-php')) {

  // As of 29 October 2015, Acquia Cloud does not support release candidates of Drupal 8,
  // so we must define `conf_path` function which was removed between beta15 and RC1.
  if (!function_exists('conf_path')) {
    function conf_path() {
      $request = \Symfony\Component\HttpFoundation\Request::createFromGlobals();
      return \Drupal\Core\DrupalKernel::findSitePath($request, FALSE);
    }
  }
  require('/var/www/site-php/AH_SITE_GROUP/AH_SITE_GROUP-settings.inc');
}

除非您的站点配置文件只能运行在Acquia Cloud环境中，否则应将Acquia Connector添加到根级别的composer.json。

{
    "require": {
        "drupal/acquia_connector": "8.1.*@dev"
    }
}

我需要Composer Manager吗？

您永远不需要这个模块，并且它可能无法正确工作，因为没有在文档根目录中包含composer.json文件。贡献模块明确声明此依赖项是不正确的，因为运行具有composer PHP依赖项的模块的方式不止一种。

在模块或您的项目配置文件中添加此钩子实现

<?php

/**
 * Implements hook_system_info_alter().
 */
function MODULE_system_info_alter(array &$info, \Drupal\Core\Extension\Extension $file, $type) {
  // remove composer_manager dependency.
  if (isset($info['dependencies']) && !empty($info['dependencies'])) {
    $info['dependencies'] = array_diff($info['dependencies'], array('composer_manager'));
  }
}

jddoesdev / drupal-project

维护者

详细信息