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目录。
为在vendor/bin/drush中使用，本地安装了最新的drush版本。
为在vendor/bin/drupal中使用，本地安装了最新的DrupalConsole版本。

更新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"
            ]
        }
    }
}

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

常见问题解答

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

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云之前，请将此内容添加到您的 settings.php 文件中。将 AH_SITE_GROUP 替换为您在Acquia云上的站点组名称。

<?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云环境中，否则应将Acquia连接器添加到根级别的 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'));
  }
}

caxy / drupal-project

维护者

详细信息