drugan / project-base
Commerce 2.x 项目模板
Requires
- php: >=7.3
- ext-curl: *
- composer/installers: ^1.9
- cweagans/composer-patches: ^1.7
- drugan/commerce_base: 9.x-dev
- drupal/commerce: ^2.24
- drupal/core: ^9.1
- drupal/core-composer-scaffold: ^9.1
- drupal/devel: ^4.1
- drupal/jsonapi_menu_items: ^1.2
- drupal/next: ^1.1
- drupal/search_api: ^1.19
- drupal/symfony_mailer: ^1.0@alpha
- drupal/tmpin: ^2.0
- drupal/token: ^1.9
- drush/drush: ^10.3
- vlucas/phpdotenv: ^5.1
- webflo/drupal-finder: ^1.2
- webmozart/path-util: ^2.3
Requires (Dev)
Conflicts
README
使用 Composer 获取 Drupal + Commerce 2.x。
还可以查看 drupalcommerce/demo-project 以获取带有演示内容的版本。
使用方法
首先您需要 安装 composer。
注意:以下说明针对 全局 composer 安装。您可能需要根据您的设置将
composer替换为php composer.phar(或类似)。
之后您可以使用 packagist.org 创建项目
composer create-project drugan/project-base some-dir --stability dev --no-interaction
或者,使用 项目的包
composer create-project --repository=https://raw.githubusercontent.com/drugan/project-base/9.x/packages.json drugan/project-base some-dir --stability dev
完成!使用 composer require ... 下载额外的模块和主题
cd some-dir
composer require "drupal/devel:1.x-dev"
composer create-project 命令将所有文件的所有权传递给创建的项目。您应该创建一个新的 git 仓库,并将所有 .gitignore 文件中未排除的文件提交。
模板做什么?
- Drupal 安装在
web目录中。 - 模块(类型为
drupal-module的包)放置在web/modules/contrib/ - 主题(类型为
drupal-theme的包)放置在web/themes/contrib/ - 配置文件(类型为
drupal-profile的包)放置在web/profiles/contrib/ - 创建
settings.php和services.yml的默认可写版本。 - 创建
web/sites/default/files目录。 - 将 DrupalConsole 的最新版本安装在本地,以便在
bin/drupal下使用。
更新 Drupal 核心版本
此项目将尝试保持您的所有 Drupal 核心文件的最新状态;项目 drupal/core-composer-scaffold 用于确保在更新 drupal/core 时您的框架文件也会更新。如果您自定义了任何“框架”文件(通常是 .htaccess),则可能需要在 Drupal 核心的新版本中更新您的修改文件时解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core drupal/core-dev --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 Composer Scaffold 插件可以将脚手架文件(如index.php、update.php等)下载到项目的web/目录。如果您没有自定义这些文件,可以选择不将它们提交到版本控制系统(例如git)。如果您的项目是这样,在每次安装或更新项目后自动运行drupal-scaffold插件可能更方便。您可以通过在composer.json中将@composer drupal:scaffold注册为安装后和更新后命令来实现。
"scripts": { "post-install-cmd": [ "@composer drupal:scaffold", "..." ], "post-update-cmd": [ "@composer drupal:scaffold", "..." ] },
我如何应用下载的模块的补丁?
如果您需要应用补丁(根据正在修改的项目,pull request通常是更好的解决方案),可以使用composer-patches 插件。
要将补丁添加到drupal模块foobar,请将patches部分插入composer.json的extra部分。
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL to patch" } } }
我如何使用composer.json添加js/css库?
像这个项目一样,使用Composer通过自定义包安装JavaScript库是可能的。我们之前依赖于asset-packagist来完成此操作,但在仓库失效后不得不改变我们的方法。有关更多信息,请参阅本教程。
我如何指定PHP版本?
本项目支持PHP 7.1作为最低版本(参见Drupal 8 PHP要求),然而,运行composer update可能会升级某些包,从而需要PHP 7.1+。
为了防止这种情况,您可以在composer.json的config部分添加以下代码,以指定您想要使用的PHP版本:
"config": { "sort-packages": true, "platform": { "php": "7.1.21" } },