Skip to content

Latest commit

 

History

History
87 lines (77 loc) · 3.4 KB

CHANGELOG.md

File metadata and controls

87 lines (77 loc) · 3.4 KB
Raw

Changelog

0.8.0

25.11.2020

Breaking 💥

  • Changed return type of Sentence.generate to string

0.7.0

21.11.2020

Breaking 💥

  • Changed various types and interfaces
  • Removed method restoreDefaults from SentenceFactory

Features 🎉

  • Added needlessly complex esm build process
  • Added automatic type declarations to compile
  • Added following types to exports:
    • Template Vocabulary Options Configuration StringResolvable WeightedEntry

Bugfixes 🐛

  • Fixed various issues/bugs with special characters in placeholder notation

0.6.1

Bugfix 🐛

  • Fix error where adding a- or -s to a placeholder would break during runtime

0.6.0 - Weighted Types

24.08.2020

Breaking 💥

  • Changed method addVocab to addVocabulary in class Sentence
  • Removed method setOptions in class Sentence
  • Removed option allowDuplicates

Features 🎉

  • Added type WeightedTemplate
  • Added type WeightedVocabulary
  • Added type WeightedEntry
  • Added setter options in Sentence
  • Added getter weightedTemplates in Sentence
  • Added getter weightedVocabulary in Sentence
  • Changed resolution of duplicates so that they simply increases the given entry's weight

Bugfixes 🐛

  • Fix addVocabulary so that it appends instead of overwriting

0.5.2 - StringResolvable

18.08.2020

Features 🎉

  • Added type StringResolvable
  • Change type Template to accept StringResolvable
  • Change type Vocabulary to accept StringResolvable

0.5.1

17.08.2020

  • 🐛 Fix issue where option forceNewSentence would have no effect

0.5.0 - TypeScript

16.08.2020

Breaking 💥

  • Refactored entire project to TypeScript
  • Removed default export, should now defer to importing createSentence for the default behaviour
  • Removed or changed all other exports

Features 🎉

  • Added class Sentence to exports
  • Added class SentenceFactory to exports

0.4.2 - 11.08.2020

Documentation

  • 🔩 Change package keywords
  • 🔩 Change package description
  • 🔩 Change README

0.4.1 - 30.07.2020

  • 🎉 New option allowDuplicates now functions as expected
  • 🎉 New option capitalize now functions as expected
  • 🎉 New option placeholderNotation
  • 💥 Changed option preserveCurlyBrackets to preservePlaceholderNotation
  • 🐛 Fix setOptions so that it no longer resets unspecified options to previous defaults

0.4.0 - 26.07.2020

Features

  • 🎉 New option forceNewSentence, which will force Sentence.generate() to avoid duplicate of previous sentence when possible
  • 🎉 New method restoreDefaults() available at entry point

Development

  • 🔩 Add jest for testing
  • 🔩 Add eslint for linting
  • 🔩 Add .npmignore
  • 🔩 Add Github Workflows for CI/CD
  • 🔩 Change validation to module validator
  • 🔩 Change defaults to module defaults
  • 🔩 Various other changes and improvements to readability and encapsulation