l3ku / ultimate-guitar-tabs-chords
一款从 Ultimate Guitar 获取和弦和乐谱的 WordPress 插件
Requires
- php: >=7.0
- sunra/php-simple-html-dom-parser: >=1.5.2
This package is not auto-updated.
Last update: 2024-09-29 03:10:21 UTC
README
通过抓取 HTML 从 Ultimate Guitar 获取和弦和乐谱的 WordPress 插件。
安装
该插件目前尚未在 wordpress.org 插件目录中提供。安装方法是通过导航到 WordPress 插件目录,并从 GitHub 克隆插件 git 仓库:git clone git@github.com:l3ku/ultimate-guitar-tabs-chords.git
。
如果项目中使用了 Composer,也可以通过运行 composer require l3ku/ultimate-guitar-tabs-chords
来包含此插件。
现在插件应该在 WordPress 管理后台的插件页面中可用,以便激活。激活后,应有一个新的设置页面(在“设置”下),页面名为 UG Tabs & Chords
。
使用方法
将插件短代码添加到所需的页面或帖子中。您可以使用插件设置页面上的短代码生成器生成插件短代码。
测试
此项目在 tests/
目录中包含基于 PHPUnit 的单元测试。在运行测试之前,通过在插件目录中运行安装脚本安装 WordPress 测试套件:
bash bin/install-wp-tests.sh wordpress_test <DB_USER> <DB_PASSWORD> localhost latest
注意: 数据库用户需要有创建表的权限
然后可以通过简单地运行 phpunit
命令来运行测试。
开发
该项目非常新,此插件的功能仍然相当有限。欢迎反馈、问题和 PR。然而,在提交拉取请求之前,请确保:
- 所有测试都成功完成
- 您 PR 中的提交是逻辑实体(如有必要,请使用
git rebase -i
) - 您的代码符合 WordPress 插件指南、WordPress 编码标准 以及现有的插件代码
- 在 PR 中清楚地解释了所做的工作及其原因