gear up for release

some fixes and some changes to READMEs to get ready for the next release

- `--no-strict-tags` renamed to `--syntax-only`. the old name stopped
  making sense once we started validating more than just tag names.
- fmt now has much better defined behavior: it will print all errors it
  encounters but will only have a non-zero exit code in the presence of
  syntax errors that prevent autoformatting. when used in combination with
  `--syntax-only` then it will not print any error that would not prevent
  autoformatting.
- fixed a bug introduced in the last commits where we would autocomplete closing
  tags also for void elements
- the vscode extension now disables all it can from the builtin vscode
  functionality and prompts the user to disable the builtin html extension
  entirely (until microsoft fixes their stuff).
- the vscode extension now exposes a setting to enable `--syntax-only`
- removed the `interface` subcommand
- fixed some more crashes found with the fuzzer

Author: kristoff-it

.github/helix.png

@@ -3,7 +3,7 @@ HTML Language Server and Templating Language Library
 
 
 ## HTML Language Server
-The Super CLI Tool offers **syntax checking** and **autoformatting** features for HTML files.
+The SuperHTML CLI Tool offers **validation** and **autoformatting** features for HTML files.
 
 The tool can be used either directly (for example by running it on save), or through a LSP client implementation.
 
@@ -12,45 +12,28 @@ $ superhtml
 Usage: superhtml COMMAND [OPTIONS]
 
 Commands:
-  check         Check documents for syntax errors
-  interface, i  Print a SuperHTML template's interface
-  fmt           Format documents
-  lsp           Start the Super LSP
-  help          Show this menu and exit
-  version       Print Super's version and exit
+  check         Check documents for errors.
+  fmt           Format documents.
+  lsp           Start the Language Server.
+  help          Show this menu and exit.
+  version       Print the version and exit.
 
 General Options:
-  --help, -h   Print command specific usage
+  --help, -h        Print command specific usage.
+  --syntax-only     Disable HTML element and attribute validation.
 ```
 
 >[!WARNING]
->SuperHTML currently only supports UTF8-encoded HTML and assumes HTML5 compliance (e.g. doesn't support XHTML, regardless of what you define the doctype to be).
+>SuperHTML only supports HTML5 (the WHATWG living spec) regardless of what you put in your doctype (a warning will be generated for unsupported doctypes).
 
 ### Diagnostics
+SuperHTML validates not only syntax but also element nesting and attribute values.
+No other language server implements the full HTML spec in its validation code.
 
-![](.github/vscode.png)
+![](.github/helix.png)
 
-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 snippet is correct HTML.
-
-```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 most probably a typo):
-
-```html
-<li>item<li>
-```
 
 ### Autoformatting
-![](.github/vscode-autoformat.gif)
-
 The autoformatter has two main ways of interacting with it in order to request for horizontal / vertical alignment.
 
 1. Adding / removing whitespace between the **start tag** of an element and its content.
@@ -83,45 +66,48 @@ After:
 <div><p>Foo</p></div>
 ```
 
-#### Example of rule #2
+### Example of rule #2
 Before:
 ```html
-<div foo="bar" style="verylongstring" >
+<div foo="bar" style="verylongstring" hidden>
     Foo
 </div>
 ```
 
 After:
 ```html
-<div
-   foo="bar"
-   style="verylongstring"
+<div foo="bar" 
+     style="verylongstring" 
+     hidden
 >
     Foo
 </div>
 ```
 
-##### Reverse
+#### Reverse
 
 Before:
 ```html
-<div
-   foo="bar"
-   style="verylongstring">
+<div foo="bar" 
+     style="verylongstring"
+     hidden>
     Foo
 </div>
 ```
 
 After:
 ```html
-<div foo="bar" style="verylongstring">
+<div foo="bar" style="verylongstring" hidden>
     Foo
 </div>
 ```
 
+### Download
+See the Releases section here on GitHub.
+
 ### Editor support
 #### VSCode
-Install the [Super HTML VSCode extension](https://marketplace.visualstudio.com/items?itemName=LorisCro.super).
+Install the [Super HTML VSCode extension](https://marketplace.visualstudio.com/items?itemName=LorisCro.super) (doesn't require the CLI tool as it bundles a WASM build of the language server).
 
 #### Neovim
 1. Download a prebuilt version of `superhtml` from the Releases section (or build it yourself).
@@ -161,30 +147,15 @@ Install the [Super HTML VSCode extension](https://marketplace.visualstudio.com/i
 		```
 
 #### Helix
-
 In versions later than `24.07` `superhtml` is supported out of the box, simply add executable to your `PATH`.
 
-For `24.07` and earlier, add to your `.config/helix/languages.toml`:
-```toml
-[language-server.superhtml-lsp]
-command = "superhtml"
-args = ["lsp"]
-
-[[language]]
-name = "html"
-scope = "source.html"
-roots = []
-file-types = ["html"]
-language-servers = [ "superhtml-lsp" ]
-```
-See https://helix-editor.com for more information on how to add new language servers.
 
 #### [Flow Control](https://github.com/neurocyte/flow)
 Already defaults to using SuperHTML, just add the executable to your `PATH`.
 
 #### Vim
-Vim should be able to parse the errors that `superhtml check [PATH]`. This
-means that you can use `:make` and the quickfix window to check for syntax
+Vim should be able to parse the errors that `superhtml check [PATH]` generates.
+This means that you can use `:make` and the quickfix window to check for syntax
 errors.
 
 Set the `makeprg` to the following in your .vimrc:
@@ -196,7 +167,6 @@ autocmd filetype html setlocal formatprg=superhtml\ fmt\ --stdin
 ```
 
 #### Zed
-
 See [WeetHet/superhtml-zed](https://github.com/WeetHet/superhtml-zed).
 
 #### Other editors
@@ -208,7 +178,7 @@ Follow your editor specific instructions on how to define a new Language Server
 SuperHTML is also a HTML templating language. More on that soon.
 
 ## Contributing
-SuperHTML tracks the latest Zig release (0.15.0-dev at the moment of writing).
+SuperHTML tracks the latest Zig release (0.15.1 at the moment of writing).
 
 ### Contributing to the HTML parser & LSP
 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:
@@ -217,10 +187,15 @@ Contributing to the HTML parser and LSP doesn't require you to be familiar with
 - `src/cli/`
 - `src/html/`
 
-In particular, you will care about `src/html/Tokenizer.zig` and `src/html/Ast.zig`.
+In particular, you will care about the source files under `src/html`.
+
+You can invoke `zig build test` to run all unit tests.
 
-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 SuperHTML CLI tool, allowing you to also then test the LSP behavior directly from your favorite editor.
 
-Running `zig build` will compile the Super CLI tool, allowing you to also then test the LSP behavior directly from your favorite editor.
+For testing within VSCode:
+1. Run `zig build wasm -p src/editors/vscode/wasm`
+2. Open `src/editors/vscode` in VSCode
+3. Start debugging.
 
-The LSP will log in your cache directory so you can `tail -f ~/.cache/super/super.log` to see what happens with the LSP.
+Debug builds will produce logs in your cache directory so you can `tail -f ~/.cache/superhtml.log`.

.github/vscode.png

@@ -109,7 +109,7 @@ fn setupCheckStep(
     const super_cli_check = b.addExecutable(.{
         .name = "superhtml",
         .root_module = b.createModule(.{
-            .root_source_file = b.path("src/cli.zig"),
+            .root_source_file = b.path("src/main.zig"),
             .target = target,
             .optimize = optimize,
         }),
@@ -155,7 +155,7 @@ fn setupCliTool(
     const super_cli = b.addExecutable(.{
         .name = "superhtml",
         .root_module = b.createModule(.{
-            .root_source_file = b.path("src/cli.zig"),
+            .root_source_file = b.path("src/main.zig"),
             .target = target,
             .optimize = optimize,
             .single_threaded = true,
@@ -257,7 +257,7 @@ fn setupReleaseStep(
         const super_exe_release = b.addExecutable(.{
             .name = "superhtml",
             .root_module = b.createModule(.{
-                .root_source_file = b.path("src/cli.zig"),
+                .root_source_file = b.path("src/main.zig"),
                 .target = release_target,
                 .optimize = .ReleaseFast,
             }),

README.md

@@ -1,6 +1,6 @@
 .{
     .name = .superhtml,
-    .version = "0.4.0",
+    .version = "0.6.0",
     .fingerprint = 0xc5e9aede3c1db363,
     .minimum_zig_version = "0.15.1",
     .dependencies = .{

build.zig

@@ -2,6 +2,23 @@
 
 All notable changes to the "super" extension will be documented in this file.
 
+## [v0.6.0]
+- All major Language Server features implemented: completions, clear diagnostics, descriptions, etc.
+- New diagnostics cover element nesting errors and attribute validation, including complex interactions between different attributes and elements.
+- Duplicate ID diagnostics that are `<template>` aware.
+- Rename symbol on a tag name will rename both start and end tags at once.
+- Find references can be used on class names to find other elements that have the same class.
+- New improved autoformatting that keeps the first attribute on the same line as the element:
+   - Uses tabs for indentation and spaces for alignment (experimental, might be reverted)
+   - Respects empty lines that delineate separate blocks.
+   - Doesn't format vertically elements in between text nodes anymore.
+   - Basic CSS and JS autoformatting.
+- Introduced a "Syntax Only Mode" setting to disable advanced validation for compatibility with templated HTML files.
+
+This is a huge jump forward bug reports (with repro instructions!) are appreciated.
+If you believe a diagnostic produced by SuperHTML to be wrong you are welcome to open an issue but
+you will be asked to reference the HTML spec to dissuade poorly researched, drive-by issues.
+
 ## [v0.5.3]
 - Fixes remaining bug when formatting void elements vertically.
 

build.zig.zon

@@ -1,36 +1,18 @@
 # SuperHTML VSCode LSP
-Language Server for HTML and SuperHTML Templates.
+Language Server for HTML.
 
-![](../../.github/vscode-autoformat.gif)
-
-
-# NOTE: This extension bundles the full language server
-
-But you can optionally also get the CLI tool so that you can access it outside of VSCode.
-For prebuilt binaries and more info: https://github.com/kristoff-it/superhtml
+# IMPORTANT: disable the builtin VSCode HTML extension!
+Due to a bug in VSCode's builtin HTML extension, SuperHTML cannot disable wrong
+end tag suggestions from VSCode automatically.
+You can still disable them manually by following [these instructions](https://github.com/kristoff-it/superhtml/issues/107).
 
 
 ## Diagnostics
+SuperHTML validates not only syntax but also element nesting and attribute values.
+No other language server implements the full HTML spec in its validation code.
 
 ![](../../.github/vscode.png)
 
-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.
-
-```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):
-
-```html
-<h1>Title<h1>
-```
 
 ## Autoformatting
 
@@ -39,6 +21,7 @@ The autoformatter has two main ways of interacting with it in order to request f
 1. Adding / removing whitespace between the **start tag** of an element and its content.
 2. Adding / removing whitespace between the **last attribute** of a start tag and the closing  `>`.
 
+Note that the autoformatter will never accept any configuration option. You are encouraged to add a `superhtml fmt --check` step to your CI to guarantee that you only commit normalized HTML files.
 
 ### Example of rule #1
 Before:
@@ -69,16 +52,16 @@ After:
 ### Example of rule #2
 Before:
 ```html
-<div foo="bar" style="verylongstring" >
+<div foo="bar" style="verylongstring" hidden>
     Foo
 </div>
 ```
 
 After:
 ```html
-<div 
-   foo="bar" 
-   style="verylongstring" 
+<div foo="bar" 
+     style="verylongstring" 
+     hidden
 >
     Foo
 </div>
@@ -88,17 +71,22 @@ After:
 
 Before:
 ```html
-<div 
-   foo="bar" 
-   style="verylongstring">
+<div foo="bar" 
+     style="verylongstring"
+     hidden>
     Foo
 </div>
 ```
 
 After:
 ```html
-<div foo="bar" style="verylongstring">
+<div foo="bar" style="verylongstring" hidden>
     Foo
 </div>
 ```
 
+## This extension bundles the full language server
+
+But you can optionally also get the CLI tool so that you can access it outside of VSCode.
+For prebuilt binaries and more info: https://github.com/kristoff-it/superhtml
+

editors/vscode/CHANGELOG.md

@@ -4,7 +4,7 @@
   "description": "Language Server for HTML and SuperHTML Templates.",
   "repository": "https://github.com/kristoff-it/superhtml/",
   "publisher": "LorisCro",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "engines": {
     "vscode": "^1.92.0"
   },
@@ -34,8 +34,7 @@
           "SuperHTML",
           "Super HTML",
           "superhtml",
-          "shtml",
-          "super"
+          "shtml"
         ],
         "extensions": [
           ".shtml"
@@ -76,6 +75,16 @@
       "type": "object",
       "title": "SuperHTML",
       "properties": {
+        "superhtml.SyntaxOnlyMode": {
+          "type": "boolean",
+          "default": false,
+          "description": "When enabled SuperHTML will not validate element nesting and attributes. Useful for dealing with templated HTML files, for example. (requires restart)"
+        },
+        "superhtml.EnsureBuiltinHTMLExtensionIsDisabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Ensure the VSCode builtin HTML extension is disabled (we ask because it generates wrong end tag suggestions, see https://github.com/kristoff-it/superhtml/issues/107)."
+        },
         "superhtml.trace.server": {
           "scope": "window",
           "type": "string",