Add emacs-lisp-check-declare checker #1286

darkfeline · 2017-07-19T08:30:53Z

No description provided.

CLAassistant · 2017-07-19T08:30:59Z

All committers have signed the CLA.

darkfeline · 2017-07-19T08:31:52Z

Hm, this appears to work when I load the checker into my working Emacs, but the flycheck-test test doesn't pass, and ert is woefully opaque about why.

fmdkdd · 2017-07-19T08:50:15Z

The output to ERT is not the most intuitive:

((should
       (equal expected flycheck-current-errors))
      :form
      (equal
       ([cl-struct-flycheck-error #<killed buffer> emacs-lisp-check-declare "/home/travis/build/flycheck/flycheck/test/resources/language/emacs-lisp/check-declare-errors.el" 10 1 "said ‘this-function-is-not-defined’ was defined in this-file-does-not-exist.el: file not found" warning nil nil])
       nil)

Inside the :form (equal, it expects the error you declared, but you got nil instead. That means the error was either not caught by the checker, or the checker was not run at all.

I think the issue here is that your checker is never selected by the Flycheck run by ERT. emacs-lisp is the default checker, followed by emacs-lisp-checkdoc (see the :next-checker property).

You could put your checker as a :next-checker for checkdoc.

darkfeline · 2017-07-19T08:59:42Z

Ah, got it. The tests pass now.

cpitclaudel

Thanks, this looks pretty good. One question: shouldn't this be part of the default ELisp checker?

cpitclaudel · 2017-07-19T15:11:03Z

test/resources/language/emacs-lisp/check-declare-errors.el

+
+;;; Commentary:
+
+;; Checkdoc uses the syntax table and comment syntax of the current buffer; if


Isn't that comment a leftover from another file?

cpitclaudel · 2017-07-19T15:11:55Z

flycheck.el

@@ -7161,12 +7162,34 @@ The checker runs `checkdoc-current-buffer'."
    (not (or (flycheck-autoloads-file-p)
             (and (buffer-file-name)
                  (member (file-name-nondirectory (buffer-file-name))
-                          '("Cask" "Carton" ".dir-locals.el")))))))
+                          '("Cask" "Carton" ".dir-locals.el"))))))
+  :next-checkers (emacs-lisp-check-declare))


Shouldn't this be added to the next-checkers of emacs-lisp as well?

fmdkdd · 2017-07-19T18:57:42Z

shouldn't this be part of the default ELisp checker?

I agree. It looks like we could just add the check-declare-form as an additional argument to the emacs-lisp checker, and save ourselves the trouble of calling emacs a third time.

fmdkdd · 2017-07-19T21:01:30Z

(Reminder: #1229)

darkfeline · 2017-07-20T04:46:37Z

Merged checker into emacs-lisp

darkfeline · 2017-07-20T05:43:03Z

Looks like I need to get my hands on a build of Emacs 24, please wait warmly.

darkfeline · 2017-07-22T05:01:06Z

Actually, it looks like I can't build Emacs 24. I believe I'm running into the bug mentioned here: http://lists.linuxfromscratch.org/pipermail/blfs-support/2016-August/078284.html

It may be a while before I can get Emacs 24. If someone else can fix this, feel free. I suspect it's something like the error filter needing to be tweaked.

darkfeline · 2017-07-25T03:08:32Z

The Emacs I used was 24.3, which flycheck doesn't support. If the fix doesn't pass, I'll probably install a newer Ubuntu in a VM and try again.

~~I wonder if flycheck would benefit from shipping a Vagrantfile.~~

darkfeline · 2017-07-25T06:17:05Z

Well, that was a waste of time. As it turns out, check-declare does not print the line number on Emacs 24 and stepping through the debugger I learned that Flycheck discards errors that do not have line numbers.

I don't really feel like trying to make this work now, so I've skipped the test on Emacs 24 and documented that check-declare doesn't work on Emacs 24.

fmdkdd · 2017-07-25T08:53:20Z

Thanks for investigating the issue. So, currently the check-declare pass will be run by Flycheck on Emacs 24, but the errors won't be reported, is that it?

If the issue is missing line numbers in the output, you can check for errors that have a nil line and set them to 0 instead. That way, the errors will be reported on the first line, and Flycheck will not discard them.

If it's too much a hassle to test that with Emacs 24, let me know. I have an Emacs 24 install I can use to test this workaround.

darkfeline · 2017-07-26T03:33:49Z

Currently on Emacs 24, check-declare will emit errors correctly, but they will be filtered out by flycheck-relevant-errors/flycheck-relevant-error-p.

Adding 0 line numbers to them sounds like a good solution; I'll try to do it with error-filters.

darkfeline · 2017-07-30T08:56:21Z

Any update on this?

fmdkdd

@darkfeline Sorry, I didn't see that you updated the PR (does Github actually notifies you of new commits, even for amends?)

That's a lovely patch, with tests. LGTM 👍

@cpitclaudel, is it good for you?

cpitclaudel

Great work :) I left two small comments, but I'd also be fine with merging as-is.

cpitclaudel · 2017-08-01T09:00:30Z

flycheck.el

-              flycheck-byte-compiled-files)))))
+              flycheck-byte-compiled-files))
+      (when (and (boundp 'flycheck-emacs-lisp-check-declare)
+                 flycheck-emacs-lisp-check-declare)


Could this be written as bound-and-true-p?

cpitclaudel · 2017-08-01T09:00:57Z

flycheck.el

+  (seq-do (lambda (err)
+            (unless (flycheck-error-line err)
+              (setf (flycheck-error-line err) 0)))
+          errors)


For simple iteration like this, I tend to prefer dolist over seq-do

All of the other filters use seq-do, so I am inclined to keep the code consistent.

EDIT: Not all, but many. The nearby filters use seq-do so I will do the same.

cpitclaudel · 2017-08-02T07:22:32Z

Brilliant work, thanks!

fmdkdd · 2017-08-02T08:32:50Z

Thank you @darkfeline for your patience, and for this nice contribution!

darkfeline mentioned this pull request Jul 19, 2017

Add check-declare-function checker for emacs-lisp #1229

Closed

darkfeline force-pushed the check-declare branch from 1058b7c to 2e21ec5 Compare July 19, 2017 08:58

fmdkdd added component: checkers status: ready for review labels Jul 19, 2017

cpitclaudel reviewed Jul 19, 2017

View reviewed changes

darkfeline force-pushed the check-declare branch from 2e21ec5 to c4b27e4 Compare July 20, 2017 04:45

darkfeline force-pushed the check-declare branch from c4b27e4 to eb947e4 Compare July 25, 2017 03:06

darkfeline force-pushed the check-declare branch from eb947e4 to aa4af40 Compare July 25, 2017 06:15

darkfeline force-pushed the check-declare branch 2 times, most recently from 27f03ed to 1c5d410 Compare July 26, 2017 03:43

fmdkdd approved these changes Aug 1, 2017

View reviewed changes

cpitclaudel approved these changes Aug 1, 2017

View reviewed changes

Add emacs-lisp-check-declare checker

ac7b5a9

darkfeline force-pushed the check-declare branch from 1c5d410 to ac7b5a9 Compare August 2, 2017 04:03

cpitclaudel merged commit ed08ce3 into flycheck:master Aug 2, 2017

fmdkdd removed the status: ready for review label Aug 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add emacs-lisp-check-declare checker #1286

Add emacs-lisp-check-declare checker #1286

darkfeline commented Jul 19, 2017

CLAassistant commented Jul 19, 2017 •

edited

Loading

darkfeline commented Jul 19, 2017

fmdkdd commented Jul 19, 2017

darkfeline commented Jul 19, 2017

cpitclaudel left a comment

cpitclaudel Jul 19, 2017

cpitclaudel Jul 19, 2017

fmdkdd commented Jul 19, 2017

fmdkdd commented Jul 19, 2017

darkfeline commented Jul 20, 2017

darkfeline commented Jul 20, 2017

darkfeline commented Jul 22, 2017

darkfeline commented Jul 25, 2017 •

edited

Loading

darkfeline commented Jul 25, 2017

fmdkdd commented Jul 25, 2017

darkfeline commented Jul 26, 2017

darkfeline commented Jul 30, 2017

fmdkdd left a comment

cpitclaudel left a comment

cpitclaudel Aug 1, 2017

darkfeline Aug 2, 2017

cpitclaudel Aug 1, 2017

darkfeline Aug 2, 2017 •

edited

Loading

cpitclaudel commented Aug 2, 2017

fmdkdd commented Aug 2, 2017


		;;; Commentary:

		;; Checkdoc uses the syntax table and comment syntax of the current buffer; if

Add emacs-lisp-check-declare checker #1286

Add emacs-lisp-check-declare checker #1286

Conversation

darkfeline commented Jul 19, 2017

CLAassistant commented Jul 19, 2017 • edited Loading

darkfeline commented Jul 19, 2017

fmdkdd commented Jul 19, 2017

darkfeline commented Jul 19, 2017

cpitclaudel left a comment

Choose a reason for hiding this comment

cpitclaudel Jul 19, 2017

Choose a reason for hiding this comment

cpitclaudel Jul 19, 2017

Choose a reason for hiding this comment

fmdkdd commented Jul 19, 2017

fmdkdd commented Jul 19, 2017

darkfeline commented Jul 20, 2017

darkfeline commented Jul 20, 2017

darkfeline commented Jul 22, 2017

darkfeline commented Jul 25, 2017 • edited Loading

darkfeline commented Jul 25, 2017

fmdkdd commented Jul 25, 2017

darkfeline commented Jul 26, 2017

darkfeline commented Jul 30, 2017

fmdkdd left a comment

Choose a reason for hiding this comment

cpitclaudel left a comment

Choose a reason for hiding this comment

cpitclaudel Aug 1, 2017

Choose a reason for hiding this comment

darkfeline Aug 2, 2017

Choose a reason for hiding this comment

cpitclaudel Aug 1, 2017

Choose a reason for hiding this comment

darkfeline Aug 2, 2017 • edited Loading

Choose a reason for hiding this comment

cpitclaudel commented Aug 2, 2017

fmdkdd commented Aug 2, 2017

CLAassistant commented Jul 19, 2017 •

edited

Loading

darkfeline commented Jul 25, 2017 •

edited

Loading

darkfeline Aug 2, 2017 •

edited

Loading