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

stylelint-config-palantir

v7.4.0

Published

stylelint configuration

Downloads

1,070

Readme

stylelint-config-palantir

CircleCI npm version License

This repository contains Palantir's standard configuration for Stylelint, our preferred stylesheet linter. These rules enforce 4-space indentation, comfortable whitespace, and property ordering that mimics the CSS box model. Properly formatted CSS looks like this (blank lines optional):

.sidebar {
    display: flex;
    flex-direction: column;

    position: absolute;
    top: 0;
    bottom: 0;
    left: 0;
    z-index: 1;

    box-shadow: inset -1px 0 0 #000000;
    box-sizing: border-box;
    background-color: #ffffff;

    width: 250px;
    padding: 20px;
}

Usage

  1. Install a compatible version of stylelint (we express it as a peerDependency so you can choose a version that works for you).
npm install --save-dev stylelint stylelint-config-palantir
  1. Configure your stylelint configuration file to extend this package:
{
  "extends": "stylelint-config-palantir",
  "rules": {
    // Add overrides and additional rules here
  }
}

Linting Sass

Stylelint works with preprocessor syntaxes such as Sass and Less out of the box but an additional library and config file are suggested for true linter superpowers.

  1. Install a compatible version of stylelint-scss which provides a collection of linter rules for Sass syntax.
npm install --save-dev stylelint-scss
  1. Configure your stylelint configuration file to also extend sass.js in this package. This file configures the stylelint-scss rules and updates some existing rules to support Sass syntax.
{
  "extends": [
    "stylelint-config-palantir",
    "stylelint-config-palantir/sass.js",
  ],
  "rules": {
    // Add overrides and additional rules here
  }
}

Customization

We use a lowercase-single-dashed-names-only naming pattern for all rules that support a pattern. The regular expression for this pattern is exported as namingPattern in the main stylelint.config.js file. You can use it in your own rules like so:

const { namingPattern } = require("stylelint-config-palantir");

Maintenance

To release this package:

  1. Bump the version in package.json by opening a new PR to the master branch.
  2. Click on the Releases link at the top of the repository's homepage.
  3. Click on the "Draft a new release button".
  4. Create a new tag matching the version in package.json.
  5. Click on "Generate release notes" to list the latest commits that will be part of the release.
  6. Check the "Set as the latest release" checkbox.
  7. Publish the release.

FAQ

How do I order my CSS properties in a declaration block?

We use alphabetical ordering enforced by stylelint-order.