sonarwhal is a linting tool for the web, with a strong focus on the
developer experience: easy to configure, develop, and well documented.
sonarwhal doesn’t want to reinvent the wheel. For that reason it tries
to integrate other tools and services that do a great job, and
contribute back where appropriate. For example, we are using aXe
for accessibility, SSL Server Test for checking the
certificate configuration, etc.
We have a few:
- Bring the community together to decide what best practices are in several areas.
- Help web developers write the best possible code.
- Clean up the web of bad practices.
- Promote community tools and services that do an awesome job but could not be known by everybody.
sonarwhal’s development started inside the Microsoft Edge team. Early on,
the team realized that not only the project had to be open source, but
also be community driven. The best way to achieve that was by donating
the code to the JS Foundation, have a governance model that welcomes
input for anyone in the web community (browser vendors, web experts,
and developers), and continue the work there.
There are lots of things you can do to make
sonarwhal better, from
reviewing documentation, writting new one, filling bugs, triaging,
We will gladly accept any contribution you can do. Most of the
sonarwhal should have a difficulty level.
Also don’t hesitate to ask for help.
Editor plugins are not yet available, but it is high in our priority list.
Yes! It’s in preview so there might be some intermitent issues, but you can scan an online website in here.
We are working on tweaking the list of rules it runs and its configuration, but if a rule is a recommended one it will probably be run.
Also, note that the scanner uses the
jsdom connector so there might
be unexpected results.
Our logo is Nellie the narwhal. Narwhals are not only awesome but have one of the best sonars in the animal kingdom.
Recordings of narwhal (Monodon monoceros) echolocation signals were made using a linear 16 hydrophone array in the pack ice of Baffin Bay, West Greenland in 2013 at eleven sites. An average -3 dB beam width of 5.0° makes the narwhal click the most directional biosonar signal reported for any species to date.
Great, let’s make it better! You can open an issue here telling us what you think can be improved.