Contributing¶
We welcome contributions to lyrics-core!
Adding a New Parser¶
- Create a new class implementing
ILyricsParser. - Implement the
parse(content: String): SyncedLyricsmethod. - Add your parser to
AutoParser(optional, if auto-detection is desired). - Add unit tests in
commonTest.
Example¶
class MyFormatParser : ILyricsParser {
override fun parse(content: String): SyncedLyrics {
// Parsing logic...
return SyncedLyrics(...)
}
}
Adding a New Exporter¶
- Create a new class implementing
ILyricsExporter. - Implement the
export(lyrics: SyncedLyrics): Stringmethod.
Testing¶
Please ensure all new parsers have coverage in commonTest.