From 3c762a13bf0a8e15f2cf67d6a9eb27cf6d55267d Mon Sep 17 00:00:00 2001 From: Cyril Roelandt Date: Sat, 27 Sep 2014 23:24:12 +0200 Subject: [PATCH] guix lint: make sure synopses do not start with the package name. * guix/scripts/lint.scm (check-start-with-package-name): New method. * tests/lint.scm ("synopsis: start with package name"): New test. --- guix/scripts/lint.scm | 9 +++++++++ tests/lint.scm | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/guix/scripts/lint.scm b/guix/scripts/lint.scm index 3f0a8d4fc0e4ebe5b7957b1b7131a66a51db4cba..fd9fd7b93143fb95fc99e176fabf0ab220e82704 100644 --- a/guix/scripts/lint.scm +++ b/guix/scripts/lint.scm @@ -167,12 +167,21 @@ Run a set of checkers on the specified package; if none is specified, run the ch "synopsis should start with an upper-case letter" 'synopsis))) + (define (check-start-with-package-name synopsis) + (let ((idx (string-contains-ci synopsis (package-name package)))) + (when (and idx + (= idx 0)) + (emit-warning package + "synopsis should not start with the package name") + 'synopsis))) + (let ((synopsis (package-synopsis package))) (if (string? synopsis) (begin (check-synopsis-start-upper-case synopsis) (check-final-period synopsis) (check-start-article synopsis) + (check-start-with-package-name synopsis) (check-synopsis-length synopsis))))) (define (check-patches package) diff --git a/tests/lint.scm b/tests/lint.scm index c439faa30ee4a58938bcd8f2d56a9c55c5d2958c..62a9df90d89e6d350e7f917412f0418a087f81dd 100644 --- a/tests/lint.scm +++ b/tests/lint.scm @@ -124,6 +124,16 @@ (check-synopsis-style pkg)))) "synopsis should be less than 80 characters long"))) +(test-assert "synopsis: start with package name" + (->bool + (string-contains (call-with-warnings + (lambda () + (let ((pkg (dummy-package "x" + (name "foo") + (synopsis "foo, a nice package")))) + (check-synopsis-style pkg)))) + "synopsis should not start with the package name"))) + (test-assert "inputs: pkg-config is probably a native input" (->bool (string-contains