dev(ci): refactor commit linter
A new approach to make linter rules more flexible.
This commit is contained in:
Henrik Lissner
parent
f2588b0e90
commit
650f7a82e3
1 changed files with 220 additions and 162 deletions
382
core/cli/ci.el
382
core/cli/ci.el
|
|
@ -32,199 +32,257 @@
|
|||
;;; Git hooks
|
||||
|
||||
(defvar doom-cli-commit-rules
|
||||
(list (cons "^[^\n]\\{10,\\}$"
|
||||
"Subject is too short (<10) and should be more descriptive")
|
||||
(list (fn! (&key subject)
|
||||
(when (<= (length subject) 10)
|
||||
(cons 'error "Subject is too short (<10) and should be more descriptive")))
|
||||
|
||||
(cons "^\\(\\(revert\\|bump\\)!?: \\|[^\n]\\{,72\\}\\)$"
|
||||
"Subject too long; <=50 is ideal, 72 is max")
|
||||
(fn! (&key subject type)
|
||||
(unless (memq type '(bump revert))
|
||||
(let ((len (length subject)))
|
||||
(cond ((> len 50)
|
||||
(cons 'warning
|
||||
(format "Subject is %d characters; <=50 is ideal, 72 is max"
|
||||
len)))
|
||||
((> len 72)
|
||||
(cons 'error
|
||||
(format "Subject is %d characters; <=50 is ideal, 72 is max"
|
||||
len)))))))
|
||||
|
||||
(cons (concat
|
||||
"^\\("
|
||||
(regexp-opt
|
||||
'("bump" "dev" "docs" "feat" "fix" "merge" "module" "nit" "perf"
|
||||
"refactor" "release" "revert" "test" "tweak"))
|
||||
"\\)!?[^ :]*: ")
|
||||
"Invalid type")
|
||||
(fn! (&key type)
|
||||
(unless (memq type '(bump dev docs feat fix merge module nit perf
|
||||
refactor release revert test tweak))
|
||||
(cons 'error (format "Commit has an invalid type (%s)" type))))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (re-search-forward "^[^ :]+: " nil t)
|
||||
(and (looking-at "[A-Z][^-]")
|
||||
(not (looking-at "\\(SPC\\|TAB\\|ESC\\|LFD\\|DEL\\|RET\\)")))))
|
||||
"Do not capitalize the first word of the subject")
|
||||
(fn! (&key summary)
|
||||
(when (or (not (stringp summary))
|
||||
(string-blank-p summary))
|
||||
(cons 'error "Commit has no summary")))
|
||||
|
||||
(cons (lambda ()
|
||||
(looking-at "^\\(bump\\|revert\\|release\\|merge\\|module\\)!?([^)]+):"))
|
||||
"This type's scope goes after the colon, not before")
|
||||
(fn! (&key summary subject)
|
||||
(and (stringp summary)
|
||||
(string-match-p "^[A-Z][^-]" summary)
|
||||
(not (string-match-p "\\(SPC\\|TAB\\|ESC\\|LFD\\|DEL\\|RET\\)" summary))
|
||||
(cons 'error (format "%S in summary is capitalized; do not capitalize the summary"
|
||||
(car (split-string summary " "))))))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (looking-at "\\([^ :!(]\\)+!?(\\([^)]+\\)): ")
|
||||
(let ((type (match-string 1)))
|
||||
(or (member type '("bump" "revert" "merge" "module" "release"))
|
||||
(not
|
||||
(cl-loop
|
||||
with scopes =
|
||||
(cl-loop for path
|
||||
in (cdr (doom-module-load-path (list doom-modules-dir)))
|
||||
for (_category . module)
|
||||
= (doom-module-from-path path)
|
||||
collect (symbol-name module))
|
||||
with extra-scopes = '("cli")
|
||||
with regexp-scopes = '("^&")
|
||||
with type-scopes =
|
||||
(pcase type
|
||||
("docs"
|
||||
(cons "install"
|
||||
(mapcar #'file-name-base
|
||||
(doom-glob doom-docs-dir "[a-z]*.org")))))
|
||||
with scopes-re =
|
||||
(concat (string-join regexp-scopes "\\|")
|
||||
"\\|"
|
||||
(regexp-opt (append type-scopes extra-scopes scopes)))
|
||||
for scope in (split-string (match-string 2) ",")
|
||||
if (or (not (stringp scope))
|
||||
(string-match scopes-re scope))
|
||||
return t))))))
|
||||
"Invalid scope")
|
||||
(fn! (&key type scopes summary)
|
||||
(and (memq type '(bump revert release merge module))
|
||||
scopes
|
||||
(cons 'error
|
||||
(format "Scopes for %s commits should go after the colon, not before"
|
||||
type))))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (looking-at "\\([^ :!(]\\)+!?(\\([^)]+\\)): ")
|
||||
(let ((scopes (split-string (match-string 1) ",")))
|
||||
(not (equal scopes (sort scopes #'string-lessp))))))
|
||||
"Scopes not in lexical order")
|
||||
(fn! (&key type scopes)
|
||||
(unless (memq type '(bump revert merge module release))
|
||||
(cl-loop with scopes =
|
||||
(cl-loop for path
|
||||
in (cdr (doom-module-load-path (list doom-modules-dir)))
|
||||
for (_category . module)
|
||||
= (doom-module-from-path path)
|
||||
collect (symbol-name module))
|
||||
with extra-scopes = '("cli")
|
||||
with regexp-scopes = '("^&")
|
||||
with type-scopes =
|
||||
(pcase type
|
||||
(`docs
|
||||
(cons "install"
|
||||
(mapcar #'file-name-base
|
||||
(doom-glob doom-docs-dir "[a-z]*.org")))))
|
||||
with scopes-re =
|
||||
(concat (string-join regexp-scopes "\\|")
|
||||
"\\|"
|
||||
(regexp-opt (append type-scopes extra-scopes scopes)))
|
||||
for scope in scopes
|
||||
if (not (string-match scopes-re scope))
|
||||
collect scope into error-scopes
|
||||
finally return
|
||||
(when error-scopes
|
||||
(cons 'error (format "Commit has invalid scope(s): %s"
|
||||
error-scopes))))))
|
||||
|
||||
(cons (lambda ()
|
||||
(catch 'found
|
||||
(unless (looking-at "\\(bump\\|revert\\|merge\\)")
|
||||
(while (re-search-forward "^[^\n]\\{73,\\}" nil t)
|
||||
;; Exclude ref lines, bump lines, or lines with URLs
|
||||
(save-excursion
|
||||
(or (re-search-backward "^\\(Ref\\|Close\\|Fix\\|Revert\\) " nil t)
|
||||
(let ((bump-re "\\(https?://.+\\|[^/]+\\)/[^/]+@[a-z0-9]\\{12\\}"))
|
||||
(re-search-backward (format "^%s -> %s$" bump-re bump-re) nil t))
|
||||
(re-search-backward "https?://[^ ]+\\{73,\\}" nil t)
|
||||
(throw 'found t)))))))
|
||||
"Body line length exceeds 72 characters")
|
||||
(fn! (&key scopes)
|
||||
(unless (equal scopes (sort scopes #'string-lessp))
|
||||
(cons 'error "Scopes are not in lexicographical order")))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (looking-at "[^ :!(]+![(:]")
|
||||
(not (re-search-forward "^BREAKING CHANGE: .+" nil t))))
|
||||
"'!' present in type, but missing 'BREAKING CHANGE:' in body")
|
||||
(fn! (&key type body)
|
||||
(unless (memq type '(bump revert merge))
|
||||
(catch 'result
|
||||
(with-temp-buffer
|
||||
(save-excursion (insert body))
|
||||
(while (re-search-forward "^[^\n]\\{73,\\}" nil t)
|
||||
;; Exclude ref lines, bump lines, comments, lines with URLs,
|
||||
;; or indented lines
|
||||
(save-excursion
|
||||
(or (let ((bump-re "\\(https?://.+\\|[^/]+\\)/[^/]+@[a-z0-9]\\{12\\}"))
|
||||
(re-search-backward (format "^%s -> %s$" bump-re bump-re) nil t))
|
||||
(re-search-backward "https?://[^ ]+\\{73,\\}" nil t)
|
||||
(re-search-backward "^\\(?:#\\| +\\)" nil t)
|
||||
(throw 'result (cons 'error "Line(s) in commit body exceed 72 characters")))))))))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (looking-at "[^ :!]+\\(([^)])\\)?: ")
|
||||
(re-search-forward "^BREAKING CHANGE: .+" nil t)))
|
||||
"'BREAKING CHANGE:' present in body, but missing '!' in type")
|
||||
(fn! (&key bang body type)
|
||||
(if bang
|
||||
(cond ((not (string-match-p "^BREAKING CHANGE:" body))
|
||||
(cons 'error "'!' present in commit type, but missing 'BREAKING CHANGE:' in body"))
|
||||
((not (string-match-p "^BREAKING CHANGE: .+" body))
|
||||
(cons 'error "'BREAKING CHANGE:' present in commit body, but missing explanation")))
|
||||
(when (string-match-p "^BREAKING CHANGE:" body)
|
||||
(cons 'error (format "'BREAKING CHANGE:' present in body, but missing '!' after %S"
|
||||
type)))))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (re-search-forward "^BREAKING CHANGE:" nil t)
|
||||
(not (looking-at " [^\n]+"))))
|
||||
"'BREAKING CHANGE:' present in body, but empty")
|
||||
(fn! (&key type body)
|
||||
(and (eq type 'bump)
|
||||
(let ((bump-re "\\(?:https?://.+\\|[^/]+\\)/[^/]+@\\([a-z0-9]+\\)"))
|
||||
(not (string-match-p (concat "^" bump-re " -> " bump-re "$")
|
||||
body)))
|
||||
(cons 'error "Bump commit is missing commit hash diffs")))
|
||||
|
||||
(cons (lambda ()
|
||||
(when (looking-at "bump: ")
|
||||
(let ((bump-re "^\\(https?://.+\\|[^/]+\\)/[^/]+@[a-z0-9]\\{12\\}"))
|
||||
(re-search-forward (concat "^" bump-re " -> " bump-re "$")
|
||||
nil t))))
|
||||
"Bump commit doesn't contain commit diff")
|
||||
(fn! (&key body)
|
||||
(with-temp-buffer
|
||||
(insert body)
|
||||
(catch 'result
|
||||
(let ((bump-re "^\\(?:https?://.+\\|[^/]+\\)/[^/]+@\\([a-z0-9]+\\)"))
|
||||
(while (re-search-backward bump-re nil t)
|
||||
(when (/= (length (match-string 1)) 12)
|
||||
(throw 'result (cons 'error (format "Commit hash in %S must be 12 characters long"
|
||||
(match-string 0))))))))))
|
||||
|
||||
;; TODO Add bump validations for revert: type.
|
||||
|
||||
(cons (lambda ()
|
||||
(re-search-forward "^\\(\\(Fix\\|Clos\\|Revert\\)ed\\|Reference[sd]\\|Refs\\): "
|
||||
nil t))
|
||||
"Use present tense & imperative mood for references, and without a colon")
|
||||
(fn! (&key body)
|
||||
(when (string-match-p "^\\(\\(Fix\\|Clos\\|Revert\\)ed\\|Reference[sd]\\|Refs\\):? " body)
|
||||
(cons 'error "No present tense or imperative mood for a reference line")))
|
||||
|
||||
(cons (lambda ()
|
||||
(catch 'found
|
||||
(while (re-search-forward "^\\(?:Fix\\|Close\\|Revert\\|Ref\\) \\([^\n]+\\)$"
|
||||
nil t)
|
||||
(let ((ref (match-string 1)))
|
||||
(or (string-match "^\\(https?://.+\\|[^/]+/[^/]+\\)?\\(#[0-9]+\\|@[a-z0-9]+\\)" ref)
|
||||
(string-match "^https?://" ref)
|
||||
(and (string-match "^[a-z0-9]\\{12\\}$" ref)
|
||||
(= (car (doom-call-process "git" "show" ref))
|
||||
0))
|
||||
(throw 'found t))))))
|
||||
"Invalid footer reference (should be an issue, PR, URL, or commit)")
|
||||
(fn! (&key refs)
|
||||
(and (seq-filter (lambda (ref)
|
||||
(string-match-p "^\\(\\(Fix\\|Close\\|Revert\\)\\|Ref\\): " ref))
|
||||
refs)
|
||||
(cons 'error "Colon after reference line keyword; omit the colon on Fix, Close, Revert, and Ref lines")))
|
||||
|
||||
(fn! (&key refs)
|
||||
(catch 'found
|
||||
(dolist (line refs)
|
||||
(cl-destructuring-bind (type . ref) (split-string line " +")
|
||||
(setq ref (string-join ref " "))
|
||||
(or (string-match "^\\(https?://.+\\|[^/]+/[^/]+\\)?\\(#[0-9]+\\|@[a-z0-9]+\\)" ref)
|
||||
(string-match "^https?://" ref)
|
||||
(and (string-match "^[a-z0-9]\\{12\\}$" ref)
|
||||
(= (car (doom-call-process "git" "show" ref))
|
||||
0))
|
||||
(throw 'found
|
||||
(cons 'error
|
||||
(format "%S is not a valid issue/PR, URL, or 12-char commit hash"
|
||||
line))))))))
|
||||
|
||||
;; TODO Check that bump/revert SUBJECT list: 1) valid modules and 2)
|
||||
;; modules whose files are actually being touched.
|
||||
|
||||
;; TODO Ensure your diff corraborates your SCOPE
|
||||
|
||||
))
|
||||
|
||||
(defun doom-cli--ci-hook-commit-msg (file)
|
||||
(with-temp-buffer
|
||||
(insert-file-contents file)
|
||||
(let (errors)
|
||||
(dolist (rule doom-cli-commit-rules)
|
||||
(cl-destructuring-bind (pred . msg) rule
|
||||
(goto-char (point-min))
|
||||
(save-match-data
|
||||
(when (if (functionp pred)
|
||||
(funcall pred)
|
||||
(if (stringp pred)
|
||||
(not (re-search-forward pred nil t))
|
||||
(error "Invalid predicate: %S" pred)))
|
||||
(push msg errors)))))
|
||||
(when errors
|
||||
(print! (error "Your commit message failed to pass Doom's conventions, here's why:"))
|
||||
(dolist (error (reverse errors))
|
||||
(print-group! (print! (info error))))
|
||||
(terpri)
|
||||
(print! "See https://gist.github.com/hlissner/4d78e396acb897d9b2d8be07a103a854 for details")
|
||||
(throw 'exit 0))
|
||||
t)))
|
||||
(doom-cli--ci--lint
|
||||
(list (cons
|
||||
"CURRENT"
|
||||
(buffer-substring (point-min)
|
||||
(and (re-search-forward "^# Please enter the commit message" nil t)
|
||||
(match-beginning 0))))))))
|
||||
|
||||
|
||||
;;
|
||||
;;;
|
||||
|
||||
(defun doom-cli--ci-lint-commits (from &optional to)
|
||||
(defun doom-cli--ci--lint (commits)
|
||||
(let ((errors? 0)
|
||||
commits)
|
||||
(with-temp-buffer
|
||||
(insert
|
||||
(cdr (doom-call-process
|
||||
"git" "log"
|
||||
(format "%s..%s" from (or to "HEAD")))))
|
||||
(while (re-search-backward "^commit \\([a-z0-9]\\{40\\}\\)" nil t)
|
||||
(push (cons (match-string 1)
|
||||
(replace-regexp-in-string
|
||||
"^ " ""
|
||||
(save-excursion
|
||||
(buffer-substring-no-properties
|
||||
(search-forward "\n\n")
|
||||
(if (re-search-forward "\ncommit \\([a-z0-9]\\{40\\}\\)" nil t)
|
||||
(match-beginning 0)
|
||||
(point-max))))))
|
||||
commits)))
|
||||
(dolist (commit commits)
|
||||
(with-temp-buffer
|
||||
(let (errors)
|
||||
(save-excursion (insert (cdr commit)))
|
||||
(dolist (rule doom-cli-commit-rules)
|
||||
(save-excursion
|
||||
(save-match-data
|
||||
(cl-destructuring-bind (pred . msg) rule
|
||||
(and (cond ((functionp pred)
|
||||
(funcall pred))
|
||||
((stringp pred)
|
||||
(not (re-search-forward pred nil t)))
|
||||
((error "Invalid predicate: %S" pred)))
|
||||
(push msg errors))))))
|
||||
(if (not errors)
|
||||
(print! (success "Commit %s") (car commit))
|
||||
(warnings? 0))
|
||||
(print! (start "Linting %d commits" (length commits)))
|
||||
(print-group!
|
||||
(dolist (commit commits)
|
||||
(let (subject body refs summary type scopes bang refs errors warnings)
|
||||
(with-temp-buffer
|
||||
(save-excursion (insert (cdr commit)))
|
||||
(setq subject (buffer-substring (point-min) (line-end-position))
|
||||
body (buffer-substring
|
||||
(line-beginning-position 3)
|
||||
(save-excursion
|
||||
(or (and (re-search-forward (format "\n\n%s "
|
||||
(regexp-opt '("Co-authored-by:" "Signed-off-by:" "Fix" "Ref" "Close" "Revert")
|
||||
t))
|
||||
nil t)
|
||||
(match-beginning 1))
|
||||
(point-max))))
|
||||
refs (split-string
|
||||
(save-excursion
|
||||
(buffer-substring
|
||||
(or (and (re-search-forward (format "\n\n%s "
|
||||
(regexp-opt '("Co-authored-by:" "Signed-off-by:" "Fix" "Ref" "Close" "Revert")
|
||||
t))
|
||||
nil t)
|
||||
(match-beginning 1))
|
||||
(point-max))
|
||||
(point-max)))
|
||||
"\n" t))
|
||||
(save-match-data
|
||||
(when (looking-at "^\\([a-zA-Z0-9_-]+\\)\\(!?\\)\\(?:(\\([^)]+\\))\\)?: \\([^\n]+\\)")
|
||||
(setq type (intern (match-string 1))
|
||||
bang (equal (match-string 2) "!")
|
||||
scopes (ignore-errors (split-string (match-string 3) ","))
|
||||
summary (match-string 4)))))
|
||||
(dolist (fn doom-cli-commit-rules)
|
||||
(pcase (funcall fn
|
||||
:bang bang
|
||||
:body body
|
||||
:refs refs
|
||||
:scopes scopes
|
||||
:subject subject
|
||||
:summary summary
|
||||
:type type)
|
||||
(`(,type . ,msg)
|
||||
(push msg (if (eq type 'error) errors warnings)))))
|
||||
(if (and (null errors) (null warnings))
|
||||
(print! (success "%s %s") (substring (car commit) 0 7) subject)
|
||||
(print! (start "%s %s") (substring (car commit) 0 7) subject))
|
||||
(print-group!
|
||||
(when errors
|
||||
(cl-incf errors?)
|
||||
(print! (error "Commit %s") (car commit))
|
||||
(print-group!
|
||||
(print! "%S" (cdr commit))
|
||||
(dolist (e (reverse errors))
|
||||
(print! (error "%s" e))))))))
|
||||
(dolist (e (reverse errors))
|
||||
(print! (error "%s" e))))
|
||||
(when warnings
|
||||
(cl-incf warnings?)
|
||||
(dolist (e (reverse warnings))
|
||||
(print! (warn "%s" e))))))))
|
||||
(when (> warnings? 0)
|
||||
(print! (warn "Warnings: %d") errors?))
|
||||
(when (> errors? 0)
|
||||
(print! (error "Failures: %d") errors?))
|
||||
(if (not (or (> errors? 0) (> warnings? 0)))
|
||||
(print! (success "There were no issues!"))
|
||||
(terpri)
|
||||
(print! "%d commit(s) failed the linter" errors?)
|
||||
(terpri)
|
||||
(print! "See https://doomemacs.org/project.org#commit-message-formatting for details")
|
||||
(throw 'exit 1)))
|
||||
t)
|
||||
(print! "See https://docs.doomemacs.org/latest/#/developers/conventions/git-commits for details")
|
||||
(when (> errors? 0)
|
||||
(throw 'exit 1)))))
|
||||
|
||||
(defun doom-cli--ci--read-commits ()
|
||||
(let (commits)
|
||||
(while (re-search-backward "^commit \\([a-z0-9]\\{40\\}\\)" nil t)
|
||||
(push (cons (match-string 1)
|
||||
(replace-regexp-in-string
|
||||
"^ " ""
|
||||
(save-excursion
|
||||
(buffer-substring-no-properties
|
||||
(search-forward "\n\n")
|
||||
(if (re-search-forward "\ncommit \\([a-z0-9]\\{40\\}\\)" nil t)
|
||||
(match-beginning 0)
|
||||
(point-max))))))
|
||||
commits))
|
||||
commits))
|
||||
|
||||
(defun doom-cli--ci-lint-commits (from &optional to)
|
||||
(with-temp-buffer
|
||||
(insert
|
||||
(cdr (doom-call-process
|
||||
"git" "log"
|
||||
(format "%s..%s" from (or to "HEAD")))))
|
||||
(doom-cli--ci--lint (doom-cli--ci--read-commits))))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue