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

Add Typst support #1623

Open
2 tasks done
RundownRhino opened this issue Nov 2, 2024 · 3 comments · May be fixed by #1626
Open
2 tasks done

Add Typst support #1623

RundownRhino opened this issue Nov 2, 2024 · 3 comments · May be fixed by #1626
Assignees
Labels
area: frontend Related to output and formatting category: utilities Related to utilities status: approved The issue has received a core developer's approval type: feature Relating to the functionality of the application.

Comments

@RundownRhino
Copy link

Description

Add a .typst command, working similarly to .latex but for rendering Typst.

Reasoning

The bot's .latex command has been notoriously unstable in the past, but nowadays is mostly working. However, it's pretty hard to consistently write correct LaTeX snippets on the first try, and the error logs are not especially helpful because LaTeX logs rarely are. It would be nice to have a simpler alternative for quickly writing some simple math, and Typst would fill that niche - Typst source code is much more readable and doesn't require an explicit preamble. The following is an (entire!) typst document:

$lim_(h -> 0) (f(x + h) - f(x))/h$

which renders to:
Image

Proposed Implementation

Typst has a Python library, so the implementation should be straightforward. Here's a proof of concept:

import typst
from tempfile import NamedTemporaryFile
from PIL import Image

s = """$lim_(h -> 0) (f(x + h) - f(x))/h$"""
with NamedTemporaryFile("w", encoding="utf-8") as inp, NamedTemporaryFile("rb", suffix=".png") as out:
    inp.write(s)
    inp.flush()
    typst.compile(inp.name, out.name)
    img = Image.open(out)
    img.load()
img.show()

An interesting detail is the handling of third-party packages. The Latex cog is currently implemented as having a specific set of whitelisted packages available. Typst, meanwhile, by default supports importing arbitrary packages at runtime to be downloaded during the compilation process - which in theory is safe because typst plugins are required to be pure functions that get compiled to WASM. Nevertheless, probably at first it'd be best to only allow a shortlist of popular packages, but in the future we could consider removing that limit.

Would you like to implement this yourself?

  • I'd like to implement this feature myself
  • Anyone can implement this feature
@RundownRhino RundownRhino added status: planning Discussing details type: feature Relating to the functionality of the application. labels Nov 2, 2024
@mbaruh mbaruh added status: approved The issue has received a core developer's approval and removed status: planning Discussing details labels Nov 8, 2024
@mbaruh
Copy link
Member

mbaruh commented Nov 8, 2024

Have you considered using io.BytesIO? Or does the library not support it?

@mbaruh mbaruh added area: frontend Related to output and formatting category: utilities Related to utilities labels Nov 8, 2024
@RundownRhino
Copy link
Author

It looks like it does support not writing an output file (just need to not pass output). I'll change the implementation to use that. It will come with the problem that a maliciously constructed input can return an arbitrarily big bytes object, but I can probably fix this by setting a an rlimit on memory usage for the worker process.

@mbaruh
Copy link
Member

mbaruh commented Nov 8, 2024

If you're worried about a maliciously large output, that's probably a good idea regardless of the method

@RundownRhino RundownRhino linked a pull request Nov 9, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: frontend Related to output and formatting category: utilities Related to utilities status: approved The issue has received a core developer's approval type: feature Relating to the functionality of the application.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants