README

感谢您使用此 Mautic 组件。

您可以在 Mautic.org 上参与其开发，通过我们的问题系统： https://www.mautic.org

您可以从这里获取完整的 Mautic 仓库： https://www.mautic.org

它做什么？

此 Composer 插件在 Composer 安装过程完成后显示可配置的消息。

这对于“下一步操作”类型的提示非常有用，可以帮助用户定位。

目前仅支持两个 Composer 事件

• post-create-project-cmd，当 composer create-project 命令完成后。
• post-install-cmd，当 composer install 命令完成后。

如何设置它？

在您的项目模板 composer.json 文件中需要此 Composer 插件

"require": {
  "Mautic/core-project-message": "^8.8"
}

配置

有三种方法可以配置此插件以输出信息

• 使用文本文件。
• 使用 composer.json 架构键。
• 在 composer.json 文件的 extra 部分嵌入信息。

使用文本文件

默认情况下，插件将响应 post-install-cmd 或 post-create-project-cmd Composer 事件，通过在项目的根目录中查找同名文件。例如，如果用户发出 composer create-project 命令，当该命令完成后，插件将查找名为 post-create-project-cmd-message.txt 的文件，然后将其显示在命令行上。

该文件应为纯文本，带有适合 Symfony 的 OutputInterface::writeln() 方法的标记。请参阅此处文档： https://symfony.ac.cn/doc/3.4/console/coloring.html

您也可以使用 composer.json 文件的 extra 部分配置自己的文件（们）

"extra": {
  "Mautic-core-project-message": {
    "post-create-project-cmd-file": "bespoke/special_file.txt"
  }
}

使用 composer.json 架构键

您可以通过告诉插件您希望显示的键来指示它从 composer.json 文件输出结构化支持信息。

目前，仅支持 name、description、homepage 和 support。

"extra": {
    "Mautic-core-project-message": {
        "include-keys": ["homepage", "support"],
    }
}

然后您可以将这些信息包含在 composer.json 文件中，您可能已经这样做了。

在 extra 部分嵌入信息

您可以直接在 extra 部分使用 [event-name]-message 键指定文本。此消息应为一个数组，每行一个字符串

"extra": {
  "Mautic-core-project-message": {
    "post-create-project-cmd-message": [
      "Thanks for installing this project.",
      "Please visit our documentation here: http://example.com/docs"
    ]
  }
}

这些字符串应为纯文本，带有适合 Symfony 的 OutputInterface::writeln() 方法的标记。请参阅此处文档： https://symfony.ac.cn/doc/3.4/console/coloring.html

对于给定事件，-message 部分将始终覆盖 -file。