Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor interlinks plugin to use lua #110

Closed
5 of 8 tasks
machow opened this issue Apr 14, 2023 · 3 comments · Fixed by #128
Closed
5 of 8 tasks

Refactor interlinks plugin to use lua #110

machow opened this issue Apr 14, 2023 · 3 comments · Fixed by #128

Comments

@machow
Copy link
Owner

machow commented Apr 14, 2023

Now that the filter behaviors are well known, let's re-write it in lua. This will ensure it doesn't break as quarto leans more into lua filter features. This will also enable us to upgrade to quarto v1.3

Related

Spec

(PR incoming)

TODO

  • : run python filter on pyshiny site, commit files. Then, re-run with new filter. Based on diff, add any missing test cases.
@machow machow added the .epic label Apr 14, 2023
@machow machow added this to quartodoc Apr 14, 2023
@machow machow moved this to Backlog in quartodoc Apr 14, 2023
@machow machow added this to the shinyv2 milestone Apr 14, 2023
@wch
Copy link
Collaborator

wch commented Apr 14, 2023

Hopefully this will also resolve #111.

@machow
Copy link
Owner Author

machow commented Apr 19, 2023

Paired w/ Carlos, who churned out a prototype lua filter with lightning speed :o! I'll open a PR, but want to leave these notes.

To figure out:

  • How to go from running filter -> path to <docs_root>/objects.inv, or <docs_root>/_inv/... (Carlos figured it out)
  • How to test? Maybe we...
    • Keep the relevant python logic for loading inventories, resolving refs
    • Keep some test docs in quartodoc/tests, with just the interlink syntax
    • Render those docs with the lua filter
    • Render those docs with python logic (like a snapshot test?)

@machow machow moved this from Backlog to In Progress in quartodoc Apr 19, 2023
@machow machow moved this from In Progress to Todo in quartodoc May 1, 2023
@machow machow moved this from Todo to In Progress in quartodoc May 1, 2023
@machow
Copy link
Owner Author

machow commented May 3, 2023

quarto --to json can be used for validating outputs of a lua filter (from e.g. python)

@machow machow added the shiny label May 17, 2023
@machow machow linked a pull request May 18, 2023 that will close this issue
4 tasks
@github-project-automation github-project-automation bot moved this from In Progress to Done in quartodoc May 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants