πŸ‘ v4 Plugin Migration Guide

Upgrading to Plugins v4 Developer Notes

Improvements:

  • Over 10x faster plugin builder!
  • Plugin builder handles more plugin structural edge-cases

Notes:

  1. New plugin builder (lipsurf-cli build) by default does not check types run with lipsurf-cli build --check for type checking.

  2. New command properties:
    onlyFinal?: true - an alternative to previous uses of delay. Only execute the command if it’s the final guess we get from the STT.
    priority?: number - allow non-dynamic commands to take priority over dynamic commands. Dynamic commands have a priority of

  3. transcript: string parameter on pageFn, fn, match::fn, and niceFn changed to TsData which is {preTs: string, normTs: string}. normTs is the same old transcript: string and preTs is before transcript preprocessing, which includes lowercasing, removing certain punctuation, trimming spaces etc.