markdownlint VS yaml-rust

There are more linting tools that I won't go into deeply, but you can integrate them with lint-staged. For example, you can lint your CSS content with Stylelint, or even lint your README files with markdownlint, etc.

Some of Djot's features can be achieved by using markdownlint though: https://github.com/DavidAnson/markdownlint

markdownlint - A Node.js style checker and lint tool for Markdown/CommonMark files.

Improvements - The prefer-some-in-iteration rule will by default no longer flag iteration where a sub-attribute is used, like input[_].item - The use-in-operator rule has been extended to include more types of items, leading to better discovery of locations where in should be used - Remove replace directive in go.mod that made hard to integrate Regal as a library - The project now uses markdownlint to ensure consistent formatting of its documentation - The Go API now allows reading custom rules from an fs.FS filesystem

People are always looking for simple projects to learn Rust with, so here's one for anyone who's currently looking. Port markdownlint to Rust. Markdownlint is ~3.3k lines of JavaScript (including the lint implementation themselves!), so I reckon it's pretty doable.

The markdownlint VS Code extension is powered by the Node library of the same name. Its usage is quite similar to ESLint. It has a set of rules that can be configured, errors are highlighted, and you can automatically fix simple errors.

Markdown Lint

There are no compilers in the Flutter project that guarantee to find issues in README.md or CHANGELOG.md files. To remedy this, the Markdownlint plugin provides a set of guidelines to encourage Markdown file standards and uniformity. You can use this extension to check for problems locally and verify the content before publishing it live. Browse the user manual to learn more about rules.

Either https://github.com/chyh1990/yaml-rust or https://github.com/dtolnay/serde-yaml for parsing the YAML config file that markdownlint uses

Here's the Rust code so far -- the commented portions are my intent via pseudocode. This is part of an implementation where there's a _yaml_hash member that points to yaml_rust's underlying LinkedHashMap. (Also using anyhow's bail! and Result.)

The first thing I did was to find the crate yaml-rust and it seems it isn't really maintained anymore. It has not been updated in a year and there's a lot of PR's and unresolved issues, the CI is broken... So here is my open ended question.

Currently, my main concern with YAML is that, by the spec, comments are not attached to a particular node (see https://yaml.org/spec/1.2/spec.html#id2767100). As a result, a lot of YAML parsers (like https://github.com/yaml/libyaml and https://github.com/chyh1990/yaml-rust) only filter out the comments during the parsing phase. This makes it less than ideal for a use-case where the configuration file is expected to be modified by both programs and humans.

TOML makes it more trivial to associate comments with a node. This is mainly because the language is simpler though, as the spec is not explicit about that (https://github.com/chyh1990/yaml-rust).