<commit_before>
TODO Future:
============
- add the ability to count the number of assertions that should have been executed in the test
- mention that general error are correctly handled by luaunit as failures
- detect if a functions creates new global variables.
- validate output with ignored tests (0 failures or some failures)
- report test duration everywhere
- allow to skip tests
- randomized testing
- parametrize tests
- coloured output
- global setup / teardown
- class setup / teardown
- add date and duration to tap output
- better error messages for table assertions:
	+ expected length of X, got Y
	+ keys differing in table 1 and 2
- XML: report system information
- better error messages for string differences

Nice to have: 
============
- stack unwrapping like in py.test

TODO for 3.2 release:
====================
- update doc with all new assertion
- integrate latest pull requests
- document new config: table with key of type table
- luarock package

Done since 3.1:
===============
x provide a luarock package. See: https://rocks.moonscript.org/modules/rjpcomputing/luaunit
x make a difference between errors and failures
x lua 5.3 
x travis lua 5.3
x compatibility with LuaUnit v2.0 of rjbcomputing
x provide a legacy wrapFunction()

Done since 3.0:
===============
x check documentation link glitch to TAP 
x doc: report how to handle global space pollution/restriction
x doc: adapt all examples to new way of requireing luaunit
x less global space pollution
x doc: move description of table printing to an annex
x validate well-formed XML with a DTD
x validate test output (TAP, ...) with functional tests<commit_msg>Update TODO<commit_after>
TODO Future:
============
- add the ability to count the number of assertions that should have been executed in the test
- mention that general error are correctly handled by luaunit as failures
- detect if a functions creates new global variables.
- validate output with ignored tests (0 failures or some failures)
- report test duration everywhere
- allow to skip tests
- randomized testing
- parametrize tests
- coloured output
- global setup / teardown
- class setup / teardown
- add date and duration to tap output
- better error messages for table assertions:
	+ expected length of X, got Y
	+ keys differing in table 1 and 2
- XML: report system information
- better error messages for string differences

Nice to have: 
============
- stack unwrapping like in py.test

TODO for 3.2 release:
====================
- document new config: table with key of type table
- document --error

Done since 3.1:
===============
x provide a luarock package. See: https://rocks.moonscript.org/modules/rjpcomputing/luaunit
x make a difference between errors and failures
x lua 5.3 
x travis lua 5.3
x compatibility with LuaUnit v2.0 of rjbcomputing
x provide a legacy wrapFunction()

Done since 3.0:
===============
x check documentation link glitch to TAP 
x doc: report how to handle global space pollution/restriction
x doc: adapt all examples to new way of requireing luaunit
x less global space pollution
x doc: move description of table printing to an annex
x validate well-formed XML with a DTD
x validate test output (TAP, ...) with functional tests
{'fraction_non_alphanumeric': 0.08876474239602732, 'fraction_numerical': 0.00931098696461825, 'mean_word_length': 4.181672025723473, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1125287', 'n_tokens_mistral': 866, 'n_tokens_neox': 812, 'n_words': 460}