Linting and formatting

In an ideal world, your code is always clean, consistent, and free of pesky errors. That's the promise of Deno's built-in linting and formatting tools. By integrating these features directly into the runtime, Deno eliminates the need for external dependencies and complex configurations in your projects. These inbuilt tools are fast and performant, not only saving time but also ensuring that every line of code adheres to best practices.

With deno fmt and deno lint, you can focus on writing great code, knowing that Deno has your back. It's like having a vigilant assistant who keeps your codebase in top shape, allowing you to concentrate on what truly matters: building amazing applications.

Linting Jump to heading#

Explore all the lint rules

Linting is the process of analyzing your code for potential errors, bugs, and stylistic issues. Deno's built-in linter, deno lint, supports recommended set of rules from ESLint to provide comprehensive feedback on your code. This includes identifying syntax errors, enforcing coding conventions, and highlighting potential issues that could lead to bugs.

To run the linter, use the following command in your terminal:

deno lint

By default, deno lint analyzes all TypeScript and JavaScript files in the current directory and its subdirectories. If you want to lint specific files or directories, you can pass them as arguments to the command. For example:

deno lint src/

This command will lint all files in the src/ directory.

The linter can be configured in a deno.json file. You can specify custom rules, plugins, and settings to tailor the linting process to your needs.

Linting rules Jump to heading#

You can view and search the list of available rules and their usage on the List of rules documentation page.

Formatting Jump to heading#

Formatting is the process of automatically adjusting the layout of your code to adhere to a consistent style. Deno's built-in formatter, deno fmt, uses the powerful dprint engine to ensure that your code is always clean, readable, and consistent.

To format your code, simply execute the following command in your terminal:

deno fmt

By default, deno fmt formats all TypeScript and JavaScript files in the current directory and its subdirectories. If you want to format specific files or directories, you can pass them as arguments to the command. For example:

deno fmt src/

This command will format all files in the src/ directory.

Checking your formatting Jump to heading#

The deno fmt --check command is used to verify if your code is properly formatted according to Deno's default formatting rules. Instead of modifying the files, it checks them and reports any formatting issues. This is particularly useful for integrating into continuous integration (CI) pipelines or pre-commit hooks to ensure code consistency across your project.

If there are formatting issues, deno fmt --check will list the files that need formatting. If all files are correctly formatted, it will simply exit without any output.

Integration in CI Jump to heading#

You can add deno fmt --check to your CI pipeline to automatically check for formatting issues. For example, in a GitHub Actions workflow:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: denoland/setup-deno@v2
        with:
          deno-version: v2.x
      - run: deno fmt --check

This ensures that any code changes adhere to the project's formatting standards before being merged.

Integration in VS Code Jump to heading#

To enable Deno as your formatter in VS Code, install the Deno extension and add a .vscode/settings.json file in the root of your project that sets it as the default formatter and enables the extension for your project:

{
  "deno.enablePaths": ["./deno.json"],
  "editor.defaultFormatter": "denoland.vscode-deno",
  "editor.formatOnSave": true
}

If your deno.json(c) file is located in a subdirectory of your project, provide the correct relative path to it instead.

Configuration Jump to heading#

The formatter is configured with the fmt field in your deno.json file. See all formatting options for the full list of settings and their defaults.

Using other linters and formatters Jump to heading#

Deno's built-in deno lint and deno fmt cover most projects, but you can also run popular third-party tools without installing them globally. Because Deno runs npm packages directly, deno run -A npm:<tool> runs any of them with no separate npm install step. To save typing, add the command as a task in your deno.json and run it with deno task.

ESLint Jump to heading#

ESLint needs a flat config file, eslint.config.js. Reference its packages with npm: specifiers so Deno can resolve them:

import js from "npm:@eslint/js";
import globals from "npm:globals";

export default [
  js.configs.recommended,
  {
    files: ["**/*.ts", "**/*.js"],
    languageOptions: {
      globals: { ...globals.node, Deno: "readonly" },
    },
  },
];

Then run it over your project:

deno run -A npm:eslint .

Declaring the Node and Deno globals prevents false no-undef errors for globals such as console. For type-aware linting of TypeScript, add typescript-eslint to the config.

oxlint Jump to heading#

oxlint is a fast Rust-based linter that runs with no configuration:

deno run -A npm:oxlint@latest

It lints the current directory and prints any problems it finds:

sample.ts:3:5: warning eslint(no-unused-vars): Variable 'unused' is declared but never used.

Prettier Jump to heading#

Prettier formats your code with no configuration required:

# report files that need formatting
deno run -A npm:prettier --check .

# format files in place
deno run -A npm:prettier --write .

Biome Jump to heading#

Biome is a fast Rust-based linter and formatter in one, and also works with zero configuration:

# lint and check formatting
deno run -A npm:@biomejs/biome check .

# format files in place
deno run -A npm:@biomejs/biome format --write .

# lint only
deno run -A npm:@biomejs/biome lint .

To customize Biome, generate a biome.json with deno run -A npm:@biomejs/biome init.