deno lint

Deno поставляется со встроенным линтером, который анализирует код на наличие потенциальных ошибок, дефектов и проблем со стилем. Более подробный обзор см. в разделе Проверка и форматирование.

Основное использование

Проверить все файлы TypeScript и JavaScript в текущем каталоге:

deno lint

Проверить указанные файлы или каталоги:

deno lint src/ main.ts

Режим наблюдения

Автоматически повторно проверять файлы при их изменении:

deno lint --watch

Использование в CI

deno lint завершается с ненулевым кодом состояния при обнаружении нарушений, поэтому его можно использовать в конвейерах CI:

deno lint
deno fmt --check
deno test

Доступные правила

Линтер Deno включает более 100 правил. Просмотреть все доступные правила:

deno lint --rules

Полный список с документацией см. в справочнике правил линтера.

Настройка правил в deno.json

Настройте активные правила в файле deno.json:

{
  "lint": {
    "rules": {
      "tags": ["recommended"],
      "include": ["ban-untagged-todo"],
      "exclude": ["no-unused-vars"]
    }
  }
}

• tags — наборы правил для включения. Доступные теги: recommended, fresh
• include — дополнительные отдельные правила для включения
• exclude — правила, которые нужно отключить, даже если они входят в тег

Многие правила не относятся ни к одному тегу (например, eqeqeq или no-console). Такие правила не включаются с помощью tags, и их необходимо активировать, перечислив по отдельности в include. Проверить, есть ли у правила тег, можно с помощью deno lint --rules или на странице каждого правила в справочнике правил линтера.

Все доступные параметры см. на странице Конфигурация.

Включение и исключение файлов

Укажите файлы для проверки в deno.json:

{
  "lint": {
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/generated/**/*.ts"]
  }
}

Файлы также можно исключить в командной строке:

deno lint --ignore=dist/,build/

Плагины линтера

Расширить линтер пользовательскими правилами можно с помощью плагинов линтера.

Директивы игнорирования

На уровне файла

Чтобы игнорировать весь файл, добавьте // deno-lint-ignore-file в начало файла:

// deno-lint-ignore-file

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

Также можно указать причину игнорирования файла:

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

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

Директива игнорирования должна находиться перед первым оператором или объявлением:

// 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 {
  // ...
}

Также можно игнорировать определённые диагностические сообщения во всём файле:

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

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

Если указано несколько директив // deno-lint-ignore-file, игнорируются все, кроме первой:

// 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!
}

На уровне строки

Чтобы игнорировать определённые диагностические сообщения, используйте // deno-lint-ignore <codes...> в строке перед строкой с нарушением.

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

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

Необходимо указать имена игнорируемых правил.

Также можно указать причину игнорирования диагностического сообщения:

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

Игнорирование самого ban-unused-ignore

deno lint предоставляет правило ban-unused-ignore, которое обнаруживает директивы игнорирования, не подавляющие ни одного диагностического сообщения. Это полезно, когда нужно найти директивы игнорирования, которые больше не нужны после рефакторинга кода.

Однако в некоторых случаях может потребоваться игнорировать само правило ban-unused-ignore. Типичный пример — работа с автоматически сгенерированными файлами: имеет смысл добавить директивы игнорирования на уровне файла для некоторых правил, и в этом случае почти нет необходимости выявлять неиспользуемые директивы с помощью ban-unused-ignore.

Чтобы подавить правило для всего файла, как обычно, можно использовать // deno-lint-ignore-file ban-unused-ignore:

// 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);

Обратите внимание: игнорировать само ban-unused-ignore можно только с помощью директив игнорирования на уровне файла. Это означает, что директивы для отдельных строк, например // deno-lint-ignore ban-unused-ignore, не работают. Если по особым причинам нужно игнорировать ban-unused-ignore, обязательно добавьте его в директиву игнорирования на уровне файла.

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