Crate lintspec

Expand description

§🔎 lintspec

lintspec screenshot

Lintspec is a command-line utility (linter) that checks the completeness and validity of NatSpec doc-comments in Solidity code. It is focused on speed and ergonomics. By default, lintspec will respect gitignore rules when looking for Solidity source files.

Dual-licensed under MIT or Apache 2.0.

Note: the main branch can contain unreleased changes. To view the README information for the latest stable release, visit crates.io or select the latest git tag from the branch/tag dropdown.

§Installation

§Via `cargo`

cargo install lintspec

§Via `cargo-binstall`

cargo binstall lintspec

§Via `nix`

nix-env -iA nixpkgs.lintspec
# or
nix-shell -p lintspec
# or
nix run nixpkgs#lintspec

§Pre-built binaries and install script

Head over to the releases page!

§Usage

Usage: lintspec [OPTIONS] [PATH]... [COMMAND]

Commands:
  init  Create a `.lintspec.toml` config file with default values
  help  Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]...  One or more paths to files and folders to analyze

Options:
  -e, --exclude <EXCLUDE>        Path to a file or folder to exclude (can be used more than once)
  -o, --out <OUT>                Write output to a file instead of stderr
      --inheritdoc               Enforce that all public and external items have `@inheritdoc`
      --notice-or-dev            Do not distinguish between `@notice` and `@dev` when considering "required" validation rules
      --notice-ignored <TYPE>    Ignore `@notice` for these items (can be used more than once)
      --notice-required <TYPE>   Enforce `@notice` for these items (can be used more than once)
      --notice-forbidden <TYPE>  Forbid `@notice` for these items (can be used more than once)
      --dev-ignored <TYPE>       Ignore `@dev` for these items (can be used more than once)
      --dev-required <TYPE>      Enforce `@dev` for these items (can be used more than once)
      --dev-forbidden <TYPE>     Forbid `@dev` for these items (can be used more than once)
      --param-ignored <TYPE>     Ignore `@param` for these items (can be used more than once)
      --param-required <TYPE>    Enforce `@param` for these items (can be used more than once)
      --param-forbidden <TYPE>   Forbid `@param` for these items (can be used more than once)
      --return-ignored <TYPE>    Ignore `@return` for these items (can be used more than once)
      --return-required <TYPE>   Enforce `@return` for these items (can be used more than once)
      --return-forbidden <TYPE>  Forbid `@return` for these items (can be used more than once)
      --json                     Output diagnostics in JSON format
      --compact                  Compact output
      --sort                     Sort the results by file path
  -h, --help                     Print help (see more with '--help')
  -V, --version                  Print version

§Configuration

§Config File

Create a default configuration with the following command:

lintspec init

This will create a .lintspec.toml file with the default configuration in the current directory.

§Environment Variables

Environment variables (in capitals, with the LS_ prefix) can also be used and take precedence over the configuration file. They use the same names as in the TOML config file and use the _ character as delimiter for nested items.

Examples:

LS_LINTSPEC_PATHS=[src,test]
LS_LINTSPEC_INHERITDOC=false
LS_LINTSPEC_NOTICE_OR_DEV=true: if the setting name contains _, it is not considered a delimiter
LS_OUTPUT_JSON=true
LS_CONSTRUCTOR_NOTICE=required

§CLI Arguments

Finally, the tool can be customized with command-line arguments, which take precedence over the other two methods. To see the CLI usage information, run:

lintspec help

§Usage in GitHub Actions

You can check your code in CI with the lintspec GitHub Action. Any .lintspec.toml or .nsignore file in the repository’s root will be used to configure the execution.

The action generates annotations that are displayed in the source files when viewed (e.g. in a PR’s “Files” tab).

§Options

The following options are available for the action (all are optional if a config file is present):

Input	Default Value	Description	Example
`working-directory`	`"./"`	Working directory path	`"./src"`
`paths`	`"[]"`	Paths to scan, relative to the working directory, in square brackets and separated by commas. Required unless a `.lintspec.toml` file is present in the working directory.	`"[path/to/file.sol,test/test.sol]"`
`exclude`	`"[]"`	Paths to exclude, relative to the working directory, in square brackets and separated by commas	`"[path/to/exclude,other/path.sol]"`
`extra-args`		Extra arguments passed to the `lintspec` command	`"--constructor=true"`
`version`	`"latest"`	Version of lintspec to use. For enhanced security, you can pin this to a fixed version	`"0.1.5"`
`fail-on-problem`	`"true"`	Whether the action should fail when `NatSpec` problems have been found. Disabling this only creates annotations for found problems, but succeeds	`"false"`

§Example Workflow

name: Lintspec

on:
  pull_request:

jobs:
  lintspec:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: beeb/lintspec@main
        # all the lines below are optional
        with:
          working-directory: "./"
          paths: "[]"
          exclude: "[]"
          extra-args: ""
          version: "latest"
          fail-on-problem: "true"

§Credits

This tool walks in the footsteps of natspec-smells, thanks to them for inspiring this project!

§Comparison with natspec-smells

§Benchmark

On an AMD Ryzen 9 7950X processor with 64GB of RAM, linting the Uniswap/v4-core src folder on WSL2 (Ubuntu), lintspec is about 214x faster, or 0.46% of the execution time:

Benchmark 1: npx @defi-wonderland/natspec-smells --include "src/**/*.sol"
  Time (mean ± σ):     12.484 s ±  0.157 s    [User: 13.581 s, System: 0.594 s]
  Range (min … max):   12.288 s … 12.817 s    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 2: lintspec src --compact=true
  Time (mean ± σ):      58.2 ms ±   1.3 ms    [User: 264.0 ms, System: 67.9 ms]
  Range (min … max):    53.9 ms …  61.3 ms    50 runs

  Warning: Ignoring non-zero exit code.

Summary
  lintspec src --compact=true ran
  214.55 ± 5.61 times faster than npx @defi-wonderland/natspec-smells --include "src/**/*.sol"

§Features

Feature	`lintspec`	`natspec-smells`
Identify missing NatSpec	✅	✅
Identify duplicate NatSpec	✅	✅
Include files/folders	✅	✅
Exclude files/folders	✅	✅
Enforce usage of `@inheritdoc`	✅	✅
Enforce NatSpec on constructors	✅	✅
Configure via config file	✅	✅
Configure via env variables	✅	❌
Respects gitignore files	✅	❌
Granular validation rules	✅	❌
Pretty output with code excerpt	✅	❌
JSON output	✅	❌
Output to file	✅	❌
Multithreaded	✅	❌
No pre-requisites (node/npm)	✅	❌

Modules§

config: Tool configuration parsing and validation
definitions: Source item definitions
error: The error and result types for lintspec
files: Find Solidity files to analyze
lint: Check the NatSpec documentation of a source file
natspec: NatSpec Comment Parser
parser: Solidity parser interface
utils: Utils for parsing Solidity source code.

Functions§

print_reports: Print the reports for a given file, either as pretty or compact text output

Crate lintspecCopy item path