deno lint, linter

deno lint [OPTIONS] [files]...

deno lint

deno lint myfile1.ts myfile2.js

deno lint --json

cat file.ts | deno lint -

cat file.ts | deno lint --json -

deno lint --rules

// deno-lint-ignore no-explicit-any

// deno-lint-ignore require-await no-empty

// deno-lint-ignore-file

Linting options Jump to heading#

--compact Jump to heading#

Output lint result in compact format.

--fix Jump to heading#

Fix any linting errors for rules that support it.

--ignore Jump to heading#

Ignore linting particular source files.

--json Jump to heading#

Output lint result in JSON format.

--rules Jump to heading#

List available rules.

--rules-exclude Jump to heading#

Exclude lint rules.

--rules-include Jump to heading#

Include lint rules.

--rules-tags Jump to heading#

Use set of rules with a tag.

Options Jump to heading#

--config Jump to heading#

Short flag: -c

Configure different aspects of deno including TypeScript, linting, and code formatting Typically the configuration file will be called deno.json or deno.jsonc and automatically detected; in that case this flag is not necessary.

--ext Jump to heading#

Specify the file extension to lint when reading from stdin.For example, use jsx to lint JSX files or tsx for TSX files.This argument is necessary because stdin input does not automatically infer the file type.Example usage: cat file.jsx | deno lint - --ext=jsx.

--no-config Jump to heading#

Disable automatic loading of the configuration file.

File watching options Jump to heading#

--no-clear-screen Jump to heading#

Do not clear terminal screen when under watch mode.

--watch Jump to heading#

Watch for file changes and restart process automatically. Only local files from entry point module graph are watched.

--watch-exclude Jump to heading#

Exclude provided files/patterns from watch mode.

Available rules Jump to heading#

For a complete list of supported rules, visit the deno_lint rule documentation.

Ignore directives Jump to heading#

File level Jump to heading#

To ignore a whole file use // deno-lint-ignore-file at the top of the file:

// deno-lint-ignore-file

function foo(): any {
  // ...
}

You can also specify the reason for ignoring the file:

// deno-lint-ignore-file -- reason for ignoring

function foo(): any {
  // ...
}

The ignore directive must be placed before the first statement or declaration:

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

/**
 * Some JS doc
 */

// deno-lint-ignore-file

import { bar } from "./bar.js";

function foo(): any {
  // ...
}

You can also ignore certain diagnostics in the whole file:

// deno-lint-ignore-file no-explicit-any no-empty

function foo(): any {
  // ...
}

If there are multiple // deno-lint-ignore-file directives, all but the first one are ignored:

// This is effective
// deno-lint-ignore-file no-explicit-any no-empty

// But this is NOT effective
// deno-lint-ignore-file no-debugger

function foo(): any {
  debugger; // not ignored!
}

Line level Jump to heading#

To ignore specific diagnostics use // deno-lint-ignore <codes...> on the preceding line of the offending line.

// deno-lint-ignore no-explicit-any
function foo(): any {
  // ...
}

// deno-lint-ignore no-explicit-any explicit-function-return-type
function bar(a: any) {
  // ...
}

You must specify the names of the rules to be ignored.

You can also specify the reason for ignoring the diagnostic:

// deno-lint-ignore no-explicit-any -- reason for ignoring
function foo(): any {
  // ...
}

Ignore ban-unused-ignore itself Jump to heading#

deno lint provides ban-unused-ignore rule, which will detect ignore directives that don't ever suppress certain diagnostics. This is useful when you want to discover ignore directives that are no longer necessary after refactoring the code.

In a few cases, however, you might want to ignore ban-unused-ignore rule itself. One of the typical cases would be when working with auto-generated files; it makes sense to add file-level ignore directives for some rules, and there's almost no need for detecting unused directives via ban-unused-ignore in this case.

You can use // deno-lint-ignore-file ban-unused-ignore as always if you want to suppress the rule for a whole file:

// deno-lint-ignore-file ban-unused-ignore no-explicit-any

// `no-explicit-any` isn't used but you'll get no diagnostics because of ignoring
// `ban-unused-ignore`
console.log(42);

Do note that ignoring ban-unused-ignore itself only works via file-level ignore directives. This means that per line directives, like // deno-lint-ignore ban-unused-ignore, don't work at all. If you want to ignore ban-unused-ignore for some special reasons, make sure to add it as a file-level ignore directive.