Vale rule for long lines inside <screen/>

[tbazant]

Hi
i'm constructing a new rule that will detect lines inside Docbook's element that are longer than 80 characters.

I've successfully detected the starting version <screen>some long sentence and ending version some long sentence</screen> and one-liner <screen>some long sentence</screen>.

But if the content of the <screen/> element is multiline text, i dont know how to construct the rule, help much appreciated.

Here is the rule file https://github.com/openSUSE/suse-vale-styleguide/blob/e83b27903567c8cc69fc6a73617b05b0f7603000/docbook/LongScreen.yml

Here is the test file https://github.com/openSUSE/suse-vale-styleguide/blob/e83b27903567c8cc69fc6a73617b05b0f7603000/tests/LongScreen-bad.xml

The middle line of the following example should be matched as well

[napcs]

I would probably write this as a tengo script:

• Locate the screen tags with re_find
• Loop over what you find.
  • for each found,
    • split content into lines.
    • test each line's length
    • raise the message.

It'll get a little tricky tracking the current character position, but this is the only way I can think of doing this kind of check. I'm about to do this with code fences myself and this is how I'll aproach it.

This script from Grafana actually iterates over the whole file, so that might be another way to go.

https://github.com/grafana/writers-toolkit/blob/main/vale/Grafana/styles/config/scripts/Paragraphs.tengo

So, break file into lines.
For each line
Look for the tag.
If you find it then set a flag for "in code block"
if in code block
check line length
add match start and end if line is too long
check for tag
if found
set "in code block" flag to false

Hope that helps. I haven't written this yet but like I said, I need this for markdown.

[tbazant]

The following workes:

https://github.com/openSUSE/suse-vale-styleguide/blob/main/asciidoc/LongScreen.yml

and

https://github.com/openSUSE/suse-vale-styleguide/blob/main/docbook/LongScreen.yml

[napcs]

Awesome! thanks for sharing. Looks like I was reasonably close :D