8736205729

Committed 18 Apr 2024 10:16AM UTC coverage: 63.747% (-11.0%) from 74.718%

Build # 8736205729

Build Type

push

github

Committed by

alerque

Commit Message

chore(classes): Correct typos in user facing deprecation message

Run Details

10118 of 15872 relevant lines covered (63.75%)

6751.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/inputfilter/init.lua

local base = require("packages.base")

local package = pl.class(base)
package._name = "inputfilter"

function package:transformContent (content, transformFunction, extraArgs)
  local newContent = {}
  for k, v in SU.sortedpairs(content) do
    if type(k) == "number" then
      if type(v) == "string" then
        local transformed = transformFunction(v, content, extraArgs)
        if type(transformed) == "table" then
          for i = 1, #transformed do newContent[#newContent+1] = transformed[i] end
        else
          newContent[#newContent+1] = transformed
        end
      else
        newContent[#newContent+1] = self:transformContent(v, transformFunction, extraArgs)
      end
    else
      newContent[k] = v
    end
  end
  return newContent
end

function package.createCommand (_, pos, col, lno, command, options, content)
  local result = { content }
  result.col = col
  result.lno = lno
  result.pos = pos
  result.options = options
  result.command = command
  result.id = "command"
  return result
end

function package:_init ()
  base._init(self)
  self:deprecatedExport("createCommand", self.createCommand)
  self:deprecatedExport("transformContent", self.transformContent)
end

package.documentation = [[
\begin{document}
The \autodoc:package{inputfilter} package provides ways for class authors to transform the input of a SILE document after it is parsed but before it is processed.
It does this by allowing you to rewrite the abstract syntax tree representing the document.

Loading \autodoc:package{inputfilter} into your class with \code{class:loadPackage("inputfilter")} provides you with two new Lua functions: \code{transformContent} and \code{createCommand}.
\code{transformContent} takes a content tree and applies a transformation function to the text within it.
See \url{https://sile-typesetter.org/examples/inputfilter.sil} for a simple example, and \url{https://sile-typesetter.org/examples/chordmode.sil} for a more complete one.
\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "inputfilter"	×
5
6	function package:transformContent (content, transformFunction, extraArgs)	×
7	local newContent = {}	×
8	for k, v in SU.sortedpairs(content) do	×
9	if type(k) == "number" then	×
10	if type(v) == "string" then	×
11	local transformed = transformFunction(v, content, extraArgs)	×
12	if type(transformed) == "table" then	×
13	for i = 1, #transformed do newContent[#newContent+1] = transformed[i] end	×
14	else
15	newContent[#newContent+1] = transformed	×
16	end
17	else
18	newContent[#newContent+1] = self:transformContent(v, transformFunction, extraArgs)	×
19	end
20	else
21	newContent[k] = v	×
22	end
23	end
24	return newContent	×
25	end
26
27	function package.createCommand (_, pos, col, lno, command, options, content)	×
28	local result = { content }	×
29	result.col = col	×
30	result.lno = lno	×
31	result.pos = pos	×
32	result.options = options	×
33	result.command = command	×
34	result.id = "command"	×
35	return result	×
36	end
37
38	function package:_init ()	×
39	base._init(self)	×
40	self:deprecatedExport("createCommand", self.createCommand)	×
41	self:deprecatedExport("transformContent", self.transformContent)	×
42	end
43
44	package.documentation = [[
45	\begin{document}
46	The \autodoc:package{inputfilter} package provides ways for class authors to transform the input of a SILE document after it is parsed but before it is processed.
47	It does this by allowing you to rewrite the abstract syntax tree representing the document.
48
49	Loading \autodoc:package{inputfilter} into your class with \code{class:loadPackage("inputfilter")} provides you with two new Lua functions: \code{transformContent} and \code{createCommand}.
50	\code{transformContent} takes a content tree and applies a transformation function to the text within it.
51	See \url{https://sile-typesetter.org/examples/inputfilter.sil} for a simple example, and \url{https://sile-typesetter.org/examples/chordmode.sil} for a more complete one.
52	\end{document}
53	]]	×
54
55	return package	×

sile-typesetter / sile / 8736205729

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous