ocsigen / ocsigen/tyxml

Templating and ppx for tyxml

Open
#68 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement syntax extension
Dominant language
OCaml
Stars
179
Forks
63
Avg merge
5h
Merged PRs (30d)
22

Description

There has been several request of a templating method in tyxml. Also, with the various other ppx coming, finally cleaning up the syntax extension question might be a good idea.

Here are my notes and ideas on how to do it:

  1. Having a decent html parsing library. Either we use something simple that only parses valid html, or something more complicated (see this discussion in particular). It doesn't have to be the first thing done.
  2. Create a systematic way to translate html documents into tyxml function. Currently, some functions in tyxml are not exactly the html element's name (because of syntactic restriction in html, or disambiguation, and so on). This would also be the occasion to normalize and rationalize tyxml's naming convention. @Eyyub started such work in https://github.com/Eyyub/ppx_tyxml
  3. Write a ppx for a syntax extension and something that can take an html tree with holes and produce an ocaml function out of it. It will basically be the exact same thing anyway.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository file or test is named. Start by reviewing the three-part proposal, the linked ocaml-cow discussion, and Eyyub's ppx_tyxml work; done requires an agreed scope for HTML parsing, HTML-to-tyxml translation, and the ppx or templating interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
compilers, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.