Documentation

Create Package

Linter Control Comments

linter-control-comments

By Katrin Leinweber

A collection of linter control comments (currently: Golint, Rubocop, Clippy, and Shellcheck)

development

linter

ruby

rust

shell

Paste this command in a terminal to install the package

espanso install linter-control-comments

Description

Source

Linter Control Comments

A collection of linter control comments for:

Language

Linter

Ruby

Rust

Shell

How to use

Copy a particular linting rule name (from docs, terminal output, etc.).
Triggering the espansion. Most
replace
ments use the
{{clipboard}}
.

Trigger composition

Symbol

Why that one in particular?

#

Comment symbol for the relevant language.

rb

Abbreviated name of the linter, ideally following its syllables.

d

First letter of the linter's keyword

This hopefully helps to reuse existing muscle memory, from having already used these linters manually.

Espansions

Trigger

Replace

/nol

//nolint:{{clipboard}}

/noa

//nolint:all

#rcd

# rubocop:disable {{clipboard}}

#rce

# rubocop:enable {{clipboard}}

#rct

# rubocop:todo {{clipboard}}

#cla

#[allow({{clipboard}})]

#clw

#[warn({{clipboard}})]

#cld

#[deny({{clipboard}})]

#clp

#![deny(clippy::pedantic)]

#scd

# shellcheck disable={{clipboard}}

package.yml

global_vars:
  - name: "clipboard"
    type: "clipboard"

matches:

  ### Go
  # https://golangci-lint.run/usage/false-positives/#nolint-directive
  - trigger: "/nol"
    replace: "//nolint:{{clipboard}}"
  - trigger: "/noa"
    replace: "//nolint:all"

  ### Ruby
  # https://docs.rubocop.org/rubocop/configuration.html#disabling-cops-within-source-code
  - trigger: "#rcd"
    replace: "# rubocop:disable {{clipboard}}"
  - trigger: "#rce"
    replace: "# rubocop:enable {{clipboard}}"
  - trigger: "#rct"
    replace: "# rubocop:todo {{clipboard}}"

  ### Rust
  # https://doc.rust-lang.org/stable/clippy/usage.html#lint-configuration
  # https://github.com/rust-lang/rust-clippy?tab=readme-ov-file#allowingdenying-lints
  - trigger: "#cla"
    replace: "#[allow({{clipboard}})]"
  - trigger: "#clw"
    replace: "#[warn({{clipboard}})]"
  - trigger: "#cld"
    replace: "#[deny({{clipboard}})]"
  - trigger: "#clp"
    replace: "#![deny(clippy::pedantic)]" # prone to false positives!

  ### Shell
  # https://github.com/koalaman/shellcheck/blob/master/shellcheck.1.md#directives
  - trigger: "#scd"
    replace: "# shellcheck disable={{clipboard}}"

Made with