跳转至

贡献指南

欢迎为 lyrics-core 做出贡献!

改进已有的解析器

添加新的解析器

  1. 创建一个新类实现 ILyricsParser 接口。
  2. 实现 parse(content: String): SyncedLyrics 方法。
  3. 将你的解析器添加到 AutoParser(可选,如果需要支持自动检测)。
  4. commonTest 中添加单元测试。

示例

class MyFormatParser : ILyricsParser {
    override fun parse(content: String): SyncedLyrics {
        // 解析逻辑...
        return SyncedLyrics(...)
    }
}

添加新的导出器

  1. 创建一个新类实现 ILyricsExporter 接口。
  2. 实现 export(lyrics: SyncedLyrics): String 方法。

测试

Tests

请确保所有新解析器在 commonTest 中都有测试覆盖。