npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@hint/hint-leading-dot-classlist

v1.0.20

Published

Inform users about classList.add or classList.remove with leading '.' in the argument pitfall

Downloads

105,154

Readme

Leading '.' in classList.add or classList.remove

This hint informs users that they should to use Element.classList argument without a leading '.' as it may lead to unintended results.

Why is this important?

When writing selectors either in CSS or using DOM methods like querySelector, class names are referred to using a leading '.', e.g. document.querySelector('.foo'). However when modifying the classList of an element the raw class name is expected to be used instead, e.g. element.classList.add('foo').

Unfortunately if a leading '.' is provided to the classList APIs it will succeed without an error, treating the '.' as part of the name itself. This typically causes selectors elsewhere in the code to fail to match this element. Figuring out why can be tedious and time-consuming until the typo has been found.

What does the hint check?

This hint scans JavaScript source code to check if the argument in element.classList.add or element.classList.remove contains a leading '.'. If so it emits a warning to help save time debugging this subtle issue.

Examples that trigger the hint

const element = document.getElementById('foo');

element.classList.add('.foo');
element.classList.remove('.foo');

Examples that pass the hint

const element = document.getElementById('foo');

element.classList.add('foo');
element.classList.remove('foo');

How to use this hint?

This package is installed automatically by webhint:

npm install hint --save-dev

To use it, activate it via the .hintrc configuration file:

{
    "connector": {...},
    "formatters": [...],
    "parsers": [...],
    "hints": {
        "leading-dot-classlist": "warning"
    },
    ...
}

Note: The recommended way of running webhint is as a devDependency of your project.

Further Reading

Element.classList