README

本项目模板提供了使用Composer管理网站依赖的入门套件。

如果您想了解如何将其作为Drush Make的替代方案使用，请访问drupal.org上的文档。

使用方法

注意：以下说明针对全局Composer安装。您可能需要将composer替换为php composer.phar（或类似）以适应您的配置。

之后您可以创建项目

composer create-project singularo/shepherd-drupal-project some-dir --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.php和services.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核心的新版本发布后，合并任何修改文件的冲突。

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

运行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等三方合并工具。如果您的更改很简单，则不需要此设置；将所有修改保持在文件的开始或结尾是一个保持合并容易的好策略。

从现有项目生成 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",
        "..."
    ]
},

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

如果您需要应用补丁（根据正在修改的项目，拉取请求通常是更好的解决方案），可以使用 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 版本？

本项目支持 PHP 7.0 作为最低版本（参见 Drupal 8 PHP 要求），但是可能存在 composer update 升级某些包的情况，这需要 PHP 7+。

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

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

singularo / shepherd-drupal-project

维护者

详细信息