alexbaron77 / drupal-spec-tool-commands
提供composer命令,用于自动化使用acquia/drupal-spec-tool
Requires
- composer-plugin-api: ^1.1
- google/apiclient: ^2.0
This package is auto-updated.
Last update: 2024-09-26 03:44:35 UTC
README
提供composer命令功能,用于自动化填充/更新gherkin文件,这些文件由acquia/drupal-spec-tool定义。无需每次调整规格表时都进行复制粘贴。相反,在项目开始时进行几个配置步骤,并使用此功能保持功能文件更新。由于这些命令是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/