jslint_wrapper_vscode.js

// The Unlicense
//
// This is free and unencumbered software released into the public domain.
//
// Anyone is free to copy, modify, publish, use, compile, sell, or
// distribute this software, either in source code form or as a compiled
// binary, for any purpose, commercial or non-commercial, and by any
// means.
//
// In jurisdictions that recognize copyright laws, the author or authors
// of this software dedicate any and all copyright interest in the
// software to the public domain. We make this dedication for the benefit
// of the public at large and to the detriment of our heirs and
// successors. We intend this dedication to be an overt act of
// relinquishment in perpetuity of all present and future rights to this
// software under copyright law.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.


/*jslint beta, node*/
/*property
    Diagnostic, DiagnosticSeverity, ProgressLocation, Warning, Window, activate,
    cancellable, character, clear, column, commands, createDiagnosticCollection,
    document, end, endsWith, exports, fsPath, getText, increment, insert,
    isEmpty, jslint, languages, line, lineAt, location, map, message, module,
    promises, push, range, rangeIncludingLineBreak, readFileSync,
    registerTextEditorCommand, replace, report, runInNewContext, selection, set,
    slice, start, subscriptions, title, uri, warnings, window, withProgress,
    writeFile
*/

"use strict";

function activate({
    subscriptions
}) {
/**
 * @param {vscode.ExtensionContext} context
 */
// This method is called when your extension is activated.
// Your extension is activated the very first time the command is executed.

// Directly print diagnostic without language-server.
// https://stackoverflow.com/questions/35581332
// /create-diagnostics-entries-without-language-server-in-visual-studio-code

    let diagnosticCollection;
    let jslint;
    let vscode;

    function jslintClear() {
        return vscode.window.withProgress({
            cancellable: false,
            location: vscode.ProgressLocation.Window,
            title: "JSLint clear warnings ..."
        }, async function (progress) {
            progress.report({
                increment: 0
            });

// Clear "Problems" tab.

            diagnosticCollection.clear();

// Wait awhile for flicker to give user visual confirmation "Problems" tab
// is refreshed.

            await new Promise(function (resolve) {
                setTimeout(resolve, 500);
            });

            progress.report({
                increment: 100
            });
        });
    }

    function jslintDisableRegion({
        document,
        selection
    }, edit) {
        let range;
        let text;
        edit.insert({
            character: 0,
            line: selection.start.line
        }, "/*jslint-disable*/\n");
        range = document.lineAt(selection.end).rangeIncludingLineBreak;
        text = document.getText(range);

// If selection-end is EOL without preceding line-break,
// then prepend line-break before directive.

        if (!text.endsWith("\n")) {
            text += "\n/*jslint-enable*/";

// If selection-end is start of a new line, then prepend directive before it.

        } else if (!selection.isEmpty && selection.end.character === 0) {
            text = "/*jslint-enable*/\n" + text;

// Append directive to selection-end.

        } else {
            text += "/*jslint-enable*/\n";
        }
        edit.replace(range, text);
    }

    function jslintIgnoreLine({
        document,
        selection
    }, edit) {
        edit.insert({
            character: document.lineAt(selection.end).range.end.character,
            line: selection.end.line
        }, " //jslint-ignore-line");
    }

    function jslintLint({
        document
    }) {
        return vscode.window.withProgress({
            cancellable: false,
            location: vscode.ProgressLocation.Window,
            title: "JSLint lint file ..."
        }, async function (progress) {
            let result;
            progress.report({
                increment: 0
            });

// Clear "Problems" tab.

            diagnosticCollection.clear();
            result = document.getText();
            result = jslint.jslint(result);
            result = result.warnings.slice(0, 100).map(function ({
                column,
                line,
                // line_source,
                message
            }) {
                return new vscode.Diagnostic(
                    // code: line_source,
                    {
                        end: {
                            character: column - 1,
                            line: line - 1
                        },
                        start: {
                            character: column - 1,
                            line: line - 1
                        }
                    },
                    `JSLint - ${message}`,
                    vscode.DiagnosticSeverity.Warning
                );
            });

// Wait awhile for flicker to give user visual confirmation "Problems" tab
// is refreshed.

            await new Promise(function (resolve) {
                setTimeout(resolve, 100);
            });

// Update "Problems" tab.

            diagnosticCollection.set(document.uri, result);
            progress.report({
                increment: 100
            });
        });
    }

// PR-429 - Add manual lint-on-save command.

    async function jslintLintAndSave({
        document
    }) {
        jslintLint({
            document
        });
        await require("fs").promises.writeFile(
            document.uri.fsPath,
            document.getText()
        );
    }

// Initialize vscode and jslint.

    vscode = require("vscode");
    diagnosticCollection = vscode.languages.createDiagnosticCollection(
        "jslint"
    );
    require("vm").runInNewContext(
        (
            "\"use strict\";"
            + require("fs").readFileSync( //jslint-ignore-line
                __dirname + "/jslint.mjs",
                "utf8"
            ).replace(
                "\nexport default Object.freeze(jslint_export);",
                "\nmodule.exports = jslint_export;"
            ).replace(
                "\njslint_import_meta_url = import.meta.url;",
                "\n// jslint_import_meta_url = import.meta.url;"
            )
        ),
        {
            module
        }
    );
    jslint = module.exports;

// Register extension commands.

    subscriptions.push(vscode.commands.registerTextEditorCommand((
        "jslint.clear"
    ), jslintClear));
    subscriptions.push(vscode.commands.registerTextEditorCommand((
        "jslint.disableRegion"
    ), jslintDisableRegion));
    subscriptions.push(vscode.commands.registerTextEditorCommand((
        "jslint.ignoreLine"
    ), jslintIgnoreLine));
    subscriptions.push(vscode.commands.registerTextEditorCommand((
        "jslint.lint"
    ), jslintLint));
    subscriptions.push(vscode.commands.registerTextEditorCommand((
        "jslint.lintAndSave"
    ), jslintLintAndSave));
}

exports.activate = activate;