Splitting djot.lua into its own repository

[jgm]

I have split off the Lua implementation into its own repository, jgm/djot.lua. This repository now just contains the syntax description.

Now that the typescript implementation has feature parity with the Lua implementation, I'm going to deprioritize the Lua implementation, so I can move faster developing djot and djot.js. This may mean that the Lua implementation does not get updated for changes in the syntax. If it is important for someone, more hands are always welcome.

[epicfilemcnulty]

@jgm Hey, I'm ready to help with keeping the Lua implementation up to date with syntax changes. But are you going to keep the changelog of syntax changes somewhere, so it's easier to track and implement?

[jgm]

Great! I can definitely start tracking those changes more formally.
I'll try to put together a list in the coming day or two.
jgm/djot.js#18

[matklad]

I wonder if we should perhaps keep functional tests in this repo (jgm/djot)? It would make it more of a hassle to actually add functional changes, but then it'd be great if the specification was accompanied by a test-suite from the get go.

[matklad]

Also, perhaps its time for a djot github org, if we grew beyond a single repo?

[jgm]

Well I note there's already a user djot -- who has absolutely no activity. Squatter perhaps. In the case of pandoc we had the same thing, and eventually got GitHub to give us the name, but it was a bit of a process.

Putting the functional tests in the central repo could make sense. That's what we do for commonmark.

[jgm]

I put in an inquiry to GitHub support.

[bpj]

Perhaps call the org "djot-markup"?

[jgm]

@epicfilemcnulty here is a list I put together of changes in the AST made in djot.js since the split. To get details you might need to look at the code a bit.

AST changes since the last djot.lua release. Note that this refers
only to the AST itself, not the annotations used in the event parser.

• Split up List into OrderedList/BulletList/TaskList.
• Introduced TaskListItem.
• Split ListStyle into BulletListStyle and OrderedListStyle.
• Split off DefinitionList as a separate AST node type.
  Previously we used List with type ":".
• Split Math into DisplayMath/InlineMath.
• Consolidate SmartPunctuation AST elements.
  Instead of separate node types for left_single_quote, etc.,
  we now have SmartPunctuation with a type field.
  This replaces EnDash, EmDash, (Left|Right)(Single|Double)Quote, Ellipses.
  Add SmartPunctuationType.
• Change Nbsp to NonBreakingSpace with tag "non_breaking_space".
• Make block tags consistent with node types.
  blockqote -> block_quote (BlockQuote)
  hardbreak -> hard_break (HardBreak)
  softbreak -> soft_break (SoftBreak)
  symbol -> symb (Symb)
• More precise type for Table
• More precise type for DefinitionListItem
• Add label field to reference.

[epicfilemcnulty]

@jgm Great, thanks for the list. So far I've just glanced through the Lua code, I'll start working on this for real during the weekend.

A couple of styling questions before I start adding/changing things:

1. Do you use any code formatting tools in Lua? If yes, it would be nice to have those configs in the repo as well.
2. And is there a specific coding style convention you prefer? From the sources I gather that:

• snake_case is used for auxiliary function names and vars
• CamelCase is used for method names (i.e. functions that has self as the first argument)
• indentation is two spaces

[jgm]

This all seems right. I haven't been using a formatting tool.

[Omikhleia]

@jgm wrote and @epicfilemcnulty commented:

If (djot.lua) is important for someone, more hands are always welcome.

Greetings! Just a small message to show my appreciation of your work here.
The Lua implementation is what just allowed me to fairly quickly provide Djot support to the SILE typesetting system, as part of my markdown.sile module collection (work in progress).
I'll of course be interested in that cool Lua library being maintained and updated. Count me in for (at least) testing, and helping if need be.