roblib / roblib-drupal-project
Drupal 8项目的Roblib项目模板,使用composer
Requires
- composer/installers: ^1.2
- cweagans/composer-patches: ^1.6
- drupal-composer/drupal-scaffold: ^2.2
- drupal/console: ~1.0
- drupal/core: ~8.0
- drush/drush: ~8.0
- webflo/drupal-finder: ^0.2.1
- webmozart/path-util: ^2.3
Requires (Dev)
- behat/mink: ~1.7
- behat/mink-goutte-driver: ~1.2
- jcalderonzumba/gastonjs: ~1.0.2
- jcalderonzumba/mink-phantomjs-driver: ~0.3.1
- mikey179/vfsstream: ~1.2
- phpunit/phpunit: >=4.8.28 <5
- symfony/css-selector: ~2.8
Conflicts
This package is not auto-updated.
Last update: 2024-09-27 23:52:23 UTC
README
此项目模板应提供使用Composer管理站点依赖的启动点。
使用方法
首先 安装composer。
安装composer后,您可以创建项目
composer create-project roblib/roblib-drupal-project some-dir --stability dev --no-interaction
或者创建用于生产环境的项目,要求最低稳定包,并使用 --no-dev 开关来禁用 require-dev 包的安装
composer create-project roblib/roblib-drupal-project some-dir --stability stable --no-dev --no-interaction
使用 composer require
可以下载新安装的依赖。
cd some-dir
composer require drupal/devel:~1.0
composer create-project
命令将所有文件的所有权传递给创建的项目。您应该创建一个新的git仓库,并将所有由 .gitignore 文件排除的文件提交。
模板做什么
- Drupal将被安装在
some-dir\web
目录。 - 实现了自动加载器,以使用位于
vendor/autoload.php
的生成的composer自动加载器,而不是Drupal提供的(web/vendor/autoload.php
)。 - 模块(类型为
drupal-module
的包)将放置在web/modules/contrib/
- 模块(类型为
drupal-custom-module
的包)将放置在web/modules/custom/
- 主题(类型为
drupal-theme
的包)将放置在web/themes/contrib/
- 主题(类型为
drupal-custom-theme
的包)将放置在web/themes/custom/
- 配置文件(类型为
drupal-profile
的包)将放置在web/profiles/contrib/
- 创建默认的可写版本的
settings.php
和services.yml
。 - 创建
web/sites/default/files
目录。 - 安装最新版本的drush,以便在
vendor/bin/drush
中使用。 - 安装最新版本的Drupal Console,以便在
vendor/bin/drupal
中使用。
更新Drupal核心
此项目将尝试保持所有Drupal核心文件最新;使用drupal-composer/drupal-scaffold项目确保每次更新drupal/core时,支架文件都会更新。如果您自定义了任何“支架”文件(通常是 .htaccess),则可能需要合并冲突,如果您的修改文件在Drupal核心的新版本中更新,您可能需要合并冲突。
按照以下步骤更新核心文件
- 运行
composer update drupal/core --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
可能与此项目的文件不同。
常见问题解答(FAQ)
我应该提交我下载的贡献模块吗?
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 部分
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL to patch" } } }
我如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?
请遵循 drupal.org 上的 文档中的说明。