nickwilde1990/drupal-spec-tool-commands

提供 composer 命令,用于自动化使用 acquia/drupal-spec-tool

安装量: 5,300

依赖项: 0

建议者: 2

安全性: 0

星标: 2

关注者: 2

分支: 7

类型:composer-plugin

v1.0.0-rc1 2018-08-20 15:15 UTC

This package is auto-updated.

Last update: 2024-09-22 10:09:11 UTC


README

提供 composer 命令功能,用于自动化填充/更新由 acquia/drupal-spec-tool 定义的 gherkin 文件。无需每次调整规范电子表格时都复制粘贴。相反,在项目开始时进行一些配置步骤,并使用此工具来保持功能文件更新。由于命令是 composer 命令,因此此项目需要 Composer 设置。

入门指南

Composer 配置

该命令需要一些外部信息。目前提供这些信息的途径是通过 composer.json 中的额外配置。在 extra 下,添加一个子键 drupal-spec-tools,并在该子键下提供以下键值对

  • spreadsheet: Drupal Spec Tool 电子表格的 ID。它是访问电子表格的 URL 中的长随机字符串/UUID。例如,在 https://docs.google.com/spreadsheets/d/1h-SieCV9Dtrj8F4bqMvsbcHwIibN30j2oR9FMRDFT-8/edit?usp=sharing 中,ID 是 1h-SieCV9Dtrj8F4bqMvsbcHwIibN30j2oR9FMRDFT-8
  • credentials-path: 从获取 Google 凭据并存储认证密钥的文件夹。**警告**:出于安全原因,在许多情况下,凭据不应提交到您的仓库。
  • feature-path(可选)[默认:'tests/features']: 将/更新功能文件的路径。**警告**:与 Drupal Spec Tool 功能名称相同的文件将被覆盖,如果它们已存在。

最小示例

{
  "extra": {
    "drupal-spec-tool": {
        "credentials-path": "tests/drupal-spec-tool",
        "spreadsheet": "1a1B-4YFjueF0xM34CWA_xKcVc89rk_MlKW1aNFcfx3c"
    }
  }
}

凭据

您需要 Google API 凭据 - 只需完成步骤 1,并将 credentials.json 保存到 credentials-path。由于这仅提供 API 访问/可能会耗尽您的 API 限额,因此如果它是私有的,则可以安全地将其保存在您的仓库中。

用法

在项目根目录中,运行 composer drupal-spec-dump-gherkin

首次运行时,这将要求您访问电子表格。您需要复制/粘贴输出授权 URL 并登录到 Google 以确认访问。这将保存一个令牌到定义的凭据路径,并且只要它存在,您就不需要在后续运行中重新进行身份验证。

已知问题

查看问题队列中的开放错误报告。

贡献

欢迎贡献!

许可证

版权 (C) 2018 Nick Wilde。

本程序是免费软件:您可以按照自由软件基金会发布的 GNU 通用公共许可证的条款重新分发和/或修改它,许可证版本 3 或(根据您的选择)任何较新版本。

本程序是根据希望它将是有用的原则分发的,但没有任何保证;甚至没有关于适销性或特定用途的隐含保证。有关详细信息,请参阅 GNU 通用公共许可证。

您应已收到本程序的 GNU 通用公共许可证副本。如果没有,请参阅 https://gnu.ac.cn/licenses/