anyforsoft/drupal-project

用于 Drupal 8 项目的 composer 项目模板

维护者

详细信息

github.com/anyforsoft/drupal-project

安装: 149

依赖者: 0

建议者: 0

安全: 0

星标: 3

关注者: 9

分支: 941

类型:项目

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

This package is not auto-updated.

Last update: 2024-09-14 19:20:11 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 目录。
  • 本地安装最新版本的 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可能与本项目文件不同。

常见问题解答

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

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

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

请按照drupal.org 上的说明操作。