This is the documentation page for Module:Unindent
 | This is a documentation subpage for Module:Unindent. It may contain usage information, categories and other content that is not part of the original module page. |
| Description | Resets the indentation level of mulitline strings. |
|---|---|
| Author(s) | 8nml |
| Code source | Unindent |
| Status | Release |
| Using code by | @kikito (Github) |
| License | MIT |
Unindent resets the indentation level of mulitline strings. It is useful for multiline strings inside functions and large tables. This module serves as a utility function for string parsing, Testharness test suites, I18n datastores.
Lua supports multiline strings in the format [[\n...\n]]. In general, Lua does not outdent indented multiline strings out of the box. Though Lua supports variable indentation in multiline strings, custom logic is necessary to reset the string's indentation. This module adopts a flexible approach based on string scanning.
Unlike Penlight's pl.text.dedent behaviour where every line has the indentation of the first line removed, the line prefixed with the least non-tab whitespace is reset to zero indentation. Thus, the opening line of the string may retain some indentation if there are lines of less indentation terminating the string.
Documentation
Package function
unindent(str)(function)- Unindent resets the indentation level of mulitline strings.
- Parameter:
strMultiline string indented consistently. (string) - Returns: Unindented string. (string)