include-code-files: inclusion of code from source files (as pandoc-include-code hs filter) #130
Conversation
b3
changed the title
b3
changed the title
There was a problem hiding this comment.
Thank you, this is great. I left a short inline comment, but I'll go ahead and merge now.
One possible enhancement would be to support hyphenated names like start-line as alternatives to the startLine pascalCase names. Pandoc uses hyphenated names in many places, so that might make this more natural to use.
| local content = "" | ||
| local fh = io.open(cb.attributes.include) | ||
| if not fh then | ||
| io.stderr:write("Cannot open file " .. cb.attributes.include .. " | Skipping includes\n") |
There was a problem hiding this comment.
Would it make sense to just return nil from the function at this point? This would allow us to remove the else clause and thereby reduce nesting.
There was a problem hiding this comment.
As far as pandoc.CodeBlock("") returns nil and that no other filters use the attributes placed in the code this is of course a nice idea for simplifying the code.
As I said I, however, did not understand pandoc lua filter process enough to be confident when I wrote that piece of code.
Can't we imagine that another filter on CodeBlock may be used after this one? That was my assumption and the reason for cleaning specific attributes used only by this filter.
There was a problem hiding this comment.
I guess that's reasonable. I usually follow the principle that if an element cannot be processed the way we'd like, then it won't be touched at all. Whether or not that applies here is open to interpretation. I'm fine with the way it is now.
|
|
||
| --- Dedent a line | ||
| local function dedent (line, n) | ||
| return line:sub(1,n):gsub(" ","") .. line:sub(n+1) |
|
|
||
| Filter to include code from source files. | ||
|
|
||
| The filter is largely inspired by [pandoc-include-code](https://github.com/owickstrom/pandoc-include-code). |
There was a problem hiding this comment.
Correction proposed in PR #136.
|
I created a PR #137 to add support for |
|
Thanks. Good point about numberLines, I hadn't considered that. |
In order to facilitate an eventual inclusion of code as commented in PR #126 I modified my fork and created distincts PR.
This one includes a new filter called
include-code-fileswhich mimic almost every feature of pandoc-include-code which offer inclusion of source code files which some specific options (ranges, dedent).