Skip to content

Splain V2

Latest
Compare
Choose a tag to compare
@mog13 mog13 released this 17 Feb 12:51
· 44 commits to master since this release

Splain 2 Release

https://www.npmjs.com/package/@mog13/s

Splain 2 maintains the same core features and interfaces as Splain 1 but with a large amount of enhancements and quality of life features. Splain 2 focuses on the idea that external input and stimuli may drive the content of text and so should drive the selection of template execution. With the inclusion of the variable template, users can now adapt Splain to suit them without the need to wait for its specific implementation in the core library. Finally, Splain 2 improves the ease and quality of contribution by providing better tools for code quality and contribution guidance.

Features

  • Expanded config options to set custom templates.
  • Dictionary template options added:
    • Weighting - specify if an entry should have a bias.
    • Contexts - specify a context for the entry, allowing you to specify only similar contexts when processed.
  • Fixed resolution tag to make repeated entries 'sticky' per process.
  • Variable templates and execution, allowing you to provide functions and variables to templates so they can be driven from external stimuli.
  • General overhaul and clean-up.
  • Improvement to build process and related code quality tools.
  • Improved documentation.

For more information on any of these features please see the readme

Note from author
This release has been possible thanks to the determination, enthusiasm and hard work of contributors (most notably Luke Rogers). I am excited to see Splain used and am open to any suggestions, comments or input (especially pull requests!). I'd also like to encourage anyone using Splain to get in contact and share the project as I'd love to see what it could be used for.

Thanks,

Hope you enjoy it,

Morgan