chore(deps): update dependency errata-ai/vale to v3.23.0 #365

Open
botaniker wants to merge 1 commit from renovate/errata-ai-vale-3.x into main
Member

This PR contains the following updates:

Package Update Change OpenSSF
errata-ai/vale minor v3.22.0 → v3.23.0 OpenSSF Scorecard

⚠️ Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

errata-ai/vale (errata-ai/vale)

v3.23.0

Compare Source

Vale 3.23.0 reads a Sphinx project as Sphinx does, reads the markup inside source-code comments, and reads large files in linear time.

Sphinx

Docutils knows only its own directives and roles, and dropped the body of every one it did not know, without a word: the prose in every versionadded, seealso, tab, or grid was never linted. Vale now decides the rest by a rule that fits nearly every Sphinx construct: the body of a directive Docutils doesn't define is prose, and the text of a role it doesn't define is code. A :ref: written with a title is linted as its title, and :func:, :class:, and :doc: are left alone. An extension's additions that don't fit the rule go in one section, which the reStructuredText and MyST readers both honor:

[sphinx]
CodeDirectives = mermaid, plantuml
ProseRoles = kbd, samp

Nothing needs Sphinx installed. reStructuredText also reads and writes UTF-8 whatever the console's code page, and the Docutils pool now works on Windows.

Docs: Sphinx

The markup inside comments

A tree-sitter View's per-scope type is honored, so a Rust /// comment is read as Markdown, a Python docstring as reStructuredText, and a Javadoc block as HTML, each with its fenced blocks and inline code skipped:

engine: tree-sitter
scopes:
  - expr: (line_comment)+ @comment
    type: md

Each language's documentation convention is understood on top of that: the name a Go doc comment opens with and its [links], rustdoc and KDoc links, Javadoc and JSDoc tags and @example blocks, and a docstring's :param: fields are not prose. A comment addressed to a tool, //go:build, //nolint, # noqa, eslint-disable, is not read at all. Kotlin and TOML have grammars.

Docs: Code Views, Documentation conventions

Comments in data files

A YAML or TOML file's comments are linted beside the fields its View selects, under the scopes a source file's comments carry, and a # inside a string is not a comment.

Docs: Data Views

Named scopes and metric variables

A scope can be written once in config/scopes/ and used by name in any rule, and doc(...) accepts Selectors Level 4, relative selectors in :has() included:


# styles/config/scopes/Methods.yml
scope: 'doc(section:has(> h2:contains("Methods")))'

A metric formula has the readability scores as variables, quote_words, sentence_length_sd, and round(). A quote scope reaches the text between quotation marks. A rule can carry its own tests:, and vale test --coverage lists the rules without any.

Docs: Named scopes, Selections, metric variables

The package version this Vale supports

vale sync installs the release of a package that the running Vale supports, from a releases manifest in its meta.json or from the package's release feed, so a style that uses a newer key never breaks an older Vale. Built-in rules honor [param] settings, and YES and NO read as booleans.

Docs: The version Vale supports

Formats
  • HTML: a page's <meta name="description"> is prose, <samp> is code, and a figure's caption and alt text are no longer skipped with the figure.
  • Org: #+TITLE: and #+AUTHOR: are prose, headline tags are not, and a footnote is reported where it is written.
  • QDoc: an \omit ... \endomit on one line ends there.
  • Plain text: a manuscript's chapters are headings, and metric rules see the file's summary.
  • MDX: a code fence after a one-line element stays out of the HTML block.
Changelog
  • 2753160 spelling: Read faster on large files, and read figures and inline QDoc omissions
  • 75c04b3 feat: Read a data file's comments beside its View, and a page's description
  • 0ea6b7a fix: Honor a code View's scope type, mask doc-comment conventions, drop directives, and read Org keywords and footnotes in place
  • 521deac fix: scalar settings reach the built-in rules, and YES and NO read as bools
  • f8a0142 fix(rst): run the spawned rst2html in Python's UTF-8 mode
  • f43fcfc docs: add discord
  • 062bf1d fix(rst): read and write UTF-8 whatever the console's code page
  • 9a19239 feat: sync installs the release this Vale supports
  • 27fa279 fix: give a plain-text file a summary, so metric rules and ls-metrics see it
  • 62d4da8 fix: pool Docutils on Windows, where rst2html is a launcher with no shebang
  • b66f827 fix(mdx): keep a code fence after a one-line element out of an HTML block (#​1194)
  • 559bfe1 feat: one [sphinx] section for reStructuredText and MyST
  • e435dab fix: place a script rule's matches by the block they index, not the file
  • 33087fe feat: read a plain-text manuscript's chapters, and measure speech and pace
  • 6ba35ce feat: read the body of a directive Docutils does not know as prose
  • 459d3cd feat: Selectors Level 4 in doc(...)
  • 0cc85df feat: named scopes, readability variables, and test coverage
  • cea3fcd fix: read a YAML file's comments through a tree-sitter View (#​1188)
  • 706f858 Merge branch 'pr-1192' into v3
  • 9bcf8d0 feat(code): add Kotlin comment extraction (#​1183)
  • 4bd1bc2 fix: place a paragraph that opens with inline content at its own text (#​1186)
  • b970c75 fix: place a match that wraps into an indented or quoted line (#​1185)
  • b9f2ee2 fix: locate a match past a multi-byte mask (#​1184) (#​1193)
  • 123e3f9 chore(deps): bump github.com/tomwright/dasel/v3 from 3.10.1 to 3.11.2 (#​1190)
  • 64d2aa2 ci: allow benchstat to select its required Go toolchain
  • 70f3c13 fix: place a summary-scoped alert on the prose it counted
  • 275cd4c fix: metric positions in sentence scope
  • cac1949 feat: allow metrics to report scoped locations
  • 90eaca4 fix: put a fragment file back before the raw scope runs (#​1182)
  • ba6a2c6 feat: add a quote scope for the text between quotation marks
  • 520962e fix: gather a leaf element's own text for a doc(...) selection on it
  • 0904d19 feat: accept a selector group at the top level of doc(...)
  • 86032fc fix: find a package directory whose case differs from the URL basename

Configuration

📅 Schedule: (UTC)

  • Branch creation
    • At any time (no schedule defined)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot. The local configuration can be found in the SI Renovate Bot repository.

This PR contains the following updates: | Package | Update | Change | OpenSSF | |---|---|---|---| | [errata-ai/vale](https://github.com/errata-ai/vale) | minor | `v3.22.0` → `v3.23.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/errata-ai/vale/badge)](https://securityscorecards.dev/viewer/?uri=github.com/errata-ai/vale) | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the [Dependency Dashboard](issues/30) for more information. --- ### Release Notes <details> <summary>errata-ai/vale (errata-ai/vale)</summary> ### [`v3.23.0`](https://github.com/vale-cli/vale/releases/tag/v3.23.0) [Compare Source](https://github.com/errata-ai/vale/compare/v3.22.0...v3.23.0) Vale 3.23.0 reads a Sphinx project as Sphinx does, reads the markup inside source-code comments, and reads large files in linear time. ##### Sphinx Docutils knows only its own directives and roles, and dropped the body of every one it did not know, without a word: the prose in every `versionadded`, `seealso`, `tab`, or `grid` was never linted. Vale now decides the rest by a rule that fits nearly every Sphinx construct: the body of a directive Docutils doesn't define is prose, and the text of a role it doesn't define is code. A `:ref:` written with a title is linted as its title, and `:func:`, `:class:`, and `:doc:` are left alone. An extension's additions that don't fit the rule go in one section, which the reStructuredText and MyST readers both honor: ```ini [sphinx] CodeDirectives = mermaid, plantuml ProseRoles = kbd, samp ``` Nothing needs Sphinx installed. reStructuredText also reads and writes UTF-8 whatever the console's code page, and the Docutils pool now works on Windows. Docs: [Sphinx](https://docs.vale.sh/formats/sphinx) ##### The markup inside comments A tree-sitter View's per-scope `type` is honored, so a Rust `///` comment is read as Markdown, a Python docstring as reStructuredText, and a Javadoc block as HTML, each with its fenced blocks and inline code skipped: ```yaml engine: tree-sitter scopes: - expr: (line_comment)+ @comment type: md ``` Each language's documentation convention is understood on top of that: the name a Go doc comment opens with and its `[links]`, rustdoc and KDoc links, Javadoc and JSDoc tags and `@example` blocks, and a docstring's `:param:` fields are not prose. A comment addressed to a tool, `//go:build`, `//nolint`, `# noqa`, `eslint-disable`, is not read at all. Kotlin and TOML have grammars. Docs: [Code Views](https://docs.vale.sh/topics/views#code), [Documentation conventions](https://docs.vale.sh/formats/code#documentation-conventions) ##### Comments in data files A YAML or TOML file's comments are linted beside the fields its View selects, under the scopes a source file's comments carry, and a `#` inside a string is not a comment. Docs: [Data Views](https://docs.vale.sh/topics/views#data) ##### Named scopes and metric variables A scope can be written once in `config/scopes/` and used by name in any rule, and `doc(...)` accepts Selectors Level 4, relative selectors in `:has()` included: ```yaml # styles/config/scopes/Methods.yml scope: 'doc(section:has(> h2:contains("Methods")))' ``` A `metric` formula has the readability scores as variables, `quote_words`, `sentence_length_sd`, and `round()`. A `quote` scope reaches the text between quotation marks. A rule can carry its own `tests:`, and `vale test --coverage` lists the rules without any. Docs: [Named scopes](https://docs.vale.sh/topics/scopes#named-scopes), [Selections](https://docs.vale.sh/topics/scopes#selections), [metric variables](https://docs.vale.sh/checks/metric#variables) ##### The package version this Vale supports `vale sync` installs the release of a package that the running Vale supports, from a `releases` manifest in its `meta.json` or from the package's release feed, so a style that uses a newer key never breaks an older Vale. Built-in rules honor `[param]` settings, and `YES` and `NO` read as booleans. Docs: [The version Vale supports](https://docs.vale.sh/keys/packages#the-version-vale-supports) ##### Formats - HTML: a page's `<meta name="description">` is prose, `<samp>` is code, and a figure's caption and alt text are no longer skipped with the figure. - Org: `#+TITLE:` and `#+AUTHOR:` are prose, headline tags are not, and a footnote is reported where it is written. - QDoc: an `\omit ... \endomit` on one line ends there. - Plain text: a manuscript's chapters are headings, and metric rules see the file's summary. - MDX: a code fence after a one-line element stays out of the HTML block. ##### Changelog - [`2753160`](https://github.com/errata-ai/vale/commit/2753160f) spelling: Read faster on large files, and read figures and inline QDoc omissions - [`75c04b3`](https://github.com/errata-ai/vale/commit/75c04b37) feat: Read a data file's comments beside its View, and a page's description - [`0ea6b7a`](https://github.com/errata-ai/vale/commit/0ea6b7a1) fix: Honor a code View's scope type, mask doc-comment conventions, drop directives, and read Org keywords and footnotes in place - [`521deac`](https://github.com/errata-ai/vale/commit/521deac8) fix: scalar settings reach the built-in rules, and YES and NO read as bools - [`f8a0142`](https://github.com/errata-ai/vale/commit/f8a01426) fix(rst): run the spawned rst2html in Python's UTF-8 mode - [`f43fcfc`](https://github.com/errata-ai/vale/commit/f43fcfc5) docs: add discord - [`062bf1d`](https://github.com/errata-ai/vale/commit/062bf1dc) fix(rst): read and write UTF-8 whatever the console's code page - [`9a19239`](https://github.com/errata-ai/vale/commit/9a192397) feat: sync installs the release this Vale supports - [`27fa279`](https://github.com/errata-ai/vale/commit/27fa279c) fix: give a plain-text file a summary, so metric rules and ls-metrics see it - [`62d4da8`](https://github.com/errata-ai/vale/commit/62d4da8e) fix: pool Docutils on Windows, where rst2html is a launcher with no shebang - [`b66f827`](https://github.com/errata-ai/vale/commit/b66f8276) fix(mdx): keep a code fence after a one-line element out of an HTML block ([#&#8203;1194](https://github.com/errata-ai/vale/issues/1194)) - [`559bfe1`](https://github.com/errata-ai/vale/commit/559bfe17) feat: one \[sphinx] section for reStructuredText and MyST - [`e435dab`](https://github.com/errata-ai/vale/commit/e435dab9) fix: place a script rule's matches by the block they index, not the file - [`33087fe`](https://github.com/errata-ai/vale/commit/33087fea) feat: read a plain-text manuscript's chapters, and measure speech and pace - [`6ba35ce`](https://github.com/errata-ai/vale/commit/6ba35ce8) feat: read the body of a directive Docutils does not know as prose - [`459d3cd`](https://github.com/errata-ai/vale/commit/459d3cda) feat: Selectors Level 4 in doc(...) - [`0cc85df`](https://github.com/errata-ai/vale/commit/0cc85df7) feat: named scopes, readability variables, and test coverage - [`cea3fcd`](https://github.com/errata-ai/vale/commit/cea3fcdd) fix: read a YAML file's comments through a tree-sitter View ([#&#8203;1188](https://github.com/errata-ai/vale/issues/1188)) - [`706f858`](https://github.com/errata-ai/vale/commit/706f8582) Merge branch 'pr-1192' into v3 - [`9bcf8d0`](https://github.com/errata-ai/vale/commit/9bcf8d08) feat(code): add Kotlin comment extraction ([#&#8203;1183](https://github.com/errata-ai/vale/issues/1183)) - [`4bd1bc2`](https://github.com/errata-ai/vale/commit/4bd1bc25) fix: place a paragraph that opens with inline content at its own text ([#&#8203;1186](https://github.com/errata-ai/vale/issues/1186)) - [`b970c75`](https://github.com/errata-ai/vale/commit/b970c752) fix: place a match that wraps into an indented or quoted line ([#&#8203;1185](https://github.com/errata-ai/vale/issues/1185)) - [`b9f2ee2`](https://github.com/errata-ai/vale/commit/b9f2ee29) fix: locate a match past a multi-byte mask ([#&#8203;1184](https://github.com/errata-ai/vale/issues/1184)) ([#&#8203;1193](https://github.com/errata-ai/vale/issues/1193)) - [`123e3f9`](https://github.com/errata-ai/vale/commit/123e3f98) chore(deps): bump github.com/tomwright/dasel/v3 from 3.10.1 to 3.11.2 ([#&#8203;1190](https://github.com/errata-ai/vale/issues/1190)) - [`64d2aa2`](https://github.com/errata-ai/vale/commit/64d2aa2c) ci: allow benchstat to select its required Go toolchain - [`70f3c13`](https://github.com/errata-ai/vale/commit/70f3c136) fix: place a summary-scoped alert on the prose it counted - [`275cd4c`](https://github.com/errata-ai/vale/commit/275cd4c7) fix: metric positions in sentence scope - [`cac1949`](https://github.com/errata-ai/vale/commit/cac1949c) feat: allow metrics to report scoped locations - [`90eaca4`](https://github.com/errata-ai/vale/commit/90eaca41) fix: put a fragment file back before the raw scope runs ([#&#8203;1182](https://github.com/errata-ai/vale/issues/1182)) - [`ba6a2c6`](https://github.com/errata-ai/vale/commit/ba6a2c6a) feat: add a quote scope for the text between quotation marks - [`520962e`](https://github.com/errata-ai/vale/commit/520962ef) fix: gather a leaf element's own text for a doc(...) selection on it - [`0904d19`](https://github.com/errata-ai/vale/commit/0904d198) feat: accept a selector group at the top level of doc(...) - [`86032fc`](https://github.com/errata-ai/vale/commit/86032fc9) fix: find a package directory whose case differs from the URL basename </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). The local configuration can be found in the [SI Renovate Bot repository](https://git.shivering-isles.com/shivering-isles/infrastructure-gitops/src/branch/main/apps/k8s01/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC41MC4yIiwidXBkYXRlZEluVmVyIjoiNDQuNTAuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->
Some required checks are missing.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin renovate/errata-ai-vale-3.x:renovate/errata-ai-vale-3.x
git switch renovate/errata-ai-vale-3.x
Sign in to join this conversation.
No reviewers
No labels
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
shivering-isles/infrastructure-gitops!365
No description provided.