Composerize Drupal 使用指南
1. 项目目录结构及介绍
Composerize Drupal 是一个用于将非 Composer 管理的 Drupal 应用程序转换为 Composer 管理的应用的 Composer 插件。下面是项目的基本结构概述:
-
root 目录: 这里存放着项目的核心文件,包括但不限于
composer.json
,gitignore
, 和其他配置文件。composer.json
: 插件本身的元数据定义文件,同时也是你之后应用转化过程中生成的基础模板。composer.lock
: 此文件在项目安装依赖时自动生成,记录已安装依赖的确切版本信息(新项目转换时不会立即出现)。README.md
: 提供了快速入门和主要功能说明的文档。LICENSE.txt
: 许可证文件,说明项目使用的开放源代码许可类型。editorconfig
: 和.gitignore
类似,指导编辑器如何处理代码风格。
-
src: 存放插件的主要代码逻辑。
-
tests: 包含了确保插件正常工作的测试案例。
-
.gitignore, .editorconfig: 配置忽略文件和编辑器设置。
-
travis.yml: 用于持续集成的 Travis CI 配置文件。
-
phpunit.xml.dist: PHPUnit 测试框架的配置文件。
转换后的Drupal项目结构示例: 在执行转换后,你的 Drupal 项目中可能会增加或调整以下部分:
- 在项目根目录下生成新的
composer.json
文件,它基于提供的模板并自动填充依赖项。 - 可能会创建一个
patches
目录,用来集中管理补丁文件。 - 根据需要,
.gitignore
可能会被更新以适应Composer管理方式。
2. 项目的启动文件介绍
此项目本身不需要直接启动文件,其主要通过命令行工具在 Drupal 应用上操作。启动转换过程实际上是从运行以下命令开始的,通常是进入你的 Drupal 项目目录后执行:
cd path/to/your/drupal/project
composer composerize-drupal --composer-root=path/to/project/root --drupal-root=path/to/drupal/root
这里的“启动”实质上是指执行composerize-drupal
命令,这一步骤不涉及传统意义上的应用启动文件,而是触发 Drupal 从非 Composer 管理到 Composer 管理状态的转换过程。
3. 项目的配置文件介绍
主要配置文件:composer.json
- 转换前: 如果你的 Drupal 项目原本没有使用 Composer,那么不会有现成的
composer.json
。 - 转换后: 该文件自动生成,包含了 Drupal 的核心依赖(如
drupal/core-recommended
),以及从原 Drupal 安装中贡献模块、主题等路径自动发现的依赖。此外,还会配置特定于 Composer 的插件和推荐的设置。
其他重要配置文件
- template composer.json: 这是一个模板文件,用于生成最终的
composer.json
,你不直接修改这个文件,除非你想定制转换流程的起点。 - Git Ignore (
gitignore
): 转换过程可能会影响到.gitignore
文件,添加或删除某些条目以符合 Composer 管理的标准实践。 - Patches配置: 转换过程中自动创建或修改的与补丁相关的配置,通常涉及到将发现的补丁移动到指定目录并记录其路径。
通过以上步骤和解释,您可以理解并开始使用 Composerize Drupal 来管理和转换您的 Drupal 项目。记得在转换后执行 composer update
来获取所有依赖并生成必要的锁定文件。