- Tracked changes in HISTORY.
- Ignore
# shellcheck
directives. - Added support for
declare
andtypeset
, then fixed patterns for Mac. - Reformatted code, added lint checks, added config files for tooling to help with development.
- Added notes to watch out for issues when using Mac's built-in
sed
.
- Bash functions may use most character, so the pattern to match function names was updated. See issue #8.
- Variable names are more restrictive than function names, so a separate pattern was made to match those instead of reusing the function name pattern.
- BSD
sed
will always add a newline, so add workarounds to remove that newline. - Removed
safe_echo
andsafe_echo_n
and useprintf
instead.
- Fixed a problem that happens when lines contain escape codes that the POSIX
version of
echo
honors.
- Transferred to the
tests-always-included
organization on GitHub. - Improved the generated markdown
- Update to Sharness v0.3.0.
- Let Travis only test master branch and pull requests.
- Support TomDoc'd
export parameter
without assignment. - Support TomDoc'd
: ${parameter:=value}
and: ${parameter=value}
. - Add dedicated parsing tests.
- Allow to filter TomDoc'd functions and variables by access level (via
--access
). For example, with "--access Public" only TomDoc strings starting with "Public:" are processed. - Let Travis CI use Erlang workers and run
prove(1)
. - Update to Sharness v0.2.1.
- Support TomDoc'd shell variables.
- Use
sed(1)
in a portable way. - Allow to read from multiple files and standard input.
- Add Makefile to install or uninstall tomdoc.sh.
- Add Travis CI config.
- Improve TomDoc and function name parsing. Support Bash's
function
keyword. - Simplify doc generation.
- Add options
--help
and--version
. - Set shell option -e. Set -x when
TOMDOCSH_DEBUG
is defined in environment. - Save test results to different files for debugging.
- First version. Allows to generate documentation for TomDoc'd shell functions in (ugly) plain text or (ugly) markdown.