Actually functional HTML Language Server (and Templating Language Library).
NOTE: SuperHTML is still incomplete, some features are missing and looking of somebody to implement them :^)
And there's also bugs, waiting for people to report them as Issues :^)
The Super CLI Tool offers syntax checking and autoformatting features for HTML files.
$ super
Usage: super COMMAND [OPTIONS]
Commands:
fmt Format HTML documents
lsp Start the Super LSP
help Show this menu and exit
General Options:
--help, -h Print command specific usage
This language server is stricter than the HTML spec whenever it would prevent potential human errors from being reported.
As an example, HTML allows for closing some tags implicitly. For example the following snipped is correct HTML.
<ul>
<li> One
<li> Two
</ul>
This will still be reported as an error by SuperHTML because otherwise the following snippet would have to be considered correct (while it's much probably a typo):
<h1>Title<h1>
The autoformatter has two main ways of interacting with it in order to request for horizontal / vertical alignment.
- Adding / removing whitespace between the start tag of an element and its content.
- Adding / removing whitespace between the last attribute of a start tag and the closing
>
.
Before:
<div> <p>Foo</p></div>
After:
<div>
<p>Foo</p>
</div>
Before:
<div><p>Foo</p>
</div>
After:
<div><p>Foo</p></div>
Before:
<div foo="bar" style="verylongstring" >
Foo
</div>
After:
<div
foo="bar"
style="verylongstring"
>
Foo
</div>
Before:
<div
foo="bar"
style="verylongstring">
Foo
</div>
After:
<div foo="bar" style="verylongstring">
Foo
</div>
- Download a prebuilt version of
super
from the Releases section (or build it yourself). - Put
super
in yourPATH
. - Install the Super HTML VSCode extension.
Already defaults to using SuperHTML, just add the executable to your PATH
.
Follow your editor specific intructions on how to define a new Language Server for a given language / file format.
(Also feel free to contribute more specific intructions to this readme / add files under the editors/
subdirectory).
SuperHTML is not only an LSP but also an HTML templating language. More on that soon.
SuperHTML tracks the latest Zig release (0.13.0 at the moment of writing).
Contributing to the HTML parser and LSP doesn't require you to be familiar with the templating language, basically limiting the scope of what you have to worry about to:
src/cli.zig
src/cli/
src/html/
In particular, you will care about src/html/Tokenizer.zig
and src/html/Ast.zig
.
You can run zig test src/html/Ast.zig
to run parser unit tests without needing to worry the rest of the project.
Running zig build
will compile the Super CLI tool, allowing you to also then test the LSP behavior directly from your favorite editor.
The LSP will log in your cache directory so you can tail -f ~/.cache/super/super.log
to see what happens with the LSP.