VSCode Any Lint

VSCode Any Lint allows you to lint any files with any command line tools.

Features

• Any file type
• Any command line tool

Security

This extension can execute any command line tool. If the workspace (repository) you are trying to open is completely trustworthy, it is safe to run this extension. But if not, it is very dangerous (e.g., running rm -rf / as a linter).

To eliminate such risks, this extension asks the user for authorization for each linter. The result of this authorization is stored with the linter's name, path, and argument information as keys, so if you change any of them, you will be asked to confirm again. You can reset this authorization by command Reset allowed/disallowed linter to run in this workspace.

You can disable this authorization by any-linter.disableConfirmToAllowToRun: true, but you will be asked once if you trust this workspace.

Extension Settings

• any-lint.linters: Linter settings. Please see below Linter Configuration

Linter Configuration

When change is used for on, current editing buffer is passed to spawned process by STDIN.

condition

You can write any JavaScript expression in condition. You can access below context by $ variable like $.file. This is based on VSCode Variables Reference.

Example supposes following requirements.

1. A file located at /home/your-username/your-project/folder/file.ext opened in your editor;
2. The directory /home/your-username/your-project opened as your root workspace.

Diagnostic Configuration

format

format supports below reserved placeholders

Placeholders not in above list are treated as user defined placeholders.

DiagnosticSelectors

You can write any JavaScript expression as selector. You can access below context by $ variable like $.file.

// routine pseudo code
diagnostics = []
for (diagnostic of $[`diagnostics`]) {
    file = diagnostic[`file`]
    if (diagnostic[`subDiagnostics`]) {
        for (subDiagnostic of diagnostic[`subDiagnostics`]) {
            file = subDiangostic[`file`] || file
            diagnostics.push(
                file,
                subDiangostic[`startLine`],
                subDiangostic[`startColumn`],
                subDiangostic[`endLine`],
                subDiangostic[`endColumn`],
                subDiangostic[`message`]
            )
        } 
    } else {
        diagnostics.push(
            file,
            diangostic[`startLine`],
            diangostic[`startColumn`],
            diangostic[`endLine`],
            diangostic[`endColumn`],
            diangostic[`message`]
        )
    }
}

DiagnosticAction

This is code action setting for diagnostic. There are several types supported

• openUri: this is for opening lint rule documentation
• ignore: this is for inserting ignore rule comment
• run: this is for running command to auto fix errors

You can use two variables in configurations which support JavaScript expression.

• $: the same as condition setting
• $$: diagnostic object
  • format=lines: object which consists of reserved placeholders and user defined placeholders.
  • format=json or format=yaml: When you specify subDiagnostics selector, this is sub diagnostic.

Common Configuration

openUri

ignore

Please see below example for comment location.

// startLine

// previousLine
foo // currentLine
// nextLine

rewriteLine has a different behavior. It rewrites a whole text in diagnostic range. You can access text by $$.content, line indent by $$.indent and eol by $$.eol. Typically, use below example configuration.

{
    "location": "rewriteLine",
    "comment": "`${$$.indent}// DISABLE RULE${$$.eol}${$$.content}${$$.eol}${$$.indent}// ENABLE RULE`"
}

run

Examples

Please see examples