[PATCH] lint: Add 'check-texinfo-markup' checker.

[PATCH] lint: Add 'check-texinfo-markup' checker.

[Mathieu Lirzin]

[-- Attachment #1: Type: text/plain, Size: 234 bytes --]


* guix/script/lint.scm (check-description-style): Check for invalid
  Texinfo markup.
* tests/lint.scm: Test it.
---
 guix/scripts/lint.scm | 8 ++++++++
 tests/lint.scm        | 7 +++++++
 2 files changed, 15 insertions(+)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lint-Add-check-texinfo-markup-checker.patch --]
[-- Type: text/x-patch; name="0001-lint-Add-check-texinfo-markup-checker.patch", Size: 1748 bytes --]

diff --git a/guix/scripts/lint.scm b/guix/scripts/lint.scm
index ab7d7c6..e8582cd 100644
--- a/guix/scripts/lint.scm
+++ b/guix/scripts/lint.scm
@@ -141,6 +141,13 @@ monad."
                     (_ "description should not be empty")
                     'description)))
 
+  (define (check-texinfo-markup package)
+    "Check that PACKAGE description can be parsed as a Texinfo fragment."
+    (catch 'parser-error
+      (lambda () (package-description-string package))
+      (lambda (keys . args)
+        (emit-warning package (_ "Texinfo markup in description is invalid")))))
+
   (define (check-proper-start description)
     (unless (or (properly-starts-sentence? description)
                 (string-prefix-ci? (package-name package) description))
@@ -170,6 +177,7 @@ by two spaces; possible infraction~p at ~{~a~^, ~}")
   (let ((description (package-description package)))
     (when (string? description)
       (check-not-empty description)
+      (check-texinfo-markup package)
       (check-proper-start description)
       (check-end-of-sentence-space description))))
 
diff --git a/tests/lint.scm b/tests/lint.scm
index 76040c1..3f8ae7a 100644
--- a/tests/lint.scm
+++ b/tests/lint.scm
@@ -142,6 +142,13 @@ requests."
                         (check-description-style pkg)))
                     "description should not be empty")))
 
+(test-assert "description: valid Texinfo markup"
+  (->bool
+   (string-contains
+    (with-warnings
+      (check-description-style (dummy-package "x" (description "f{oo}b@r"))))
+    "Texinfo markup in description is invalid")))
+
 (test-assert "description: does not start with an upper-case letter"
   (->bool
    (string-contains (with-warnings

Re: [PATCH] lint: Add 'check-texinfo-markup' checker.

[Ludovic Courtès]

Mathieu Lirzin <mthl@openmailbox.org> skribis:

> * guix/script/lint.scm (check-description-style): Check for invalid
>   Texinfo markup.
> * tests/lint.scm: Test it.

LGTM, thanks!

Ludo’.

Re: [PATCH] lint: Add 'check-texinfo-markup' checker.

[Ludovic Courtès]

Howdy!

I realized that it would be nice if, in ‘check-description-style’, all
the tests except ‘check-not-empty’ and ‘check-texinfo-markup’ would run
on the rendered but non-translated description (and of course, only if
the Texinfo markup is valid.)

WDYT?

In the same area, I think ‘check-proper-start’ should accept quotation
marks at the beginning.

(This came to mind as I wrote a description like this:
"@code{deferred.el} does foo bar".)

Ludo’.

Re: [PATCH] lint: Add 'check-texinfo-markup' checker.

[Mathieu Lirzin]

ludo@gnu.org (Ludovic Courtès) writes:

> I realized that it would be nice if, in ‘check-description-style’, all
> the tests except ‘check-not-empty’ and ‘check-texinfo-markup’ would run
> on the rendered but non-translated description (and of course, only if
> the Texinfo markup is valid.)
>
> WDYT?

It seems like a good idea.

> In the same area, I think ‘check-proper-start’ should accept quotation
> marks at the beginning.

> (This came to mind as I wrote a description like this:
> "@code{deferred.el} does foo bar".)

I will give it a try.  Thanks for the suggestions.

--
Mathieu Lirzin