README

感谢您使用此Drupal组件。

您可以在Drupal.org上通过我们的问题系统参与其开发： https://www.drupal.org/project/issues/drupal

您可以从这里获取完整的Drupal仓库： https://www.drupal.org/project/drupal/git-instructions

您可以从这里浏览完整的Drupal仓库： https://git.drupalcode.org/project/drupal

它做什么？

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

这对于提供“下一步操作”提示，帮助用户定位非常有用。

目前仅支持两个Composer事件

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

如何设置它？

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

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

配置

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

• 使用文本文件。
• 使用composer.json架构密钥。
• 将信息嵌入composer.json文件的额外部分。

使用文本文件

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

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

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

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

使用composer.json架构密钥

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

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

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

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

将信息嵌入额外部分

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

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

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

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