feat: split "long code blocks" rule into suggestion and warning (#173)

* reduce "long codeblock" rule to 35 lines

* add suggestion rule for >25 lines

* expect blank line after MyST options

* match codeblock lines more carefully

* fix: 17a/b allow no blank line in MD after option block

---------

Co-authored-by: secondskoll <michael.park@canonical.com>

Author: dwilding

styles/Canonical/017-Avoid-long-code-blocks.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: "Use 25 or fewer lines in code blocks"
+link: https://docs.ubuntu.com/styleguide/en/#code-examples-in-documentation
+level: suggestion
+scope: raw
+nonword: true
+tokens:
+  - '``` ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!```)[^:\n][^\n]*\n(\n|(?!```)[^:\n][^\n]*\n){25,}```'
+  - '::: ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!:::)[^:\n][^\n]*\n(\n|(?!:::)[^:\n][^\n]*\n){25,}:::'
+  - '::\n\n(( {3}[^\n]+)?\n){25,} {3}[^\n]+\n'
+  - '\.\. (code-block|code|sourcecode)::( [^\n]+)?\n(( {3,12}:[^\n:]*:[^\n]*\n)*)?\n(( {3}[^\n]+)?\n){25,} {3}[^\n]+\n'

styles/Canonical/017a-Suggest-code-over-25-lines.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: "Use 35 or fewer lines in code blocks"
+link: https://docs.ubuntu.com/styleguide/en/#code-examples-in-documentation
+level: warning
+scope: raw
+nonword: true
+tokens:
+  - '``` ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!```)[^:\n][^\n]*\n(\n|(?!```)[^:\n][^\n]*\n){35,}```'
+  - '::: ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?){0.1}(?!:::)[^:\n][^\n]*\n(\n|(?!:::)[^:\n][^\n]*\n){35,}:::'
+  - '::\n\n(( {3}[^\n]+)?\n){35,} {3}[^\n]+\n'
+  - '\.\. (code-block|code|sourcecode)::( [^\n]+)?\n(( {3,12}:[^\n:]*:[^\n]*\n)*)?\n(( {3}[^\n]+)?\n){35,} {3}[^\n]+\n'