My presumption is that there should be a way to do this automatically as part of the release process.

I'm not 100% how best to achieve this, so before running with it I'd like to open it out for discussion.

To start things off, this SO question has a few answers/suggestions.

One suggestio

As the title says, Enumeration has two properties for the same information.

        public Type Type { get; set; }
        public BuiltinType BuiltinType { get; set; }

We should remove BuiltinType and have it just as a desugared property of Type.

I ran into problems with the extremely long APP_CLASSPATH variable in joern-parse.bat when running joern-cli on Windows. The command was too long and the script would die when trying to set the classpath. I got around it by simply passing a wildcard (%APP_LIB_DIR%/*) to the -cp argument at the end of the script.

I'd file a PR but I can't find the script in this repo.

Example formatter output of reduced test case:

task t;
  a_pkg::foo #(x)::func();
endtask

Should be:

task t;
  a_pkg::foo#(x)::func();
endtask

XML comments could (at some future point) be parsed.
Perhaps it's a good idea to have them labelled as XMLdoc comments separately.
http://docwiki.embarcadero.com/RADStudio/Berlin/en/XML_Documentation_Comments

See the proposed code changes in the follow-up post.

There are two small mistakes in the sample code in readme.md.

    var g = new function() 
    {
        var delimiter = ",";   // need to define delimiter first
        this.textdata   = m.notChar('\n\r"' + delimiter);    
        ...
    }
    console.log(parser(input));

1. the variable delimiter is not defined;
2. last line should be parser, not parse.

Being able to set not just the color but also the italics or bold behavior of certain syntax terms would be great. If this is already possible it would be great if it could be added to the documentation, as I do not currently see any way to do this.

With Calyx almost ready for a 1.0 release, it does seem that documentation will need to be something to focus on.

I do think our current README is understandable, as it stands, but maybe I'm too used to the gem to really know whether the docs actually explain anything. And, of course, maybe a README may not be enough to show how Calyx can be used (and we may need to include a tutorial as well...b