html-and-cms-com/drupal-project

此软件包已被废弃,不再维护。作者建议使用 anyforsoft/drupal-project 软件包。

Drupal 8 项目的项目模板,支持 composer

安装: 55

依赖者: 0

建议者: 0

安全: 0

星星: 3

关注者: 8

分支: 630

类型:项目

8.x-dev 2017-10-23 13:21 UTC

This package is not auto-updated.

Last update: 2019-02-20 18:47:57 UTC


README

Build Status

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

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

使用方法

首先需要 安装 composer

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

之后,您可以创建项目

composer create-project anyforsoft/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 目录。
  • 为在 vendor/bin/drush 下使用,安装了最新的 drush 版本。
  • 为在 vendor/bin/drupal 下使用,安装了最新的 DrupalConsole 版本。

更新 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可能与此项目的文件不同。

常见问题解答

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

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请求通常是更好的解决方案),您可以使用composer-patches插件

要将补丁应用到名为foobar的drupal模块中,请将patches部分插入到composer.json的extra部分。

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL to patch"
        }
    }
}

我如何从packagist.drupal-composer.org切换到packages.drupal.org?

请遵循drupal.org上的文档中的说明。