A JS Foundation Project

Use sonarwhal to improve your website

sonarwhal is a linting tool that will help you with your site's accessibility, speed, security and more, by checking your code for best practices and common errors.

Nellie the Narwhal

Why use sonarwhal?

Fully customizable

Every site is different. sonarwhal adapts its feedback when you give it more information: ignore 3rd-party code, prioritize your users' browsers, and control the results with minimal setup.

User guide

Create your own rules

With the help of our contributor guide, you can create new rules to suit your needs. You can help sonarwhal help even more people like you by contributing your rules back!

Rule documentation

Community driven

sonarwhal welcomes anyone who wants to make the web a better place. Testing, filing issues and feature requests, contributing code, and improving the documentation are just the start!

sonarwhal github

Run sonarwhal from your CLI

sonarwhal cli

If you want to disable specific rules, further configure others, ignore domains, or more, run sonarwhal from your CLI.

Quick start guide:

>npm install -g --engine-strict sonarwhal

>sonarwhal --init

>sonarwhal https://awesomesite.com

Get Started