me/guix
Archived
1
0
Fork 0
Code Activity

guix lint: check whether descriptions and synopses start with an upper-case letter.

Browse source 
* guix/scripts/lint.scm (check-description-style,
  check-synopsis-start-upper-case): New methods.
* tests/lint.scm ("description: does not start with an upper-case letter",
  "synopsis: does not start with an upper-case letter"): New tests.
This commit is contained in:
Cyril Roelandt 2014-09-27 23:00:44 +02:00
parent 5622953de1
commit 8202a51313
2 changed files with 44 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
guix/scripts/lint.scm
View file

@ -29,6 +29,7 @@
#:use-module (srfi srfi-11) #:use-module (srfi srfi-11)
#:use-module (srfi srfi-37) #:use-module (srfi srfi-37)
#:export (guix-lint #:export (guix-lint
check-description-style
check-inputs-should-be-native check-inputs-should-be-native
check-patches check-patches
check-synopsis-style)) check-synopsis-style))
@ -110,6 +111,19 @@ Run a set of checkers on the specified package; if none is specified, run the ch
%checkers) %checkers)
(exit 0)) (exit 0))
(define (start-with-capital-letter? s)
(char-set-contains? char-set:upper-case (string-ref s 0)))
(define (check-description-style package)
;; Emit a warning if stylistic issues are found in the description of PACKAGE.
(let ((description (package-description package)))
(when (and (string? description)
(not (string-null? description))
(not (start-with-capital-letter? description)))
(emit-warning package
"description should start with an upper-case letter"
'description))))
(define (check-inputs-should-be-native package) (define (check-inputs-should-be-native package)
;; Emit a warning if some inputs of PACKAGE are likely to belong to its ;; Emit a warning if some inputs of PACKAGE are likely to belong to its
;; native inputs. ;; native inputs.
@ -146,9 +160,17 @@ Run a set of checkers on the specified package; if none is specified, run the ch
"synopsis should be less than 80 characters long" "synopsis should be less than 80 characters long"
'synopsis))) 'synopsis)))
(define (check-synopsis-start-upper-case synopsis)
(when (and (not (string-null? synopsis))
(not (start-with-capital-letter? synopsis)))
(emit-warning package
"synopsis should start with an upper-case letter"
'synopsis)))
(let ((synopsis (package-synopsis package))) (let ((synopsis (package-synopsis package)))
(if (string? synopsis) (if (string? synopsis)
(begin (begin
(check-synopsis-start-upper-case synopsis)
(check-final-period synopsis) (check-final-period synopsis)
(check-start-article synopsis) (check-start-article synopsis)
(check-synopsis-length synopsis))))) (check-synopsis-length synopsis)))))
@ -175,6 +197,10 @@ Run a set of checkers on the specified package; if none is specified, run the ch
(define %checkers (define %checkers
(list (list
(lint-checker
(name "description")
(description "Validate package descriptions")
(check check-description-style))
(lint-checker (lint-checker
(name "inputs-should-be-native") (name "inputs-should-be-native")
(description "Identify inputs that should be native inputs") (description "Identify inputs that should be native inputs")

18
tests/lint.scm
View file

@ -44,6 +44,24 @@
(thunk)) (thunk))
(get-output-string port))) (get-output-string port)))
(test-assert "description: does not start with an upper-case letter"
(->bool
(string-contains (call-with-warnings
(lambda ()
(let ((pkg (dummy-package "x"
(description "bad description."))))
(check-description-style pkg))))
"description should start with an upper-case letter")))
(test-assert "synopsis: does not start with an upper-case letter"
(->bool
(string-contains (call-with-warnings
(lambda ()
(let ((pkg (dummy-package "x"
(synopsis "bad synopsis."))))
(check-synopsis-style pkg))))
"synopsis should start with an upper-case letter")))
(test-assert "synopsis: ends with a period" (test-assert "synopsis: ends with a period"
(->bool (->bool
(string-contains (call-with-warnings (string-contains (call-with-warnings