README

1.1 在使用 composer 模板创建项目后，在本地安装项目。

克隆仓库
运行 composer install
配置本地设置文件
- web/sites/default/settings.local.php
- robo.yml
- drush/sites/self.site.yml
使用以下两种方法之一安装数据库
1. 运行 ./install.sh 脚本，它将从 robo.yml 文件中指定的 URL 克隆数据库
2. 运行 ./vendor/bin/drush site:install --existing-config，它将使用 config/sync 目录中找到的配置文件安装数据库

1.2 首次创建项目

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

之后，你可以创建项目

composer create-project eaudeweb/drupal-project:8.x-dev some-dir --no-interaction

使用 composer require ... 可以下载新的依赖到你的安装中。

cd some-dir
composer require drupal/devel:~1.0

composer create-project 命令将所有文件的所有权传递给创建的项目。你应该创建一个新的 git 仓库，并提交所有由 .gitignore 文件排除的文件。

2. 模板做什么？

在安装给定的 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.php 和 services.yml 的默认可写版本。
创建 web/sites/default/files 目录。
在本地安装最新版本的 drush，用于在 vendor/bin/drush 下使用。
在本地安装最新版本的 DrupalConsole，用于在 vendor/bin/drupal 下使用。
根据你的 .env 文件创建环境变量。参见 .env.example。

3. 更新 Drupal 核心版本

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

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

运行 composer update drupal/core webflo/drupal-core-require-dev "symfony/*" --with-dependencies 来更新 Drupal 核心和其依赖项。
运行 git diff 以确定是否有任何脚手架文件已更改。检查文件以确定任何更改，并将任何自定义设置恢复到 .htaccess 或 robots.txt。
将所有内容作为一个单一提交提交，这样在检出分支或运行 git bisect 时，web 将与 core 保持同步。
如果在第2步中存在非平凡的冲突，您可能希望在分支上执行以下步骤，并使用git merge将更新后的核心文件与您的自定义文件合并。这有助于使用kdiff3等三路合并工具。如果您的更改很简单，则不需要此设置；将所有修改保持在文件的开头或结尾是一个保持合并简单的良好策略。

4. 从现有项目生成composer.json

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

5. 常见问题解答

5.1 我是否应该提交我下载的contrib模块？

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

5.2 我是否应该提交脚手架文件？

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",
        "..."
    ]
},

5.3 如何应用下载的模块的补丁？

如果您需要应用补丁（根据要修改的项目，pull request通常是更好的解决方案），可以使用composer-patches插件。

要将补丁添加到drupal模块foobar，在composer.json的extra部分插入patches部分

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

5.4 如何从packagist.drupal-composer.org切换到packages.drupal.org？

请参阅drupal.org上的文档。

5.5 如何指定PHP版本？

此项目支持PHP 7.0作为最低版本（参见Drupal 8 PHP需求），然而，执行composer update可能会升级某些包，从而需要PHP 7+。

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

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

eaudeweb / drupal-project

维护者

详情