yamllint/docs
Adrien Vergé ebd6b90d3e anchors: Add new rule to detect undeclared or duplicated anchors
According to the YAML specification [^1]:

- > It is an error for an alias node to use an anchor that does not
  > previously occur in the document.

  The `forbid-undeclared-aliases` option checks that aliases do have a
  matching anchor declared previously in the document. Since this is
  required by the YAML spec, this option is enabled by default.

- > The alias refers to the most recent preceding node having the same
  > anchor.

  This means that having a same anchor repeated in a document is
  allowed. However users could want to avoid this, so the new option
  `forbid-duplicated-anchors` allows that. It's disabled by default.

- > It is not an error to specify an anchor that is not used by any
  > alias node.

  This means that it's OK to declare anchors but don't have any alias
  referencing them. However users could want to avoid this, so a new
  option (e.g. `forbid-unused-anchors`) could be implemented in the
  future. See https://github.com/adrienverge/yamllint/pull/537.

Fixes #395
Closes #420

[^1]: https://yaml.org/spec/1.2.2/#71-alias-nodes
2023-03-22 10:34:35 +01:00
..
conf.py Remove Unicode marker before strings 2022-10-28 07:46:33 +02:00
configuration.rst cli: Add --list-files command line option 2023-01-10 18:48:38 +01:00
development.rst docs: Fix misleading Python API example 2023-01-30 18:04:51 +01:00
disable_with_comments.rst docs: Explicitly specify language even when it's plain text 2023-03-02 18:03:00 +01:00
index.rst Add documentation for pre-commit 2017-07-19 14:56:21 +02:00
integration.rst docs: Update pre-commit hook example 2023-03-22 10:31:20 +01:00
Makefile Doc: Generate documentation with Sphinx 2016-01-22 18:20:28 +01:00
quickstart.rst add OpenBSD installation instructions. 2019-07-09 10:04:48 +02:00
rules.rst anchors: Add new rule to detect undeclared or duplicated anchors 2023-03-22 10:34:35 +01:00
screenshot.png docs: Better compress PNG image 2022-08-05 08:43:55 +02:00
text_editors.rst docs: Update ALE vim plugin link 2022-08-05 18:57:21 +02:00