Skip to content

Contributing

We welcome contributions to lyrics-core!

Adding a New Parser

  1. Create a new class implementing ILyricsParser.
  2. Implement the parse(content: String): SyncedLyrics method.
  3. Add your parser to AutoParser (optional, if auto-detection is desired).
  4. Add unit tests in commonTest.

Example

class MyFormatParser : ILyricsParser {
    override fun parse(content: String): SyncedLyrics {
        // Parsing logic...
        return SyncedLyrics(...)
    }
}

Adding a New Exporter

  1. Create a new class implementing ILyricsExporter.
  2. Implement the export(lyrics: SyncedLyrics): String method.

Testing

Tests

Please ensure all new parsers have coverage in commonTest.