jshint - npm Package Compare versions

Comparing version 0.9.1 to 1.0.0

package.json

 {
-  "name": "jshint",
-  "version": "0.9.1",
-  "description": "A CLI for JSHint",
-  "homepage": "http://github.com/jshint/node-jshint",
-  "author": {
-    "name": "Brent Lintner",
-    "email": "[e-mail]",
-    "url": "http://github.com/brentlintner"
-  },
-  "licenses": [{
-    "type": "MIT",
-    "url": "http://www.opensource.org/licenses/mit-license.php"
-  }],
-  "bin": { "jshint": "./bin/hint" },
-  "main": "packages/jshint/jshint",
-  "files": [
-    "packages/jshint/README.markdown",
-    "packages/jshint/jshint.js",
-    "README.md",
-    "LICENSE",
-    "bin/hint",
-    "lib"
-  ],
-  "dependencies": {
-    "cli": "0.4.3",
-    "minimatch": "0.0.x"
-  },
-  "devDependencies": {
-    "jasmine-node": "1.0.x"
-  },
-  "preferGlobal" : true
+	"name":     "jshint",
+	"version":  "1.0.0",
+	"homepage": "http://jshint.com/",
+	"description": "Static analysis tool for JavaScript",
+
+	"author": {
+		"name":  "Anton Kovalyov",
+		"email": "[e-mail]",
+		"url":   "http://anton.kovalyov.net/"
+	},
+
+	"bin": {
+		"jshint": "./bin/jshint"
+	},
+
+	"scripts": {
+		"test": "node ./make.js test",
+		"lint": "node ./make.js lint"
+	},
+
+	"main": "./src/stable/jshint.js",
+
+	"dependencies": {
+		"esprima":    "https://github.com/ariya/esprima/tarball/master",
+		"shelljs":    "*",
+		"underscore": "*",
+		"peakle":     "*",
+		"cli":        "0.4.3",
+		"minimatch":  "0.x.x"
+	},
+
+	"devDependencies": {
+		"jshint":     "*",
+		"shelljs":    "*",
+		"browserify": "*",
+		"coveraje":   "*",
+		"nodeunit":   "*",
+		"sinon":      "*"
+	},
+
+	"preferGlobal": true
 }

README.md

@@ -1,13 +0,66 @@
-# node-jshint
+JSHint, A Static Code Analysis Tool for JavaScript
+==================================================
 
-A command line interface and npm package for jshint.
+JSHint is a community-driven tool to detect errors and potential problems in
+JavaScript code and to enforce your team's coding conventions. We made JSHint
+very flexible so you can easily adjust it to your particular coding guidelines
+and the environment you expect your code to execute in.
 
-## Install
+Our goal is to help JavaScript developers write complex programs without
+worrying about typos and language gotchas.
 
-To use jshint from any location (for npm v1.x) you need to install using the global (-g) flag.
+We believe that static code analysis programs—as well as other code quality
+tools—are important and beneficial to the JavaScript community and, thus,
+should not alienate their users.
 
-    npm install -g jshint
+For general usage information, visit our website:
+[http://jshint.com/](http://jshint.com/).
 
-## Usage
+JSHint Fundraiser / Bug Bounties
+--------------------------------
 
+We're [running a fundraiser](https://www.bountysource.com/#fundraisers/91-jshint)
+for JSHint! If JSHint helps you in your day-to-day development, please consider
+donating.  All money raised on this page will be used as monetary rewards for
+fixing JSHint bugs and implementing new features. Our hope is to introduce more
+developers to JSHint hacking and boost its development.
+
+**Rules**:
+
+1. All funds (aside from fees) will be used only to fund bounties.
+2. If core team ends up fixing bounty bugs, the reward will be donated to the Electronic Frontier Foundation.
+3. Before marking bugs as fixed, all patches must be reviewed by a core team member.
+
+Thanks!
+
+Reporting a bug
+---------------
+
+To report a bug simply create a
+[new GitHub Issue](https://github.com/jshint/jshint/issues/new) and describe
+your problem or suggestion. We welcome all kind of feedback regarding
+JSHint including but not limited to:
+
+ * When JSHint doesn't work as expected
+ * When JSHint complains about valid JavaScript code that works in all browsers
+ * When you simply want a new option or feature
+
+Before reporting a bug look around to see if there are any open or closed tickets
+that cover your issue. And remember the wisdom: pull request > bug report > tweet.
+
+Installation
+------------
+
+You can install JSHint via NPM:
+
+	npm install jshint -g
+
+We also provide platform wrappers for Rhino, JavaScriptCore and Windows Script
+Host. To use them, clone this repo and run our build command:
+
+	node make.js
+
+Usage
+-----
+
     jshint -h
@@ -19,12 +72,8 @@
 
-Note: If you are using npm v1.x be sure to install jshint locally (without the -g flag) or link it globally.
+Note: If you are using npm v1.x be sure to install jshint locally (without the -g
+flag) or link it globally.
 
-## Text Editor Plugins
+Custom Reporters
+----------------
 
-* [gedit-node-jshint](https://github.com/niftylettuce/gedit-node-jshint) - Simply use CTRL+J in gedit to run JSHint using `node-jshint`.
-* [vim syntastic](https://github.com/scrooloose/syntastic) - Run node-jshint at each file save.
-* [sublime-jshint](https://github.com/uipoet/sublime-jshint) - `F7` or `command-B` on any .js file. `F4` next error line,column. `shift-F4` previous error line,column.
-
-## Custom Reporters
-
 Specify a custom reporter module (see example/reporter.js).
@@ -42,32 +91,44 @@
 
-## Configuration Options
+Configuration Options
+---------------------
 
-**Note:** This behavior described below is very different from versions prior to `0.6`.
+**Note:** This behavior described below is very different from versions
+prior to `0.6`.
 
-The CLI uses the default options that come with JSHint. 
+The CLI uses the default options that come with JSHint. Only one extra
+option is unique to the CLI version of JSHint: `globals` allows you to
+define an object of globals that get ignored for every file.
 
-Only one extra option is unique to node-jshint: `globals` 
-allows you to define an object of globals that get ignored for every file.
-To see an example you can look at how whitelisted globals are defined
-in the [jshint code](https://github.com/jshint/jshint/blob/c047ea1b01097fcc220fcd1a55c41f67ae2e6e81/jshint.js#L556)
+To have your own configuration apply, there are several methods you can
+use:
 
-To have your own configuration apply, there are several methods you can use:
-
 ### Specify Manually
 
-Setting the `--config=/path/to/your/config` command line option to specify your own configuration file outside of the directory tree for your project.
+Setting the `--config=/path/to/your/config` command line option to specify
+your own configuration file outside of the directory tree for your project.
 
 ### Within your Project's Directory Tree
 
-When the CLI is called, and a configuration file isn't specified already, `node-jshint` will attempt to locate one for you starting in `pwd`. (or "present working directory") If this does not yield a `.jshintrc` file, it will move one level up (`..`) the directory tree all the way up to the filesystem root. If a file is found, it stops immediately and uses that set of configuration.
+When the CLI is called, and a configuration file isn't specified already,
+`node-jshint` will attempt to locate one for you starting in `pwd`. (or
+"present working directory") If this does not yield a `.jshintrc` file,
+it will move one level up (`..`) the directory tree all the way up to
+the filesystem root. If a file is found, it stops immediately and uses
+that set of configuration.
 
-This setup allows you to set up **one** configuration file for your entire project. (place it in the root folder) As long as you run `jshint` from anywhere within your project directory tree, the same configuration file will be used.
+This setup allows you to set up **one** configuration file for your entire
+project. (place it in the root folder) As long as you run `jshint` from
+anywhere within your project directory tree, the same configuration file
+will be used.
 
 ### Home Directory
 
-If all the methods above do not yield a `.jshintrc` to use, the last place that will be checked is your user's `$HOME` directory.
+If all the methods above do not yield a `.jshintrc` to use, the last place
+that will be checked is your user's `$HOME` directory.
 
 ## File Extensions
 
-Default extension for files is ".js". If you want to use JSHint with other file extensions (.json), you need to pass this extra extension as an option :
+Default extension for files is ".js". If you want to use JSHint with other
+file extensions (.json), you need to pass this extra extension as an
+option:
 
@@ -78,17 +139,149 @@ --extra-ext .json
 
-If there is a .jshintignore file in your project's directory tree, (also provided you run `jshint` from within your project's directory) then any directories or files specified will be skipped over. (behaves just like a `.gitignore` file)
+If there is a .jshintignore file in your project's directory tree, (also
+provided you run `jshint` from within your project's directory) then any
+directories or files specified will be skipped over. (behaves just like
+a `.gitignore` file)
 
-**Note:** Pattern matching uses minimatch, with the nocase [option](https://github.com/isaacs/minimatch). When there is no match, it performs a left side match (when no forward slashes present and path is a directory).
+**Note:** Pattern matching uses minimatch, with the nocase
+[option](https://github.com/isaacs/minimatch). When there is no match,
+it performs a left side match (when no forward slashes present and path
+is a directory).
 
-## Installing dependencies for development
+Using JSHint as a library
+-------------------------
 
-    ./configure
+It is easy to use JSHint as a JavaScript library. Just install the package
+with NPM and, in your code, import a global `JSHINT` function:
 
-## Build Commands
+    var JSHINT = require("jshint").JSHINT;
 
-    jake -T
+This function takes two parameters. The first parameter is either a string
+or an array of strings. If it is a string, it will be split on '\n' or
+'\r'. If it is an array of strings, it is assumed that each string
+represents one line. The source can be a JavaScript text or a JSON text.
 
-## Project Guidelines
+The second parameter is an optional object of options which control the
+operation of JSHINT. Most of the options are booleans: they are all
+optional and have a default value of false.
 
-* All tests are passing.
-* No (new) JSHint errors are introduced.
+The third parameter is an object of global variables, with keys as names
+and a boolean value to determine if they are assignable.
+
+If it checks out, JSHINT returns true. Otherwise, it returns false.
+
+If false, you can inspect JSHINT.errors to find out the problems.
+JSHINT.errors is an array of objects containing these members:
+
+    {
+      line      : The line (relative to 1) at which the lint was found
+      character : The character (relative to 1) at which the lint was found
+      reason    : The problem
+      evidence  : The text line in which the problem occured
+      scope     : The scope of the problem.
+      raw       : The raw message before the details were inserted
+      a         : The first detail
+      b         : The second detail
+      c         : The third detail
+      d         : The fourth detail
+    }
+
+If a fatal error was found, a null will be the last element of the
+JSHINT.errors array.
+
+You can request a data structure which contains JSHint's results.
+
+    var myData = JSHINT.data();
+
+It returns a structure with this form:
+
+    {
+      errors: [
+        {
+          line       : NUMBER,
+          character  : NUMBER,
+          reason     : STRING,
+          evidence   : STRING
+        }
+      ],
+        functions: [
+        name         : STRING,
+        line         : NUMBER,
+        character    : NUMBER,
+        last         : NUMBER,
+        lastcharacter: NUMBER,
+        param        : [ STRING ],
+        closure      : [ STRING ],
+        var          : [ STRING ],
+        exception    : [ STRING ],
+        outer        : [ STRING ],
+        unused       : [ STRING ],
+        global       : [ STRING ],
+        label        : [ STRING ]
+      ],
+      globals: [
+        STRING
+      ],
+      member: {
+        STRING: NUMBER
+      },
+      unused: [
+        {
+          name       : STRING,
+          line       : NUMBER
+        }
+      ],
+      implieds: [
+        {
+          name: STRING,
+          line: NUMBER
+        }
+      ],
+      urls: [
+        STRING
+      ],
+      json: BOOLEAN
+    }
+
+Empty array will not be included.
+
+
+FAQ
+---
+
+#### How do I turn off "mixed tabs and spaces" warning?
+
+If you're using so-called [smart tabs](http://www.emacswiki.org/SmartTabs)
+then we have an option `smarttabs` for you. Otherwise, your solution is to
+run JSHint with a custom reporter that discards any warnings you don't like.
+For example, this [example reporter](https://gist.github.com/3885619)
+discards all warnings about mixed tabs and spaces.
+
+Contributing
+------------
+
+Look for a file named `CONTRIBUTING.md` in this repository. It contains our
+contributing guidelines. We also have
+[a mailing list](http://groups.google.com/group/jshint/).
+
+License
+-------
+
+JSHint is distributed under the MIT License. One file and one file only
+(src/stable/jshint.js) is distributed under the slightly modified MIT License.
+
+Attribution
+-----------
+
+Core Team members:
+
+ * [Anton Kovalyov](http://anton.kovalyov.net/) ([@valueof](http://twitter.com/valueof))
+ * [Wolfgang Kluge](http://klugesoftware.de/) ([blog](http://gehirnwindung.de/))
+ * [Josh Perez](http://www.goatslacker.com/) ([@goatslacker](http://twitter.com/goatslacker))
+ * [Brent Lintner](http://brentlintner.heroku.com/) ([@brentlintner](http://twitter.com/brentlintner))
+
+Maintainer: Anton Kovalyov
+
+Thank you!
+----------
+
+We really appreciate all kind of feedback and contributions. Thanks for using and supporting JSHint!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

HTTP dependency

Supply chain risk

Contains a dependency which resolves to a remote HTTP URL which could be used to inject untrusted code and reduce overall package reliability.

Found 1 instance in 1 package

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

Found 3 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2235420

increased by1047.01%

Number of package files

150

increased by1150%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by25%

Lines of code

34870

increased by638.46%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

285

increased by209.78%

Worsened metrics

Dependency count

6

increased by200%

Dev dependency count

6

increased by500%

Number of medium quality alerts

3

increased byInfinity%

Number of high supply chain risk alerts

2

increased byInfinity%

Number of low supply chain risk alerts

13

increased by160%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedesprima@https://github.com/ariya/esprima/tarball/master

• + Addedpeakle@*

• + Addedshelljs@*

• + Addedunderscore@*

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinterpret@1.4.0(transitive)

• + Addedis-core-module@2.15.1(transitive)

• + Addedlru-cache@2.7.3(transitive)

• + Addedminimatch@0.4.03.1.2(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpeakle@0.0.1(transitive)

• + Addedrechoir@0.6.2(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedshelljs@0.8.5(transitive)

• + Addedsigmund@1.0.1(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedunderscore@1.13.7(transitive)

• + Addedwrappy@1.0.2(transitive)

• - Removedlru-cache@1.0.6(transitive)

• - Removedminimatch@0.0.5(transitive)

• Updatedminimatch@0.x.x