Skip to content

slippy-lint/slippy

Repository files navigation

Slippy

Docs

Slippy is a linter for Solidity that's simple, powerful, and thoughtfully built.

Installation

Install it:

npm install --save-dev slippy

Initialize a config file:

npx slippy --init

Run it:

npx slippy "contracts/**/*.sol"

Why Slippy?

You can read a more detailed comparison between Slippy and Solhint, but here's a summary:

  • A single, flexible configuration that lets you easily enable or disable rules for specific parts of your codebase
  • A unified naming-convention rule
  • A more accurate no-unused-vars rule
  • Unused comment directives like // slippy-disable-line are reported
  • No formatting rules
  • Semantic versioning

Configuration

Slippy's configuration lives in a slippy.config.js file, which exports the configuration that Slippy will use to lint your code. Here’s a minimal example:

module.exports = {
  rules: {
    "no-console": "warn",
    "no-unused-vars": ["error", { ignorePattern: "^_" }],
  },
};

For more details on configuring Slippy, including advanced features like cascading configurations, file ignores, and comment directives, see the configuration documentation.

Rules

You can find the full list of available rules in the rules reference documentation.

About

A simple and powerful linter for Solidity

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5