zot / microfts

Small and fast FTS (full text search)
MIT License
32 stars 3 forks source link

Run checkdoc/package-lint #9

Closed progfolio closed 3 years ago

progfolio commented 3 years ago

Both of these tools will help bring your library in line with Elisp conventions.

checkdoc reports 20 errors: ``` org-fts.el 25 info White space found at end of line (emacs-lisp-checkdoc) org-fts.el 40 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 45 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 50 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 60 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 60 info First line should be capitalized (emacs-lisp-checkdoc) org-fts.el 69 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 69 info First line should be capitalized (emacs-lisp-checkdoc) org-fts.el 69 info Argument ‘item’ should appear (as ITEM) in the doc string (emacs-lisp-checkdoc) org-fts.el 76 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 76 info Lisp symbol ‘org-mode’ should appear in quotes (emacs-lisp-checkdoc) org-fts.el 86 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 86 info Lisp symbol ‘org-mode’ should appear in quotes (emacs-lisp-checkdoc) org-fts.el 103 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 115 info All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc) org-fts.el 136 info All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc) org-fts.el 146 info All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc) org-fts.el 163 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 175 info First sentence should end with punctuation (emacs-lisp-checkdoc) org-fts.el 192 info First sentence should end with punctuation (emacs-lisp-checkdoc) ```
46 package-lint issues found: ``` 46 issues found: 1:71: warning: You should depend on (emacs "24.1") if you need lexical-binding. 8:0: error: Expected (package-name "version-num"), but found cl-lib. 8:0: error: Expected (package-name "version-num"), but found executable. 8:0: error: Expected (package-name "version-num"), but found ivy. 8:0: error: Expected (package-name "version-num"), but found org. 8:0: error: Expected (package-name "version-num"), but found package. 11:0: error: Package should have a non-empty ;;; Commentary section. 15:10: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-lib'. 18:10: error: You should depend on (emacs "24.1") if you need `package'. 25:0: error: `org-fts/microfts-url-alist' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 30:0: error: `org-fts/baseprogram-alist' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 35:0: error: `org-fts/baseprogram' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 39:0: error: `org-fts/program' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 44:0: error: `org-fts/db' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 49:0: error: `org-fts/search-args' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 54:0: error: `org-fts/hits' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 55:0: error: `org-fts/args' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 56:0: error: `org-fts/timer' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 57:0: error: `org-fts/actual-program' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 59:0: error: `org-fts/check-db' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 68:0: error: `org-fts/test' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 75:0: error: `org-fts/save-hook' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 85:0: error: `org-fts/open-hook' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 102:0: error: `org-fts/idle-task' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 114:0: error: `org-fts/microfts-search' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 131:47: error: You should depend on (emacs "24.3") if you need `file-name-base'. 133:14: warning: Closing parens should not be wrapped onto new lines. 135:0: error: `org-fts/found' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 139:38: error: You should depend on (emacs "27.1") if you need `org-show-all'. 142:0: error: `org-fts/history' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 143:0: error: `org-fts/file-history' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 145:0: error: `org-fts/display' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 146:18: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-search'. 147:18: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-search'. 152:5: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-do'. 152:18: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-incf'. 154:9: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-do'. 154:20: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-search'. 154:55: error: You should depend on (emacs "24.3") or the cl-lib package if you need `cl-search'. 162:0: error: `org-fts/search' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 174:0: error: `org-fts/find-org-file' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 184:20: error: You should depend on (emacs "25.1") or the seq package if you need `seq-filter'. 185:37: error: You should depend on (emacs "25.1") or the seq package if you need `seq-sort'. 186:49: error: You should depend on (emacs "25.1") if you need `string-collate-lessp'. 191:0: error: `org-fts/ensure-binary' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). 217:20: error: You should depend on (emacs "24.4") if you need `zlib-decompress-region'. ```
zot commented 3 years ago

Thanks for these -- this is the first emacs package I've made

zot commented 3 years ago

fixed