realestatepointe/d8-composer

此包的最新版本(dev-master)没有可用的许可证信息。

标准Drupal 8 Composer安装

dev-master 2019-02-03 01:47 UTC

This package is auto-updated.

Last update: 2024-09-29 05:28:08 UTC


README

此项目模板提供了一个启动工具,用于使用Composer管理您的站点依赖项。

用法

首先您需要 安装composer

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

之后您可以创建项目

composer create-project drupal-composer/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中使用。
  • 根据您的.env文件创建环境变量。请参阅.env.example

更新Drupal核心

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

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

  1. 运行composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies来更新Drupal核心及其依赖项。
  2. 运行git diff以确定是否有任何模板文件已更改。审查文件以查看任何更改,并将任何自定义设置恢复到.htaccessrobots.txt
  3. 一次性提交所有内容,以便在检出分支或运行git bisect时,webcore保持同步。
  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中将@composer drupal:scaffold注册为post-install和post-update命令来实现。

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer 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上的文档中的说明操作。

我如何指定PHP版本?

目前,Drupal 8支持PHP 5.5.9作为最低版本(请参阅Drupal 8 PHP要求),然而,执行composer update可能会升级某些包,从而需要PHP 7+。

为了防止这种情况,您可以在composer.json的config部分添加以下代码来指定您想要使用的PHP版本。

"config": {
    "sort-packages": true,
    "platform": {"php": "5.5.9"}
},