Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vbauer/lein-jslint
A Leiningen plugin for running javascript code through JSLint
https://github.com/vbauer/lein-jslint
clj clojure jslint lein leiningen
Last synced: 2 months ago
JSON representation
A Leiningen plugin for running javascript code through JSLint
- Host: GitHub
- URL: https://github.com/vbauer/lein-jslint
- Owner: vbauer
- License: epl-1.0
- Created: 2014-05-12T20:01:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-17T13:16:06.000Z (about 6 years ago)
- Last Synced: 2024-09-28T17:40:53.628Z (3 months ago)
- Topics: clj, clojure, jslint, lein, leiningen
- Language: Clojure
- Homepage:
- Size: 53.7 KB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
lein-jslint
===========
[JSLint](https://github.com/reid/node-jslint) is a static code analysis tool used in software development for checking if JavaScript source code complies with coding rules.
[lein-jslint](https://github.com/vbauer/lein-jslint) is a Leiningen plugin for running javascript code through JSLint.
[](https://travis-ci.org/vbauer/lein-jslint)
[](https://clojars.org/lein-jslint)
Pre-requirements
================
Install [NodeJS](http://nodejs.org/) and [NPM](https://github.com/npm/npm) (package manager for Node) to install JSHint:
- On Ubuntu: `sudo apt-get install nodejs`
- On Mac OS X: `brew install node`
Installation
============
Install [JSLint](https://www.npmjs.org/package/jslint) to use lein-jslint plugin. It could be done in few ways:
- Use NPM to install JSLint globally: `npm install jslint -g`
- You can also install JSLint in the current directory: `npm install jslint`
- Use [lein-npm](https://github.com/bodil/lein-npm) plugin: `lein npm install`
- Use just Leiningen: `lein deps`
Setup
-----
To enable lein-jslint for your project, put the following in the :plugins vector of your project.clj file:
```clojure
; Use latest version instead of "X.X.X"
:plugins [[lein-jslint "X.X.X"]]
```
Configuration
=============
You can specify places, where JS files will be located with:
```clojure
:jslint {
:includes ["resources/public/js/*.js"
"resources/js/*.js"]
}
```
You can also specify JS files that should be excluded from checking:
```clojure
:jslint { :excludes ["resources/public/lib/*.js"] }
```
To specify *:includes* and *:excludes* options, it is possible to use Glob Patterns.
JSLint rules could be configured with *:config* parameter:
```clojure
; It specifies which JSLint options to turn on or off
:jslint {
:debug true ; To debug processing
:config {:predef {"angular" "console" "$"}
:nomen true
:eqeq true
...}}
```
You can use both variants to specify keys: string values or keywords.
All available parameters are described in the official documentation [here](https://github.com/reid/node-jslint/blob/master/doc/jslint.md)
Hooks
-----
To enable this plugin in compile stage, use the following hook:
```clojure
:hooks [lein-jslint.plugin]
```
Examples
========
Detailed example
----------------
```clojure
:jslint {
:includes ["resources/public/js/*.js"]
; This configuration is used by default
:config {:confusion true
:continue true
:regexp true
:unparam true
:vars true}}
```
Another example of configuration file: [.jslintrc](https://gist.github.com/irae/2764095)
Example project
---------------
Just clone the current repository and try to play with [example project](https://github.com/vbauer/lein-jslint/tree/master/example) for better understanding how to use lein-jslint.
Unit testing
============
To run unit tests:
```bash
lein test
```
Thanks to
=========
[Douglas Crockford](http://www.crockford.com) for the great [JSLint](https://github.com/douglascrockford/JSLint) project.
Might also like
===============
* [lein-asciidoctor](https://github.com/asciidoctor/asciidoctor-lein-plugin) - A Leiningen plugin for generating documentation using Asciidoctor.
* [lein-plantuml](https://github.com/vbauer/lein-plantuml) - a Leiningen plugin for generating UML diagrams using PlantUML.
* [lein-coffeescript](https://github.com/vbauer/lein-coffeescript) - a Leiningen plugin for running CoffeeScript compiler.
* [lein-typescript](https://github.com/vbauer/lein-typescript) - a Leiningen plugin for running TypeScript compiler.
* [lein-jshint](https://github.com/vbauer/lein-jshint) - a Leiningen plugin for running javascript code through JSHint.
* [jabberjay](https://github.com/vbauer/jabberjay) - a simple framework for creating Jabber bots.
* [coderwall-clj](https://github.com/vbauer/coderwall-clj) - a tiny CoderWall client for Clojure.
License
=======
Copyright © 2014 Vladislav Bauer
Distributed under the Eclipse Public License, the same as Clojure.