README

从 SuiteCRM 目录中收集文件到开发模块中，并创建一个可安装的模块。

这个库添加了一个 composer 环境，该环境读取 manifest.php 文件并从 SuiteCRM 目录中收集所有这些文件。主要思想是允许在 SuiteCRM 目录中直接开发，并在过程结束时复制所有更改。

先决条件

您需要一个 CRM 目录和一个 模块 目录。该 模块 必须有 manifest.php 文件。

同时，您的系统需要安装 composer。

安装库

如果您的 模块 没有包含 composer.json，请使用以下数据创建它

{
	"name": "workspace/module_name",
	"version": "1.1.1"
}

现在运行以下命令

composer install --dev baxtian/suitecrm-dev

将 scripts 和 archive 元素添加到 composer.json 文件中。

{
	.
	.
	.
	"scripts": {
		"version": "SuitecrmEnv\\App::increment",
		"harvest": "SuitecrmEnv\\App::harvest",
		"dist": "composer archive --format=zip",
		"release": [
			"@version",
			"@dist"
		]
	},
	"archive": {
		"exclude": [
			"/.vscode/",
			"/.env",
			"/.env.example",
			"/vendor/",
			".gitignore",
			"composer.*",
			"README.md",
			"*.zip"
		]
	}
	.
	.
	.
}

最后，添加或更新 .env 文件以包含您的 CRM 目录的路径。

SUITECRM_PATH=/path/to/your/crm

如何使用它？

• 直接在 CRM 中修改文件。
• 如果您创建了模块并在 Studio 中进行了修改，请记得将 custom/Extension/modules/your_module/Ext/metadata 中的文件复制到 modules/your_module/metadata 中。
• 如果您在模块内部添加了新文件，清单将复制整个目录，并询问您是否要复制新文件。
• 如果您在模块外部添加了新文件，您必须在 manifest.php 中添加定义，以便允许 suitecrm-env 复制新文件。请参阅有关 manifest 的文档。

更改准备好后，运行此命令

composer harvest

这将复制 CRM 中的任何更改到您的模块。

要创建安装文件，请运行

composer dist

此外，要更改版本和时间戳，请更新 composer.json 中的 version 字段并运行命令

composer release