repository·beta·Indexed 25 days ago
https://github.com/jslint-org/jslintJSLint is a JavaScript code quality and coverage tool designed to enforce coding standards and identify potential issues in source code. It provides a core jslint() API for analysis, supports V8 coverage reports, and offers integrations for CodeMirror, Vim, and VSCode. The tool can be run via Node.js in the shell or imported as an ES Module or CommonJS module. It supports configuration through an options object or in-code directives such as /*global*/ and /*jslint-disable*/.
To use JSLint in Vim:
jslint.mjs and jslint_wrapper_vim.vim to your ~/.vim/ directory.source ~/.vim/jslint_wrapper_vim.vim to your ~/.vimrc.:SaveAndJslint command or the key combination <Ctrl-S> <Ctrl-J> to lint the current file.You can run JSLint from your terminal by passing a JavaScript file as an argument to jslint.mjs using Node.js.
#!/bin/sh
printf "console.log('hello world');\n" > hello.js
node jslint.mjs hello.jsTo use JSLint within a CodeMirror editor, follow these steps:
jslint.mjs and jslint_wrapper_codemirror.js.jslint.mjs as a module in your HTML with the query parameter ?window_jslint=1.jslint_wrapper_codemirror.js as a deferred script.lint: { lintOnChange: true, options: { ... } }.lintJslintBefore event to set configuration (like globals or node mode).lintJslintAfter event to access options.result and render the report using window.jslint.jslint_report(options.result).To install JSLint, download the jslint.mjs file directly from the official source.
#!/bin/sh
curl -L https://www.jslint.com/jslint.mjs > jslint.mjsTo run JSLint on all files in a directory, pass the directory path to jslint.mjs.
# JSLint directory '.'
node jslint.mjs .To use JSLint in VSCode:
vscode-jslint extension from the VSCode Marketplace.[JSLint - Lint File].Ctrl + Shift + J, then LCmd + Shift + J, then Ljslint.mjs. Pass the v8_coverage_report option followed by the target directory, then provide any necessary --exclude or --include flags, and finally the command you wish to run (e.g., npm run test).You can suppress specific JSLint warnings using directives in your source code:
/*jslint-disable*/: Disables JSLint for the following block of code./*jslint-enable*/: Re-enables JSLint after a /*jslint-disable*/ directive.//jslint-ignore-line: Ignores all warnings for the current line.//jslint-quiet: Similar to ignore-line, used to suppress warnings on a specific line.Use the jslint.v8CoverageReportCreate() method to generate a V8 coverage report programmatically. This method accepts an options object containing:
coverageDir: The directory where the report will be saved.processArgv: An array of strings representing the command-line arguments, including JSLint flags (like --exclude or --include) and the command to execute (e.g., ['npm', 'run', 'test']).import jslint from "../jslint.mjs";
await jslint.v8CoverageReportCreate({
coverageDir: "../.artifact/coverage_sqlite3_js/",
processArgv: [
"--exclude=test/**/*.js",
"--include=lib/**/*.js",
"npm", "run", "test"
]
});To generate an HTML report programmatically, pass the result of jslint.jslint() into jslint.jslint_report(). The returned string can then be wrapped in HTML tags and written to a file.
/*jslint devel*/
import jslint from "./jslint.mjs";
import fs from "fs";
(async function () {
let result;
let source = "function foo() {console.log('hello world');}\n";
// Create JSLint report from <source> in javascript.
result = jslint.jslint(source);
result = jslint.jslint_report(result);
result = `<body class="JSLINT_ JSLINT_REPORT_">
${result}</body>
`;
await fs.promises.mkdir(".artifact/", {recursive: true});
await fs.promises.writeFile(".artifact/jslint_report_hello.html", result);
console.error("wrote file .artifact/jslint_report_hello.html");
}());jslint function is the primary entry point for analyzing JavaScript code. It parses a source file and returns an object containing analysis results. You can optionally pass an options object to configure the linting behavior.