diff mbox series

[bug#49133] lint: Check for leading whitespace in description.

Message ID 20210620133419.15883-1-brice@waegenei.re
State Accepted
Headers show
Series [bug#49133] lint: Check for leading whitespace in description. | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch success View Laminar job
cbaines/issue success View issue

Commit Message

Brice Waegeneire June 20, 2021, 1:34 p.m. UTC 
* guix/lint.scm (check-description-style): Check for leading whitespace.
* tests/lint.scm: ("description: leading whitespace"): New test.
---
 guix/lint.scm  | 11 +++++++++++
 tests/lint.scm |  7 +++++++
 2 files changed, 18 insertions(+)

Comments

Mathieu Othacehe July 8, 2021, 2:10 p.m. UTC | #1 
Hey Brice,

> * guix/lint.scm (check-description-style): Check for leading whitespace.
> * tests/lint.scm: ("description: leading whitespace"): New test.

Looks fine,  you can go ahead.

Thanks,

Mathieu
Brice Waegeneire July 13, 2021, 5:26 a.m. UTC | #2 
Mathieu Othacehe <othacehe@gnu.org> writes:

>> * guix/lint.scm (check-description-style): Check for leading whitespace.
>> * tests/lint.scm: ("description: leading whitespace"): New test.
>
> Looks fine,  you can go ahead.

Thanks, pushed as edb328ad83bf55e021018719d24f7c29adc43a96.
diff mbox series

Patch

diff --git a/guix/lint.scm b/guix/lint.scm
index d65d5ce8f9..d18fcf920e 100644
--- a/guix/lint.scm
+++ b/guix/lint.scm
@@ -13,6 +13,7 @@ 
 ;;; Copyright © 2020 Timothy Sample <samplet@ngyro.com>
 ;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
 ;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
+;;; Copyright © 2021 Brice Waegeneire <brice@waegenei.re>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -300,6 +301,15 @@  by two spaces; possible infraction~p at ~{~a~^, ~}")
                                infractions)
                          #:field 'description)))))
 
+  (define (check-no-leading-whitespace description)
+    "Check that DESCRIPTION doesn't have trailing whitespace."
+    (if (string-prefix? " " description)
+        (list
+         (make-warning package
+                       (G_ "description contains leading whitespace")
+                       #:field 'description))
+        '()))
+
   (define (check-no-trailing-whitespace description)
     "Check that DESCRIPTION doesn't have trailing whitespace."
     (if (string-suffix? " " description)
@@ -318,6 +328,7 @@  by two spaces; possible infraction~p at ~{~a~^, ~}")
          ;; Use raw description for this because Texinfo rendering
          ;; automatically fixes end of sentence space.
          (check-end-of-sentence-space description)
+         (check-no-leading-whitespace description)
          (check-no-trailing-whitespace description)
          (match (check-texinfo-markup description)
            ((and warning (? lint-warning?)) (list warning))
diff --git a/tests/lint.scm b/tests/lint.scm
index fae346e724..dd442f6af9 100644
--- a/tests/lint.scm
+++ b/tests/lint.scm
@@ -160,6 +160,13 @@ 
                              (description "This is a 'quoted' thing."))))
      (check-description-style pkg))))
 
+(test-equal "description: leading whitespace"
+  "description contains leading whitespace"
+  (single-lint-warning-message
+   (let ((pkg (dummy-package "x"
+                              (description " Whitespace."))))
+     (check-description-style pkg))))
+
 (test-equal "description: trailing whitespace"
   "description contains trailing whitespace"
   (single-lint-warning-message