1.1.0 Improvements and Fixes

[Jaynator495]

This release improves the readme, documentation, performance and also bug fixes.

Breaking

All Smiley identifiers have been renamed to Emoji, this is a fairly small change but brings the package up to the modern era. Refer to the new documentation for a complete list of methods.

Changes

• Convert all php polyfills from locutus into native js, this means this package has no more runtime dependencies!
• Convert from ts-loader to babel for compiling for browsers
• Add multiple types of releases, full and minified, and for each also a legacy version and normal version. (Legacy allows for compatibility on older browsers that don't support things like the spread operator, but might suffer slightly in performance)
• Major code cleanup
  • All PHP-Like variables have been converted to JS-Like
  • Improves the typing/types of the code (There is still some more work to do here)
  • Convert webpack config to TS
  • Improves documentation
• New documentation page that gets generated as code gets updated
• Adds extra tests to make sure most cases work fine.

Bugs Fixed

• Issue with [acronym] not being properly parsed if the input isn't exactly right
• Issue with [list] where in some circumstances the closing tag would break the function
• Likely other similar issues related to the above. This should improve the stability of the parser greatly.

Final note

I'm not sure what to do about the default emoji that would normally be included with the PHP version of this package. I am conflicted on including the original emoji since they are very outdated, and instead I'm considering including modern emoji (potentially Twemoji? (Twitter Emoji), or alternatively the custom emoji we use on QuestonCove?) and updating the default emoji definitions in the file. Any feedback about this would be welcome.

Full Changelog: 1.0.0...1.1.0

---

This discussion was created from the release 1.1.0 Improvements and Fixes.

[seanofw]

I'd be inclined to get rid of the old ones, even if that's a breaking change: The JS version of this isn't obligated to be 100% backward compatible with the original PHP.

The emojis come from an era when there was no standard for emoji: To have emoji at all, I needed to include actual GIFs, and a way to reference them, or they simply didn't exist. In the modern era, Unicode and most devices have such a thing built-in, so I'd be inclined to at least strip out the redundant old emojis. I'd be half-tempted to strip out the feature entirely, but some sites like using custom emoji with strings like :starwars: or :picardfacepalm:, and you probably want a good way to support that still, which the "smiley" logic is likely still good for.

But there's no reason to include 🙂 now when you can just type it on an ordinary keyboard.