README

感谢您使用这个Drupal组件。

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

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

您可以在这里浏览完整的Drupal代码库： http://cgit.drupalcode.org/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.ac.cn/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文件中，您可能已经在做了。

在额外部分中嵌入信息

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

"extra": {
  "drupal-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。

greg-1-anderson / drupal-core-project-message

维护者

详细信息