-
-
Notifications
You must be signed in to change notification settings - Fork 33
/
package-lint.el
1311 lines (1176 loc) · 56.7 KB
/
package-lint.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; package-lint.el --- A linting library for elisp package authors -*- lexical-binding: t -*-
;; Copyright (C) 2014-2020 Steve Purcell, Fanael Linithien
;; Author: Steve Purcell <steve@sanityinc.com>
;; Fanael Linithien <fanael4@gmail.com>
;; URL: https://github.com/purcell/package-lint
;; Keywords: lisp
;; Version: 0
;; Package-Requires: ((cl-lib "0.5") (emacs "24.1") (let-alist "1.0.6"))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Provides a list of issues with the package metadata of a file,
;; e.g. the package dependencies it requires.
;; See function `package-lint-buffer'.
;; Checks will currently be enabled only if a "Package-Requires:" or
;; "Package-Version:" header is present in the file.
;;; Code:
(eval-when-compile (require 'pcase)) ; `pcase-dolist' is not autoloaded
(require 'cl-lib)
(require 'package)
(require 'lisp-mnt)
(require 'finder)
(require 'imenu)
(require 'let-alist)
(require 'rx)
(defvar package-lint-main-file nil
"For multi-file packages, set this to the main .el or -pkg.el file.
When set, the package prefix and dependencies are obtained from
that file instead of the buffer being linted. This allows
package-lint to operate on secondary files in a package.
The path can be absolute or relative to that of the linted file.")
(put 'package-lint-main-file 'safe-local-variable #'stringp)
;;; Compatibility
(defalias 'package-lint--package-desc-summary
(if (fboundp 'package-desc-summary)
'package-desc-summary
'package-desc-doc))
(defalias 'package-lint--package-desc-name
(if (fboundp 'package-desc-name)
'package-desc-name
(lambda (desc) (intern (elt desc 0)))))
(defalias 'package-lint--package-desc-from-define
(if (fboundp 'package-desc-from-define)
'package-desc-from-define
(lambda (_name-string version-string &optional docstring requirements &rest _args)
(vector
(version-to-list version-string)
(mapcar
(lambda (x)
(list (nth 0 x) (version-to-list (nth 1 x))))
(nth 1 requirements))
docstring))))
;;; Machinery
(defvar package-lint--errors nil
"List of errors and warnings for the current buffer.
This is bound dynamically while the checks run.")
(defconst package-lint-emacs-head-version '(29)
"Version of Emacs HEAD.")
(defconst package-lint-backport-libraries
(list (list 'cl-lib "\\`cl-")
(list 'cl-generic "\\`cl-\\(?:def\\)?generic")
(list 'cl-print "\\`cl-print")
(list 'jsonrpc "\\`jsonrpc-")
(list 'map "\\`map-")
(list 'nadvice "\\`advice-")
(list 'ol "\\`org-link-" 'org "9.3")
(list 'seq "\\`seq-")
(list 'transient "\\`transient-")
(list 'hierarchy "\\`hierarchy-")
(list 'let-alist "\\`let-alist"))
"A sequence of (FEATURE SYMBOL-NAME-MATCH) for backport libraries.
These are libraries that are built into newer Emacsen and also
published in ELPA for use by older Emacsen.
Alternatively, items can take a form of (FEATURE
SYMBOL-NAME-MATCH PACKAGE VERSION?) where PACKAGE is the name of
a backport library shipping the feature and VERSION is an
optional minimum version containing the feature.")
(defconst package-lint-symbol-info
(let* ((stdlib-changes (with-temp-buffer
(insert-file-contents
(expand-file-name "data/stdlib-changes"
(if load-file-name
(file-name-directory load-file-name)
default-directory)))
(read (current-buffer))))
(info (make-hash-table)))
(pcase-dolist (`(,version . ,data) stdlib-changes)
(pcase-dolist (`(,syms . ,action)
(let-alist data
(list (cons .variables.added 'variable-added)
(cons .variables.removed 'variable-removed)
(cons .features.added 'library-added)
(cons .features.removed 'library-removed)
(cons .functions.added 'function-added)
(cons .functions.removed 'function-removed))))
(dolist (sym syms)
(puthash sym (cons (cons action version) (gethash sym info)) info))))
info)
"A hash table from SYMBOL to a list of events in its history.
Each event is of the form (ACTION . EMACS-VER), where ACTION is a
symbol such as `variable-added'.")
(defun package-lint-symbol-info (sym)
"Retrieve information about SYM, as an alist of (ACTION . EMACS-VER)."
(gethash (cl-etypecase sym
(string (intern sym))
(symbol sym))
package-lint-symbol-info))
(defun package-lint--read-known-symbol (prompt)
"Read a symbol `package-lint-symbol-info' with PROMPT."
(let* ((at-point (symbol-at-point))
(s (completing-read
prompt
(cl-loop for k being the hash-keys of package-lint-symbol-info collect k)
nil
t
(when at-point (symbol-name at-point)))))
(when s (intern s))))
;;;###autoload
(defun package-lint-describe-symbol-history (sym)
"Show the version history of SYM, if any."
(interactive (list (package-lint--read-known-symbol "Show history of symbol: ")))
(message
(concat (format "History of %s:\n" sym)
(mapconcat (lambda (info)
(pcase-let ((`(,action . ,version) info))
(format "* %s in Emacs %s"
action (mapconcat 'number-to-string version "."))))
(sort (package-lint-symbol-info sym)
(lambda (a b) (version-list-<= (cdr a) (cdr b))))
"\n"))))
(defun package-lint--added-or-removed-function-p (sym)
"Return t if SYM is a function added/removed in any known Emacs version."
(let-alist (package-lint-symbol-info sym)
(or .function-added .function-removed)))
(defconst package-lint--sane-prefixes
(rx
string-start
(or
"org-dblock-write:"
"org-babel-execute:"
"org-babel-prep-session:"
"org-babel-variable-assignments:"
"org-babel-default-header-args:"
"pcomplete/"))
"A regexp matching whitelisted non-standard symbol prefixes.")
(defvar package-lint--allowed-prefix-mappings
'(("ob-" . ("org-"))
("oc-" . ("org-"))
("ol-" . ("org-"))
("ox-" . ("org-")))
"Alist containing mappings of package prefixes to symbol prefixes.")
(defun package-lint--main-file-p ()
"Return non-nil if the current buffer corresponds to the package's main file."
(or (null package-lint-main-file)
(null (buffer-file-name))
(string= (file-truename (expand-file-name package-lint-main-file))
(file-truename (buffer-file-name)))))
(defun package-lint--check-all ()
"Return a list of errors/warnings for the current buffer."
(let ((package-lint--errors '())
(case-fold-search nil))
(save-match-data
(save-excursion
(save-restriction
(widen)
(let (prefix deps)
(if (package-lint--main-file-p)
(progn
;; TODO: handle when the main file is a -pkg.el file
(setq prefix (package-lint--get-package-prefix))
(let ((desc (package-lint--check-package-el-can-parse)))
(when desc
(package-lint--check-package-summary desc)
(package-lint--check-provide-form desc)
(package-lint--check-no-emacs-in-package-name desc)))
(setq deps (package-lint--check-dependency-list))
(package-lint--check-url-header)
(package-lint--check-package-version-present)
(package-lint--check-commentary-existence))
;; Need to look at the main file to find prefix and dependencies
(setq prefix (replace-regexp-in-string
"\\(-mode\\)?\\(-pkg\\)?\\'" ""
(file-name-sans-extension
(file-name-nondirectory package-lint-main-file))))
(let ((main-file package-lint-main-file))
(if (string-match-p "-pkg\\.el\\'" main-file)
(let ((expr (with-temp-buffer
(insert-file-contents (expand-file-name main-file))
(read (current-buffer)))))
(if (eq (car-safe expr) 'define-package)
(setq deps (package-desc-reqs (apply #'package-lint--package-desc-from-define (cdr expr))))
(package-lint--error-at-bob 'error (format "Malformed package descriptor file \"%s\"" main-file))))
(when (package-lint--goto-header "Package-Requires")
(package-lint--error-at-bol 'error "Package-Requires outside the main file have no effect."))
(package-lint--check-provide-form-secondary-file)
(condition-case err
(with-temp-buffer
(insert-file-contents (expand-file-name main-file))
(setq deps (package-desc-reqs (package-lint--liberal-package-buffer-info))))
(error
(package-lint--error-at-bob
'error
(format "Error parsing main package file \"%s\": %s" main-file err)))))))
;; Source code checks
(package-lint--check-keywords-list)
(package-lint--check-lexical-binding-is-on-first-line)
(package-lint--check-reserved-keybindings)
(when prefix
(package-lint--check-objects-by-regexp
(concat "(" (regexp-opt '("defalias" "defvaralias")) "\\s-")
(apply-partially #'package-lint--check-defalias prefix)))
(package-lint--check-objects-by-regexp
"(define-minor-mode\\s-"
#'package-lint--check-minor-mode)
(package-lint--check-objects-by-regexp
"(define-global\\(?:ized\\)?-minor-mode\\s-"
#'package-lint--check-globalized-minor-mode)
(package-lint--check-objects-by-regexp
"(defgroup\\s-" #'package-lint--check-defgroup)
(package-lint--check-no-use-of-cl)
(package-lint--check-no-use-of-cl-lib-sublibraries)
(package-lint--check-eval-after-load)
(package-lint--check-lexical-binding-requires-emacs-24 deps)
(package-lint--check-libraries-available-in-emacs deps)
(package-lint--check-libraries-removed-from-emacs)
(package-lint--check-macros-functions-available-in-emacs deps)
(package-lint--check-macros-functions-removed-from-emacs deps)
(package-lint--check-objects-by-regexp
(concat "(" (regexp-opt '("format" "message" "error")) "\\s-")
(apply-partially #'package-lint--check-format-string deps))
(package-lint--check-for-literal-emacs-path)
(let ((definitions (package-lint--get-defs)))
(package-lint--check-autoloads-on-private-functions definitions)
(when prefix
(package-lint--check-defs-prefix prefix definitions))
(package-lint--check-symbol-separators definitions)))
(package-lint--check-lonely-parens))))
(sort package-lint--errors
(lambda (a b)
(pcase-let ((`(,a-line ,a-column ,_ ,a-message) a)
(`(,b-line ,b-column ,_ ,b-message) b))
(cond
((/= a-line b-line) (< a-line b-line))
((/= a-column b-column) (< a-column b-column))
(t
(string-lessp a-message b-message))))))))
(defun package-lint--error (line col type message)
"Construct a datum for error at LINE and COL with TYPE and MESSAGE."
(push (list line col type message) package-lint--errors))
(defun package-lint--error-at-point (type message &optional pos)
"Construct a datum for error at POS with TYPE and MESSAGE.
POS defaults to `point'."
(save-excursion
(when pos
(goto-char pos))
(package-lint--error (line-number-at-pos) (- (point) (line-beginning-position)) type message)))
(defun package-lint--error-at-bol (type message)
"Construct an error at the beginning of the current line with TYPE and MESSAGE."
(package-lint--error (line-number-at-pos) 0 type message))
(defun package-lint--error-at-bob (type message)
"Construct an error at the beginning of the buffer with TYPE and MESSAGE."
(package-lint--error 1 0 type message))
;;; Checks
(defun package-lint--check-reserved-keybindings ()
"Warn about reserved keybindings."
(let ((re (rx "(" (*? space) (or "kbd" "global-set-key" "local-set-key" "define-key") symbol-end)))
(goto-char (point-min))
(while (re-search-forward re nil t)
(unless (nth 8 (save-match-data (syntax-ppss)))
;; Read form and get key-sequence
(goto-char (match-beginning 0))
(let ((seq (package-lint--extract-key-sequence
(read (current-buffer)))))
(when seq
(let ((message (package-lint--test-keyseq seq)))
(when message
(package-lint--error-at-point 'error message)))))))))
(defun package-lint--check-commentary-existence ()
"Warn about nonexistent or empty commentary section."
(let ((start (lm-commentary-start)))
(if (null start)
(package-lint--error-at-bob
'error
"Package should have a ;;; Commentary section.")
;; Skip over the section header.
(goto-char start)
(forward-line)
(when (package-lint--region-empty-p (point) (lm-commentary-end))
(package-lint--error-at-point
'error
"Package should have a non-empty ;;; Commentary section."
start)))))
(defun package-lint--check-autoloads-on-private-functions (definitions)
"Verify that private functions DEFINITIONS don't have autoload cookies."
(pcase-dolist (`(,symbol . ,position) definitions)
(when (string-match-p (rx "--") symbol)
(goto-char position)
(forward-line -1)
(when (looking-at-p (rx ";;;###autoload"))
(package-lint--error-at-point
'warning
"Private functions generally should not be autoloaded.")))))
(defun package-lint--check-for-literal-emacs-path ()
"Verify package does not refer to \"\.emacs\.d\" literally.
Instead it should use `user-emacs-directory' or `locate-user-emacs-file'."
(goto-char (point-min))
;; \b won't find a word boundary between a symbol and the "." in
;; ".emacs.d". / is a valid symbol constituent in Emacs Lisp, so
;; must be explicitly blacklisted.
(while (re-search-forward "\\(?:\\_<\\|/\\)\\.emacs\\.d\\b" nil t)
(unless (nth 4 (syntax-ppss))
;; Not in a comment
(package-lint--error-at-point
'warning
"Use variable `user-emacs-directory' or function `locate-user-emacs-file' instead of a literal path to the Emacs user directory or files."))))
(defun package-lint--check-keywords-list ()
"Verify that package keywords are listed in `finder-known-keywords'."
(when (package-lint--goto-header "Keywords")
(let ((err-pos (match-beginning 2)))
(let ((keywords (lm-keywords-list)))
(unless (cl-some (lambda (keyword) (assoc (intern keyword) finder-known-keywords)) keywords)
(package-lint--error-at-point
'warning
(format "You should include standard keywords: see the variable `finder-known-keywords'.")
err-pos))))))
(defun package-lint--check-url-header ()
"Verify that the package has an HTTPS or HTTP Homepage/URL header."
(if (package-lint--goto-header "\\(?:URL\\|Homepage\\)")
(let ((url (match-string 3))
(url-start (match-beginning 3)))
(unless (and (equal (thing-at-point 'url) url)
(string-match-p "^https?://" url))
(package-lint--error-at-point
'error
"Package URLs should be a single HTTPS or HTTP URL."
url-start)))
(package-lint--error-at-bob
'error
"Package should have a Homepage or URL header.")))
(defun package-lint--check-dependency-list ()
"Check the contents of the \"Package-Requires\" header.
Return a list of well-formed dependencies, same as
`package-lint--check-well-formed-dependencies'."
(when (package-lint--goto-header "Package-Requires")
(let ((position (match-beginning 3))
(deps (match-string 3)))
(condition-case err
(pcase-let ((`(,parsed-deps . ,parse-end-pos) (read-from-string deps)))
(unless (= parse-end-pos (length deps))
(package-lint--error-at-bol
'error
"More than one expression provided."))
(let ((deps (package-lint--check-well-formed-dependencies position parsed-deps)))
(package-lint--check-emacs-version deps)
(package-lint--check-packages-installable deps)
(package-lint--check-deps-use-non-snapshot-version deps)
(package-lint--check-deps-do-not-use-zero-versions deps)
(package-lint--check-cl-lib-version deps)
deps))
(error
(package-lint--error-at-bol
'error
(format "Couldn't parse \"Package-Requires\" header: %s" (error-message-string err)))
nil)))))
(defun package-lint--check-well-formed-dependencies (position parsed-deps)
"Check that dependencies listed at POSITION are well-formed.
These PARSED-DEPS must have the format (name \"version\").
Return a list of well-formed dependencies, where each element is of
the form (PACKAGE-NAME PACKAGE-VERSION DEP-POSITION)."
(let (valid-deps)
(dolist (entry parsed-deps)
(pcase entry
((or (and `(,package-name ,package-version)
(guard (symbolp package-name))
(guard (stringp package-version)))
(and `(,package-name)
(guard (symbolp package-name)))
(and package-name
(guard (symbolp package-name))))
;; Find the column at which the dependency is declared so we can
;; properly report the position of errors.
(let ((dep-pos
(save-excursion
(goto-char position)
(let* ((symbol-pattern
(format "\\(%s\\)"
(regexp-quote (symbol-name package-name))))
(list-pattern
(format "( *%s\\(?:[^[:alnum:]_\\-].*?\\)?)"
symbol-pattern)))
(if (or (re-search-forward list-pattern (line-end-position) t)
(re-search-forward symbol-pattern (line-end-position) t))
(match-beginning 1)
position)))))
(unless package-version
(setq package-version "0"))
(if (ignore-errors (version-to-list package-version))
(push (list package-name
(version-to-list package-version)
dep-pos)
valid-deps)
(package-lint--error-at-point
'error
(format "%S is not a valid version string: see `version-to-list'."
package-version)
dep-pos))))
(_
(package-lint--error-at-bol
'error
(format "Expected (package-name \"version-num\"), but found %S." entry)))))
valid-deps))
(defun package-lint--check-package-installable (archive-entry package-version dep-pos)
"Check that ARCHIVE-ENTRY is installable from a configured package archive.
Check that package described by ARCHIVE-ENTRY can be installed at
required version PACKAGE-VERSION. If not, raise an error for DEP-POS."
(let* ((package-name (car archive-entry))
(best-version (package-lint--highest-installable-version-of package-name)))
(when (version-list-< best-version package-version)
(package-lint--error-at-point
'warning
(format "Version dependency for %s appears too high: try %s" package-name
(package-version-join best-version))
dep-pos))))
(defun package-lint--check-emacs-version (valid-deps)
"Check that all VALID-DEPS are available for installation."
(pcase-dolist (`(,package-name ,package-version ,dep-pos) valid-deps)
(when (eq 'emacs package-name)
(cond
((version-list-< package-version '(24))
(package-lint--error-at-point
'error
"You can only depend on Emacs version 24 or greater: package.el for Emacs 23 does not support the \"emacs\" pseudopackage."
dep-pos))
((version-list-<= package-lint-emacs-head-version package-version)
(package-lint--error-at-point
'warning
"This makes the package uninstallable in all released Emacs versions."
dep-pos))))))
(defun package-lint--check-packages-installable (valid-deps)
"Check that all VALID-DEPS are available for installation."
(pcase-dolist (`(,package-name ,package-version ,dep-pos) valid-deps)
(unless (eq 'emacs package-name)
(let ((archive-entry (assq package-name package-archive-contents)))
(if archive-entry
(package-lint--check-package-installable archive-entry package-version dep-pos)
(package-lint--error-at-point
'error
(format "Package %S is not installable." package-name)
dep-pos))))))
(defun package-lint--check-deps-use-non-snapshot-version (valid-deps)
"Warn about any VALID-DEPS on snapshot versions of packages."
(pcase-dolist (`(,package-name ,package-version ,dep-pos) valid-deps)
(unless (version-list-< package-version '(19001201 1))
(package-lint--error-at-point
'warning
(format "Use a non-snapshot version number for dependency on \"%S\" if possible."
package-name)
dep-pos))))
(defun package-lint--check-deps-do-not-use-zero-versions (valid-deps)
"Warn about VALID-DEPS on \"0\" versions of packages."
(pcase-dolist (`(,package-name ,package-version ,dep-pos) valid-deps)
(when (equal package-version '(0))
(package-lint--error-at-point
'warning
(format "Use a properly versioned dependency on \"%S\" if possible."
package-name)
dep-pos))))
(defun package-lint--check-lexical-binding-requires-emacs-24 (valid-deps)
"Warn about use of `lexical-binding' when Emacs 24.1 is not among VALID-DEPS."
(goto-char (point-min))
(when (package-lint--lexical-binding-declared-in-header-line-p)
(unless (assq 'emacs valid-deps)
(package-lint--error-at-point
'warning
"You should depend on (emacs \"24.1\") if you need lexical-binding."
(match-beginning 1)))))
(defun package-lint--inside-comment-or-string-p ()
"Return non-nil if point is inside a comment or string."
(let ((ppss (save-match-data (syntax-ppss))))
(or (nth 3 ppss) (nth 4 ppss))))
(defun package-lint--seen-fboundp-check-for (sym)
"Return non-nil if a `fboundp' check for SYM is present before point."
(save-excursion
(save-match-data
(and (re-search-backward
(concat "(" (regexp-opt '("fboundp" "macrop")) "\\s-+#?'" (regexp-quote sym) "\\_>") (point-min) t)
(not (package-lint--inside-comment-or-string-p))))))
(defun package-lint--map-regexp-match (regexp callback)
"For every match of REGEXP, call CALLBACK with the first match group.
If callback returns non-nil, the return value - which must be a
list - will be applied to `package-lint--error-at-point'. If
REGEXP doesn't produce a match group 1, then match group
0 (ie. the whole match string string) will be passed to
CALLBACK."
(save-excursion
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(let ((sym (or (match-string-no-properties 1)
(match-string-no-properties 0))))
(save-excursion
(goto-char (or (match-beginning 1)
(match-beginning 0)))
(let ((err (funcall callback sym)))
(when err
;; Check this as late as possible, just before reporting,
;; because otherwise the checking process is extremely slow,
;; being bottlenecked by `syntax-ppss'.
(unless (package-lint--inside-comment-or-string-p)
(apply #'package-lint--error-at-point err)))))))))
(defun package-lint--check-version-regexp-list (valid-deps symbol-regexp type)
"Warn if symbols matched by SYMBOL-REGEXP are unavailable in the target Emacs.
The target Emacs version is taken from VALID-DEPS, which are the
declared dependencies of this package. TYPE is the
type of the symbol, either FUNCTION or FEATURE."
(let ((emacs-version-dep (or (cadr (assq 'emacs valid-deps)) '(0))))
(package-lint--map-regexp-match
symbol-regexp
(lambda (sym)
(let-alist (package-lint-symbol-info sym)
(let ((added-in-version (cl-ecase type
('function .function-added)
('feature .library-added))))
(when (and added-in-version (version-list-< emacs-version-dep added-in-version))
(unless (and (eq type 'function) (package-lint--seen-fboundp-check-for sym))
(let* ((available-backport-with-ver
(cl-ecase type
('feature
(cl-some (lambda (bp)
(when (string= (car bp) sym)
(or (cddr bp)
(list (car bp)))))
package-lint-backport-libraries))
('function
(cl-some (lambda (bp)
(when (string-match-p (nth 1 bp) sym)
(or (cddr bp)
(list (car bp)))))
package-lint-backport-libraries))))
(available-backport (car available-backport-with-ver))
(required-backport-version (cadr available-backport-with-ver))
(matching-dep (when available-backport
(assoc available-backport valid-deps))))
(unless (and matching-dep
(or (not required-backport-version)
(version-list-<= (version-to-list required-backport-version)
(cadr matching-dep))))
(list
'error
(format "You should depend on (emacs \"%s\")%s if you need `%s'."
(mapconcat #'number-to-string added-in-version ".")
(if available-backport
(format " or the %s package"
(if required-backport-version
(format "(%s \"%s\")"
available-backport
required-backport-version)
available-backport))
"")
sym))))))))))))
(defun package-lint--check-eval-after-load ()
"Warn about use of `eval-after-load' and co."
(package-lint--map-regexp-match
"(\\s-*?\\(\\(?:with-\\)?eval-after-load\\)\\_>"
(lambda (match)
(list 'warning
(format "`%s' is for use in configurations, and should rarely be used in packages." match)))))
(defun package-lint--check-no-use-of-cl ()
"Warn about use of deprecated `cl' library."
(package-lint--map-regexp-match
"(\\s-*?require\\s-*?'\\(cl\\)\\_>"
(lambda (_)
(list
'warning
"Replace deprecated `cl' with `cl-lib'. The `cl-libify' package can help with this."))))
(defun package-lint--check-no-use-of-cl-lib-sublibraries ()
"Warn about use of `cl-macs', `cl-seq' etc."
(package-lint--map-regexp-match
"(\\s-*?require\\s-*?'\\(cl-macs\\|cl-seq\\)\\_>"
(lambda (_)
(list
'warning
"This file is not in the `cl-lib' ELPA compatibility package: require `cl-lib' instead."))))
(defconst package-lint--unconditional-require-regexp
;; Match the ending paren so we can be sure it's a single argument
;; `require'. If there are additional arguments, we don't want to warn,
;; because (require 'foo nil t) indicates an optional dependency and
;; (require 'foo "filename") is very uncommon.
"(\\s-*?require\\s-*?'\\_<\\(.*?\\)\\_>\\s-*?)"
"Regexp to match unconditional `require' forms.")
(defun package-lint--check-libraries-available-in-emacs (valid-deps)
"Warn about use of libraries that are not available.
The check is performed against the Emacs version in VALID-DEPS."
(package-lint--check-version-regexp-list
valid-deps
package-lint--unconditional-require-regexp
'feature))
(defun package-lint--check-libraries-removed-from-emacs ()
"Warn about use of libraries that have been removed from Emacs."
(package-lint--map-regexp-match
package-lint--unconditional-require-regexp
(lambda (sym)
(let-alist (package-lint-symbol-info sym)
(let ((removed-in-version .library-removed))
(when removed-in-version
(list
'error
(format "The `%s' library was removed in Emacs version %s."
sym (mapconcat #'number-to-string removed-in-version ".")))))))))
(defconst package-lint--function-name-regexp
(rx
(seq
(or "#'"
(seq "(" (* (syntax whitespace))
(? (seq
(or "funcall" "apply" "advice-add")
(+
(syntax whitespace))
"'"))))
(group
(*\? nonl))
symbol-end))
"Regexp to match function names.")
(defun package-lint--check-macros-functions-available-in-emacs (valid-deps)
"Warn about use of unavailable functions/macros that are not available.
The check is performed against the Emacs version in VALID-DEPS."
(package-lint--check-version-regexp-list
valid-deps
package-lint--function-name-regexp
'function))
(defun package-lint--check-macros-functions-removed-from-emacs (valid-deps)
"Warn about use of functions/macros that have been removed from Emacs.
If an Emacs version is specified in VALID-DEPS, don't warn about
functions/macros that were removed and later re-added, as long as
the Emacs dependency matches the re-addition."
(package-lint--map-regexp-match
package-lint--function-name-regexp
(lambda (sym)
(let-alist (package-lint-symbol-info sym)
(let ((removed-in-version .function-removed))
(when removed-in-version
(let ((emacs-version-dep (or (cadr (assq 'emacs valid-deps)) '(0))))
(unless (and .function-added (version-list-<= .function-added emacs-version-dep))
(list
'error
(format "`%s' was removed in Emacs version %s."
sym (mapconcat #'number-to-string removed-in-version ".")))))))))))
(defun package-lint--check-lexical-binding-is-on-first-line ()
"Check that any `lexical-binding' declaration is on the first line of the file."
(cl-block return
(let ((original-buffer (current-buffer)))
(with-temp-buffer
(let ((lexical-binding-found-at-end nil))
(insert-buffer-substring-no-properties original-buffer)
(condition-case err
(cl-letf (((symbol-function #'hack-local-variables-apply) #'ignore)
((symbol-function #'hack-local-variables-filter)
(lambda (variables _dir-name)
(setq file-local-variables-alist variables)))
;; Silence any messages Emacs may want to share with the user.
;; There's no user.
((symbol-function #'display-warning) #'ignore)
((symbol-function #'message) #'ignore))
;; HACK: this is an internal variable!
;; Unfortunately, Emacsen that have this variable also have
;; `hack-local-variables' that doesn't store `lexical-binding'
;; in `file-local-variables-alist'.
(defvar enable-dir-local-variables)
(defvar hack-local-variables--warned-lexical)
(let ((hack-local-variables--warned-lexical nil)
(enable-dir-local-variables nil)
(enable-local-variables t)
(local-enable-local-variables t))
(hack-local-variables)
(setq lexical-binding-found-at-end
hack-local-variables--warned-lexical)))
(error
(package-lint--error-at-bob 'error (error-message-string err))
(cl-return-from return nil)))
(when (or lexical-binding-found-at-end
;; In case this is an Emacs from before `hack-local-variables'
;; started to warn about `lexical-binding' on a line other
;; than the first.
(and (cdr (assq 'lexical-binding file-local-variables-alist))
(not (package-lint--lexical-binding-declared-in-header-line-p))))
(package-lint--error-at-bob
'error
"`lexical-binding' must be set in the first line.")))))))
(defun package-lint--check-cl-lib-version (valid-deps)
"Check depenendencies in VALID-DEPS on \"cl-lib\".
The specified versions must be remotely available for installation."
(let ((emacs-version-dep (or (nth 1 (assq 'emacs valid-deps)) '(0)))
(cl-lib-dep (assq 'cl-lib valid-deps)))
(when cl-lib-dep
(let ((cl-lib-version (nth 1 cl-lib-dep)))
(cond ((and emacs-version-dep
(version-list-<= '(24 3) emacs-version-dep)
(version-list-<= cl-lib-version '(1 0)))
(package-lint--error-at-point
'warning
"An explicit dependency on cl-lib <= 1.0 is not needed on Emacs >= 24.3."))
((version-list-<= '(1) cl-lib-version)
(package-lint--error-at-point
'error
(format "Depend on the latest 0.x version of cl-lib rather than on version \"%S\".
Alternatively, depend on (emacs \"24.3\") or greater, in which cl-lib is bundled."
cl-lib-version)
(nth 2 cl-lib-dep))))))))
(defun package-lint--check-package-version-present ()
"Check that a valid \"Version\" header is present."
(let ((version (package-lint--goto-header (rx (? "Package-") "Version"))))
(if version
(unless (ignore-errors (version-to-list version))
(package-lint--error-at-point
'warning
(format "\"%s\" is not a valid version. MELPA will handle this, but other archives will not." version)
(match-beginning 3)))
(package-lint--error-at-bob
'warning
"\"Version:\" or \"Package-Version:\" header is missing. MELPA will handle this, but other archives will not."))))
(defun package-lint--liberal-package-buffer-info ()
"Like `package-buffer-info', but tolerate missing version header."
(let ((orig-buffer (current-buffer)))
;; We've reported version header issues separately, so rule them out here
(with-temp-buffer
(insert-buffer-substring-no-properties orig-buffer)
(goto-char (point-min))
(package-lint--update-or-insert-version "0")
(package-buffer-info))))
(defun package-lint--check-package-el-can-parse ()
"Check that `package-buffer-info' can read metadata from this file.
If it can, return the read metadata."
(condition-case err
(package-lint--liberal-package-buffer-info)
(error
(package-lint--error-at-bob
'error
(format "package.el cannot parse this buffer: %s" (error-message-string err)))
nil)))
(defun package-lint--check-package-summary (desc)
"Check the summary for package with descriptor DESC.
DESC is a struct as returned by `package-buffer-info'."
(let ((summary (package-lint--package-desc-summary desc)))
(cond
((string= summary "")
(package-lint--error-at-bob
'error
"Package should have a non-empty summary."))
(t
(unless (let ((case-fold-search nil))
(string-match-p "^[A-Z0-9]" summary))
(package-lint--error-at-bob
'warning
"The package summary should start with an uppercase letter or a digit."))
(when (> (length summary) 60)
(package-lint--error-at-bob
'warning
"The package summary is too long. It should be at most 60 characters."))
(when (string-match "\\.\\'" summary)
(package-lint--error-at-bob
'warning
"The package summary should not end with a period."))
(when (save-match-data
(let ((case-fold-search t))
(and (string-match "[^.]\\<emacs\\>" summary)
(not (string-match-p "[[:space:]]+lisp"
summary (match-end 0))))))
(package-lint--error-at-bob
'warning
"Including \"Emacs\" in the package summary is usually redundant."))))))
(defun package-lint--check-provide-form (desc)
"Check the provide form for package with descriptor DESC.
DESC is a struct as returned by `package-buffer-info'."
(let ((name (symbol-name (package-lint--package-desc-name desc))))
(if (string-match-p "-theme\\'" name)
(let ((theme-name (replace-regexp-in-string "-theme\\'" "" name))
(provided-theme (package-lint--provided-theme)))
(unless (string-equal theme-name provided-theme)
(package-lint--error-at-bob
'error
(format "There is no (provide-theme '%s) form." theme-name))))
(let ((feature (package-lint--provided-feature)))
(unless (string-equal name feature)
(package-lint--error-at-bob
'error
(format "There is no (provide '%s) form." name)))))))
(defun package-lint--check-provide-form-secondary-file ()
"Check there is a provide form."
;; We don't require that the provided feature have a name consistent
;; with the overall package prefix, but this check may later be added.
(unless (package-lint--provided-feature)
(package-lint--error-at-bob
'error
"There is no `provide' form.")))
(defun package-lint--check-no-emacs-in-package-name (desc)
"Check that the package name doesn't contain \"emacs\".
DESC is a struct as returned by `package-buffer-info'."
(let ((name (package-lint--package-desc-name desc)))
(when (string-match-p "emacs" (symbol-name name))
(package-lint--error-at-bob
'warning
"The word \"emacs\" is redundant in Emacs package names."))))
(defun package-lint--check-symbol-separators (definitions)
"Check that symbol DEFINITIONS don't contain non-standard separators."
(pcase-dolist (`(,name . ,position) definitions)
(when (and (string-match "[:/]" name)
(not (string-match-p package-lint--sane-prefixes name)))
(let ((match-pos (match-beginning 0)))
;; As a special case, allow `/=' or `/' when at the end of a symbol.
(when (or (not (string-match (rx "/" (optional "=") string-end) name))
(/= match-pos (match-beginning 0)))
(goto-char position)
(package-lint--error
(line-number-at-pos) 0 'error
(format "`%s' contains a non-standard separator `%s', use hyphens instead (see Elisp Coding Conventions)."
name (substring-no-properties name match-pos (1+ match-pos)))))))))
(defun package-lint--valid-prefix-mapping-p (short-prefix prefix name)
"Check if NAME corresponds to a valid mappings for PREFIX.
Check is done according to the definitions in
`package-lint--allowed-prefix-mappings' for SHORT-PREFIX."
(let ((regexp (concat "^" (regexp-opt
(cdr (assoc short-prefix package-lint--allowed-prefix-mappings))))))
(string-prefix-p prefix (replace-regexp-in-string regexp short-prefix name))))
(defun package-lint--valid-definition-name-p (name prefix &optional position)
"Return non-nil if NAME denotes a valid definition name.
Valid definition names are:
- a NAME starting with PREFIX, a string representing the current
package prefix,
- a NAME matching `package-lint--sane-prefixes', or
- a NAME whose POSITION in the buffer denotes a global definition."
(or (string-prefix-p prefix name)
(string-match-p package-lint--sane-prefixes name)
(string-match-p (rx-to-string `(seq string-start (or "define" "defun" "defvar" "defface" "with") "-" ,prefix)) name)
(string-match-p (rx-to-string `(seq string-start "global-" ,prefix (or "-mode" (seq "-" (* any) "-mode")) string-end)) name)
(let ((short-prefix (car (cl-remove-if-not (lambda (e) (string-prefix-p e prefix))
(mapcar #'car package-lint--allowed-prefix-mappings)))))
(when short-prefix
(package-lint--valid-prefix-mapping-p short-prefix prefix name)))
(when position
(goto-char position)
(looking-at-p (rx (*? space) "(" (*? space)
(or "defadvice" "cl-defmethod" "define-advice")
symbol-end)))))
(defun package-lint--check-defs-prefix (prefix definitions)
"Verify that symbol DEFINITIONS start with package PREFIX."
(pcase-dolist (`(,name . ,position) definitions)
(unless (package-lint--valid-definition-name-p name prefix position)
(if (package-lint--added-or-removed-function-p name)
(package-lint--error-at-point
'error
(format "Define compatibility functions with a prefix, e.g. \"%s--%s\", and use `defalias' where they exist."
prefix name)
position)
(package-lint--error-at-point
'error
(format "\"%s\" doesn't start with package's prefix \"%s\"."
name prefix)
position)))))
(defun package-lint--check-minor-mode (def)
"Offer up concerns about the minor mode definition DEF."
(when (cl-search '(:global t) def)
(package-lint--check-globalized-minor-mode def)))
(defun package-lint--check-globalized-minor-mode (def)
"Offer up concerns about the global minor mode definition DEF."
(let ((feature-name (package-lint--provided-feature)))
(when feature-name
(let ((feature (intern feature-name))
(autoloaded (save-excursion
(forward-line -1)
(beginning-of-line)
(looking-at ";;;###autoload"))))
(unless (or autoloaded
(cl-search `(:require ',feature) def :test #'equal))
(package-lint--error-at-point
'error
(format
"Global minor modes should be autoloaded or, rarely, `:require' their defining file (i.e. \":require '%s\"), to support the customization variable of the same name." feature)))))))
(defun package-lint--check-defgroup (def)
"Offer up concerns about the customization group definition DEF."
(when (symbolp (cadr def))
(let ((group-name (symbol-name (cadr def))))
(when (string-match "\\(.*\\)-mode$" group-name)
(let ((parent (intern (match-string 1 group-name))))
(unless (cl-search `(:group ',parent) def :test #'equal)
(package-lint--error-at-point
'error
"Customization groups should not end in \"-mode\" unless that name would conflict with their parent group."))))))
(unless (memq :group def)
(package-lint--error-at-point
'error
"Customization groups should specify a parent via `:group'.")))
(defun package-lint--check-defalias (prefix def)
"Offer up concerns about the customization group definition DEF.
PREFIX is the package prefix."
(pcase (cadr def)
((and `(quote ,alias) (guard (symbolp alias)))
(unless (package-lint--valid-definition-name-p (symbol-name alias) prefix)
(package-lint--error-at-point
'error