You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
3.7 KiB
119 lines
3.7 KiB
;;; flymake-jshint.el --- making flymake work with JSHint
|
|
|
|
;; Copyright (C) 2011 Wilfred Hughes <me@wilfred.me.uk>
|
|
|
|
;; Author: Wilfred Hughes <me@wilfred.me.uk>
|
|
;; Created: 23 June 2011
|
|
;; Version: 1.0
|
|
;; Keywords: flymake, jshint, javascript
|
|
|
|
;; This file is not part of GNU Emacs.
|
|
;; However, it is distributed under the same license.
|
|
|
|
;; GNU Emacs 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, or (at your option)
|
|
;; any later version.
|
|
|
|
;; GNU Emacs 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 GNU Emacs; see the file COPYING. If not, write to the
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
;; Boston, MA 02110-1301, USA.
|
|
|
|
;;; Commentary
|
|
|
|
;; To use JSHint with emacs, you will need JSHint installed and available on
|
|
;; your path. You should be able to do
|
|
|
|
;; $ jshint
|
|
|
|
;; without problem. To do this, you can install node.js, npm and
|
|
;; jshint by doing the following:
|
|
|
|
;; $ apt-get install nodejs # or your distro / OS equivalent
|
|
;; $ curl http://npmjs.org/install.sh | sh
|
|
;; $ npm install -g jshint
|
|
|
|
;; You will probably want to configure the warnings that JSHint
|
|
;; produces. The full list is at http://www.jshint.com/options/ but
|
|
;; for reference I use:
|
|
|
|
;; { "browser": true, //browser constants, such as alert
|
|
;; "curly": true, // require {} on one-line if
|
|
;; "undef": true, // non-globals must be declared before use
|
|
;; "newcap": true, // constructors must start with capital letter
|
|
;; "jquery": true, // jQuery constants
|
|
;; "nomen": false, // permit leading/trailing underscores, these do actually mean private in jQuery plugins
|
|
;; "nonew": true, // don't permit object creation for side-effects only
|
|
;; "strict": true // require "use strict";
|
|
;; }
|
|
|
|
;; Save this in a file called whatever.json and then set
|
|
;; jshint-configuration-path to point to it.
|
|
|
|
;;; Usage
|
|
|
|
;; Add to your emacs config:
|
|
|
|
;; (require 'flymake-jshint)
|
|
;; (add-hook 'js-mode-hook 'flymake-mode)
|
|
|
|
;; making sure that flymake-jshint.el is on your load-path. If not,
|
|
;; also add to your config:
|
|
|
|
;; (add-to-list 'load-path "~/.emacs.d/path/to/flymake-jshint.el")
|
|
|
|
;;; Debugging
|
|
|
|
;; If JSHint isn't working for any reason, execute
|
|
|
|
;; M-x set-variable flymake-log-level <RET> 3
|
|
|
|
;; and you will see what is going wrong listed in the *Messages*
|
|
;; buffer.
|
|
|
|
(require 'flymake)
|
|
|
|
|
|
(defcustom jshint-configuration-path nil
|
|
"Path to a JSON configuration file for JSHint."
|
|
:type 'string
|
|
:group 'flymake-jshint)
|
|
|
|
|
|
(defun flymake-jshint-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))))
|
|
(if jshint-configuration-path
|
|
(list "jshint" (list local-file "--config" (expand-file-name jshint-configuration-path)))
|
|
(list "jshint" (list local-file)))))
|
|
|
|
|
|
|
|
(setq flymake-allowed-file-name-masks
|
|
(cons '(".+\\.js$"
|
|
flymake-jshint-init
|
|
flymake-simple-cleanup
|
|
flymake-get-real-file-name)
|
|
flymake-allowed-file-name-masks))
|
|
|
|
|
|
(setq flymake-err-line-patterns
|
|
(cons '("^\\(.*\\): line \\([[:digit:]]+\\), col \\([[:digit:]]+\\), \\(.+\\)$"
|
|
1 2 3 4)
|
|
flymake-err-line-patterns))
|
|
|
|
; load flymake automatically in JavaScript mode
|
|
(add-hook 'js-mode-hook 'flymake-mode)
|
|
|
|
(provide 'flymake-jshint)
|
|
|
|
;;; flymake-jshint.el ends herep
|