jslint-cli
v20201106.0.0
Published
Command line interface for JSLint, the JavaScript code quality tool
Downloads
304
Maintainers
Readme
JSLint command-line interface
This package provides a command-line interface for JSLint.
The command jslint
runs JSLint on each file given on the command line and
outputs the list of warnings produced, if any. The format of the warnings
is compatible with JSHint. Consequently, existing problem matchers
for JSHint will work without changes.
This package differs from existing offerings in that
- its major version number is equal to the JSLint »edition«
- it is automatically updated when a new edition of JSLint is released
- it contains unaltered JSLint source code
- the code is itself JSLint-clean
- it prints property directives automatically when they are incomplete
- the output is compatible to JSHint
- it can be used as a module inside another application (both a CommonJS module and an ECMAScript 6 module are provided)
- it uses Douglas Crockford's parseq for parallelism
- there is no support for a configuration file
Versioning
The major version number of this package indicates the JSLint »edition« it contains. Multiple updates to JSLint on a single day are represented by increasing minor version numbers. The patch version indicates updates to this package itself.
Synopsis
jslint [-hpv][-g <global>][-o <option>[=<value>]] [files...]
Run JSLint on the given files and print the warnings, if any.
Options
Exit status
jslint
returns 0 if no warnings were reported, 1 if there was at least
one warning or 2 for other errors. In the event of incorrect usage, the
exit status is EX_USAGE
(64).
Example
$ jslint src/js/main.js
/src/jslint-cli/src/js/main.js: line 75, col 1, This function needs a "use strict" pragma.
/src/jslint-cli/src/js/main.js: line 101, col 1, Expected 'while' to be in a function.
/src/jslint-cli/src/js/main.js: 2 warnings.
API usage
This module can also be used from Node.js code. It is installed using
$ npm install jslint-cli
The module exports a single function which expects an array of command-line arguments as described above. See this module if you'd like to use JSLint itself as a Node.js module.
const jslintCli = require("jslint-cli");
jslintCli([
"-o",
"browser",
"package.json",
"some/file.js"
]);
Updating
A shell script is provided for building new packages when this project or the upstream @jkuebart/jslint is updated. It can be run using
npm run editions
This creates branches and tags based on the »edition« of the upstream project. Packages still need to be generated and published manually.
The local branches and tags can be viewed using
npm run show-branches
npm run show-tags
This can be used to automate some tasks, for example:
npm run show-branches --silent |
while read b
do
git push --set-upstream origin "${b#refs/heads/}:${b#refs/heads/}"
done
or
npm run show-tags --silent |
while read t
do
git checkout "${t#refs/tags/}"
npm install
npm publish --access public
done
To easily remove automatically created local branches and tags, use
npm run reset
There is also a shell script that determines whether the upstream project has been updated.
npm run show-branches --silent |
npm run uptodate --silent