--- Begin Message ---
Subject: |
[PATCH] lint: Check for leading whitespace in description. |
Date: |
Sun, 20 Jun 2021 15:34:19 +0200 |
* 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(+)
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
--
2.31.1
--- End Message ---
--- Begin Message ---
Subject: |
Re: bug#49133: [PATCH] lint: Check for leading whitespace in description. |
Date: |
Tue, 13 Jul 2021 07:26:28 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) |
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.
--- End Message ---