Jmaa/pretty
1
0
Fork 0
Code Actions

Lots of minor formatting fixes for embedded functions.

Browse Source
This commit is contained in:
Jon Michael Aanes 2017-07-15 21:58:27 +02:00
parent 8005e75794
commit 3c5db269d6
2 changed files with 69 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
function.lua
View File

@ -182,16 +182,26 @@ local function add_indent_to_string (str, indent)
end
local function get_docs_from_function_body (func_body)
-- Finds the documentation lines of a function.
-- Also returns the remaining non-documentation lines.
assert(type(func_body) == 'string')
local doc_lines = {}
local doc_lines, not_doc_lines, still_docs = {}, {}, true
for line in func_body:gmatch('[^\n]+', true) do
if not line:match('^%s*$') then
if still_docs and not line:match('^%s*$') then
local line_text = line:match('^%s*%-%-%s*(.*)%s*$')
if not line_text then break end
doc_lines[#doc_lines+1] = line_text
if line_text then
doc_lines[#doc_lines+1] = line_text
else
still_docs = false
end
end
if not still_docs then
not_doc_lines[#not_doc_lines+1] = line
end
end
return table.concat(doc_lines, '\n')
return table.concat(doc_lines, '\n'), table.concat(not_doc_lines, '\n')
end
local function wrap_text (text, max_width)
@ -248,13 +258,17 @@ return function (value, depth, l, format_value)
local function_params, function_body = nil, '...'
if info.defined_how == 'string' then
-- Function was defined as a string
local _, body = get_function_paramlist_and_body(info)
if info.defined_how == 'string' or not info.doc then
local params_text, body = get_function_paramlist_and_body(info)
local documentation, body = get_docs_from_function_body(body)
body = body:match('^%s*(.-)%s*$')
if #body <= NR_CHARS_IN_LONG_FUNCTION_BODY and not body:find '\n' and not body:find(FUNCTION_KEYWORD_MATCH) then
function_body = body
if info.defined_how == 'string' then function_body = body end
end
end
if body then
info.doc = documentation ~= '' and documentation
end
end
if info.builtin and l.options.short_builtins then
assert(info.name)
@ -298,15 +312,7 @@ return function (value, depth, l, format_value)
l[#l+1] = info.name
end
-- Doc
if not info.doc then
local function_body = select(2, get_function_paramlist_and_body(info))
if function_body then
local documentation = get_docs_from_function_body(function_body)
info.doc = documentation ~= '' and documentation
end
end
-- Doc
if info.doc then
l[#l+1] = '\n'
local indent = l.options.indent .. '-- '
@ -363,7 +369,11 @@ return function (value, depth, l, format_value)
l[#l+1] = '--]]'
end
l[#l+1] = '\n'
l[#l+1] = indent
l[#l+1] = '...\nend'
-- Ignore spacing and function body if it's a Λ string.
if function_body ~= '' then
l[#l+1] = '\n'
l[#l+1] = indent
l[#l+1] = function_body
end
l[#l+1] = '\nend'
end

42
test/test_function.lua
View File

@ -188,14 +188,14 @@ format_test {
format_test {
name = 'Can find docs from string-loaded function',
input = loadstring 'return function ()\n--Hello\nend' (),
expect = 'function ()\n -- Hello\n\n ...\nend',
input = loadstring 'return function ()\n-- Hello\nreturn 2\nend' (),
expect = 'function ()\n -- Hello\n\n return 2\nend',
}
format_test {
name = 'String-loaded functions without docs, won\'t display Source file comment',
input = loadstring 'return function () end' (),
expect = 'function ()\n -- Loaded from string\n\n ...\nend',
input = loadstring 'return function (a) return a end' (),
expect = 'function (a)\n -- Loaded from string\n\n return a\nend',
}
--------------------------------------------------------------------------------
@ -309,6 +309,22 @@ format_test {
expect = 'function (self) return self end',
}
format_test {
name = 'Embed functions in single mode without documentation',
single = true,
adv_getlocal = true,
input = loadstring('return function () -- Hi\nreturn 1234 end')(),
expect = 'function () return 1234 end',
}
format_test {
name = 'Embed functions and ignore the whitespace after the documentation',
single = true,
adv_getlocal = true,
input = loadstring('return function () -- Hi\n\n\t \t\t return 1234 end')(),
expect = 'function () return 1234 end',
}
--[[ NOTE: This turned out to be hard. Requires traversal of AST.
format_test {
name = 'Embed correct function, when two are on the same line, but with different arguments 1',
@ -339,10 +355,26 @@ format_test {
name = 'If embedding a function would include newline, ignore',
single = true,
adv_getlocal = true,
input = loadstring('return function () -- Hi\n return 1234 end')(),
input = loadstring('return function ()\n\ta = math.random()\nreturn a + 15 end')(),
expect = 'function () ... end',
}
--------------------------------------------------------------------------------
-- Elaborate embedded functions
format_test {
name = 'Embed functions when elaborate formatting',
adv_getlocal = true,
input = loadstring('return function () return 1234 end')(),
expect = 'function ()\n -- Loaded from string\n\n return 1234\nend',
}
format_test {
name = 'Embedding function without body, includes only the documentation',
input = loadstring 'return function () end' (),
expect = 'function ()\n -- Loaded from string\nend',
}
--------------------------------------------------------------------------------
-- Indent functions nicely