Add package documentation
[sheep] / src / main / pkg.lisp
1 (in-package #:docgen-pkg)
2
3 (defun fire-error (msg) (error (make-instance 'docgen:validation-failure :msg msg)))
4
5 (defun doc->ast (pkg)
6  (labels
7   ((validate (strs)
8     (mapcar
9      (lambda (str)
10       (cond
11        ((< 120 (length str)) (fire-error (format nil "Package description longer than 120 characters: ~A" str)))
12        ((cl-ppcre:scan "^ " str) (fire-error (format nil "Package description line started with space: ~A" str)))
13        ((cl-ppcre:scan " $" str) (fire-error (format nil "Package description line ended with space: ~A" str)))))
14      strs))
15    (combine (strs)
16     (cond
17      ((not strs) (list ""))
18      ((string= "" (car strs)) (cons "" (combine (cdr strs))))
19      (t
20       (let
21        ((rest (combine (cdr strs))))
22        (cons (format nil "~A~A~A" (car strs) (if (string/= "" (car rest)) " " "") (car rest)) (cdr rest)))))))
23   (let
24    ((lines (cl-ppcre:split "\\n" (documentation pkg t))))
25    (validate lines)
26    (let
27     ((paragraphs (combine lines)))
28     (when (< 120 (length (first paragraphs))) (fire-error "First package paragraph is longer than 120 characters"))
29     (when (find "" paragraphs :test #'string=) (fire-error "Package description has two empty lines in it"))
30     (cons (package-name pkg) paragraphs)))))
31
32 (defun ast->md (ast)
33  (format nil "# Package ~A~%~%~{~A~^~%~%~}"
34   (car ast)
35   (cdr ast)))