Valentin’s Lab

Analyzer

My pycheckers code analyzer is actually written in python and will call pep8 and pylint and ensure that the output format is correct. These two analyzers are available on PyPI and thus are installable thanks to:

pip install pylint
pip install pep8

Please check the analyzer code at: https://gist.github.com/3754270

I typically put the analyzer in ~/bin/pycheckers and ensure that it is executable.

Emacs

Here's the emacs snippet:

;; Python flymake configuration

(when (load "flymake" t)
  (defun flymake-pycheckers-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                    'flymake-create-temp-inplace))
        (local-file (file-relative-name
                     temp-file
                     (file-name-directory buffer-file-name))))
      (list "~/bin/pycheckers.py"  (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
            '("\\.py\\'" flymake-pycheckers-init)))

For the lazier

This snippet will do the complete job for you:

mkdir -p ~/bin &&
cd ~/bin &&
wget https://raw.github.com/gist/3754270/a4fecffaff6ab702f5c8d37332afc90f6461e40b/pycheckers.py &&
chmod +x pycheckers.py &&
cat <<EOF >> ~/.emacs

;; Python flymake configuration

(when (load "flymake" t)
  (defun flymake-pycheckers-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                    'flymake-create-temp-inplace))
        (local-file (file-relative-name
                     temp-file
                     (file-name-directory buffer-file-name))))
      (list "~/bin/pycheckers.py"  (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
            '("\\.py\\'" flymake-pycheckers-init)))

EOF

You'll need to restart emacs for this to work. (Or highlight the added snippet in the end of your .emacs and call M-x eval-region)

Analyzer

I've also a phpcheckers, even if it is very small, I feel better to know that I could grep out some specific warnings or add another sub-analyzer quite easily, and feel free to add your own include path as you wish in the 'packages-path' arguments:

#!/bin/bash

phplint --modules-path ~/var/lib/phplint/modules \
        --packages-path /usr/share/php \
        --no-print-notices "$@"

So i'm using only phplint here.

Emacs

Here's the emacs snippet:

;; PHP flymake configuration

(when (load "flymake" t)
  (defun flymake-phplint-init()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                     'flymake-create-temp-inplace))
         (local-file (file-relative-name
                      temp-file
                      (file-name-directory buffer-file-name))))
      (list "phpcheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
             '("\\.php[345]?$" flymake-phplint-init))
  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.inc$" flymake-phplint-init)))

For the lazier

This snippet will do the complete job for you:

mkdir -p ~/bin &&
cd ~/bin &&
cat <<EOF > ~/bin/phpcheckers &&
#!/bin/bash

phplint --modules-path ~/var/lib/phplint/modules \
        --packages-path /usr/share/php \
        --no-print-notices "\$@"
EOF
chmod +x phpcheckers &&
cat <<EOF >> ~/.emacs

;; PHP flymake configuration

(when (load "flymake" t)
  (defun flymake-phplint-init()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                    'flymake-create-temp-inplace))
        (local-file (file-relative-name
                     temp-file
                     (file-name-directory buffer-file-name))))
      (list "~/bin/phpcheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
            '("\\.php[345]?$" flymake-phplint-init))
  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.inc$" flymake-phplint-init)))

EOF

You'll need to restart emacs for this to work. (Or highlight the added snippet in the end of your .emacs and call M-x eval-region)

Analyzer

I use a combination of jslint and jshint.

This is more work as jslint is widely criticized for behing too spotty on some conventions only shared by its author, I find it useful when tamed down to normal behavior.

Second, it's not so easy to get the correct format out of jslint. So I created a jslint-emacs executable that lies in ~/bin/jslint-emacs. Here's the code:

#!/bin/bash

filename="$1"

jslint "$filename" --nomen --maxerr 999999 |

## reformat from:
##
##  #45 Expected exactly one space between 'function' and '('.
##      init: function(parent, dataset, csv_import_record){ // Line 127, Pos 23
##
## to:
##
##  filename.js:94: WARNING: (jslint) Expected exactly one space between 'function' and '('.

         sed -r "N;s/^\s*#[0-9]+ (.*)\n\s+.*\/\/ Line ([0-9]+),.*/$filename:\2: WARNING: W000 (jslint) \1/" |

## Remove garbages lines that were not match by previous regex
## as their is a small header not matching regexp.

         grep -E "^$filename:[0-9]+:" |

         grep -v "at column.*not column.*." |
         grep -v "Expected '{' and instead saw 'return'" |
         grep -v "Expected exactly one space between ')' and 'return'" |
         grep -v "Combine this with the previous 'var' statement" |
         grep -v "Unexpected 'in'. Compare with undefined, or use .*"

## force errorlevel 0 so as to avoid emacs ``flymake-mode`` to complain
exit 0

I've found that jshint can use a specific reporter written in javascript, which seems perfect to get the correct ouput from it.

This is my ~/bin/jshint-emacs:

#!/bin/bash

jshint "$1" --reporter ~/.emacs.d/jslint-emacs-reporter.js

And of course, my ~/.emacs.d/jslint-emacs-reporter.js is available as a gist here: https://gist.github.com/3754379

It seems that this javascript reporter could be used also with jslint but I didn't figure out how to do so. (This was maybe because I've already written the sed/grep thing before).

Of course, this is my ~/bin/jscheckers:

#!/bin/bash

jslint-emacs "$1"
jshint-emacs "$1"

Emacs

Here's the emacs snippet:

;; Javascript flymake configuration

(when (load "flymake" t)
  (defun flymake-jslint-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                     'flymake-create-temp-inplace))
           (local-file (file-relative-name
                        temp-file
                        (file-name-directory buffer-file-name))))
      (list "jscheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.js\\'" flymake-jslint-init)))

For the lazier

This snippet will do the complete job for you:

mkdir -p ~/bin &&
cd ~/bin &&
cat <<EOF > ~/bin/jslint-emacs &&
#!/bin/bash

filename="\$1"

jslint "\$filename" --nomen --maxerr 999999 |

## reformat from:
##
##  #45 Expected exactly one space between 'function' and '('.
##      init: function(parent, dataset, csv_import_record){ // Line 127, Pos 23
##
## to:
##
##  filename.js:94: WARNING: (jslint) Expected exactly one space between 'function' and '('.

         sed -r "N;s/^\s*#[0-9]+ (.*)\n\s+.*\/\/ Line ([0-9]+),.*/\$filename:\2: WARNING: W000 (jslint) \1/" |

## Remove garbages lines that were not match by previous regex
## as their is a small header not matching regexp.

         grep -E "^\$filename:[0-9]+:" |

         grep -v "at column.*not column.*." |
         grep -v "Expected '{' and instead saw 'return'" |
         grep -v "Expected exactly one space between ')' and 'return'" |
         grep -v "Combine this with the previous 'var' statement" |
      grep -v "Unexpected 'in'. Compare with undefined, or use .*"

## force errorlevel 0 so as to avoid emacs ``flymake-mode`` to complain
exit 0
EOF
chmod +x jslint-emacs &&
cat <<EOF > ~/bin/jscheckers &&
#!/bin/bash

~/bin/jslint-emacs "\$1"
~/bin/jshint-emacs "\$1"

EOF
chmod +x jscheckers &&
mkdir -p ~/.emacs.d &&
cd ~/.emacs.d &&
wget https://raw.github.com/gist/3754379/3c43c50b4d85f50b8314af8e498b1b4f2cee58ea/jslint-emacs-reporter.js &&
cat <<EOF >> ~/.emacs

;; Javascript flymake configuration

(when (load "flymake" t)
  (defun flymake-jslint-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                    'flymake-create-temp-inplace))
           (local-file (file-relative-name
                        temp-file
                        (file-name-directory buffer-file-name))))
      (list "jscheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.js\\'" flymake-jslint-init)))

EOF

You'll need to restart emacs for this to work. (Or highlight the added snippet in the end of your .emacs and call M-x eval-region)

Analyzer

I was surprised to see that rst2html will make very decent rst analyzer.

rst2html is provided by python docutils package.

My ~/bin/rstcheckers:

#!/bin/bash

rst2html "$1" > /dev/null

Surprising isn't it ? As it isn't a code analyzer but the compiler itself, it does it's job really well, and in combination with flymake, it gives you a very convenient on-the-fly syntax checking.

Note that >/dev/null is required as rst2html jobs is to output HTML from your rst (which we don't want to see), and it casts errors on the standard error pipe.

Emacs

Here's the emacs snippet:

;; ReSTructured Text Flymake configuration

(when (load "flymake" t)
  (defun flymake-rst-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                     'flymake-create-temp-inplace))
           (local-file (file-relative-name
                        temp-file
                        (file-name-directory buffer-file-name))))
      (list "rstcheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.rst\\'" flymake-rst-init)))

For the lazier

This snippet will do the complete job for you:

mkdir -p ~/bin &&
cd ~/bin &&
cat <<EOF > ~/bin/rstcheckers &&
#!/bin/bash

rst2html "\$1" > /dev/null
EOF
chmod +x rstcheckers &&
cat <<EOF >> ~/.emacs

;; ReSTructured Text Flymake configuration

(when (load "flymake" t)
  (defun flymake-rst-init ()
    (let* ((temp-file (flymake-init-create-temp-buffer-copy
                    'flymake-create-temp-inplace))
           (local-file (file-relative-name
                        temp-file
                        (file-name-directory buffer-file-name))))
      (list "rstcheckers" (list local-file))))

  (add-to-list 'flymake-allowed-file-name-masks
               '("\\.rst\\'" flymake-rst-init)))

EOF

You'll need to restart emacs for this to work. (Or highlight the added snippet in the end of your .emacs and call M-x eval-region)