htmlEntities for Lua

June 22, 2019 · View on GitHub

HTML entities decoding/encoding

Written for Lua5.3 but working with lua5.x!

Features

Fast!
No dependencies!
Easy to implement!

Installation

Module available through the LuaRocks. It can be installed using the luarocks command line tools.

# LuaRocks
luarocks install html-entities

Example

htmlEntities = require('htmlEntities')
print(htmlEntities.name) -- htmlEntities-for-lua
print(htmlEntities.encode('Tiago Danin :)')) -- &#84;&#105;&#97;&#103;&#111;&#32;&#68;&#97;&#110;&#105;&#110;&#32;&#58;&#41;
print(htmlEntities.decode('&#84;&#105;&#97;&#103;&#111;&#32;&#68;&#97;&#110;&#105;&#110;&#32;&#58;&#41;')) -- Tiago Danin :)

Documentation

API

Function	Info
htmlEntities	Return table with information about module
htmlEntities.decode(input)	Decode HTML entities
string:htmlDecode()	Same as above
htmlEntities.encode(input)	Encode in HTML entities (in ASCII) NOTE: Emoji is not supported here!
string:htmlEncode()	Same as above
htmlEntities.ASCII_HEX(input)	Decode ASCII HEX
htmlEntities.ASCII_DEC(input)	Decode ASCII DEC

Module Options

String	Default	Info
error_msg_htmlEntities	false	View log of erros
debug_htmlEntities	false	Print output
ASCII_htmlEntities	true	Decode of entities in ASCII
register_global_module_htmlEntities	false	Register module as global
global_module_name_htmlEntities	"htmlEntities"	Name in global mode

Tests

To run the test suite:

# Lua
lua tests/cli.lua
# Or
lua tests/travis.lua

Contributors

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.