stylelint / .github

Stylelint org-wide GitHub settings

Stylelint

A mighty CSS linter that helps you avoid errors and enforce conventions.

Features

It's mighty as it:

• has over 100 built-in rules for modern CSS syntax and features
• supports plugins so you can create your own custom rules
• automatically fixes problems where possible
• supports shareable configs that you can create or extend
• can be customized to your exact needs
• has 15k unit tests making it robust
• is trusted by companies worldwide like Google and GitHub

And it can be extended to:

• extract embedded styles from HTML, Markdown and CSS-in-JS template literals
• parse CSS-like languages like SCSS, Sass, Less and SugarSS

How it'll help you

It'll help you avoid errors, for example:

• invalid things, e.g. malformed grid areas
• valid things that are problematic, e.g. duplicate selectors
• unknown things, e.g. misspelled property names

And enforce conventions, for example:

• disallow things, e.g. specific units
• enforce naming patterns, e.g. for custom properties
• set limits, e.g. the number of ID selectors
• specify notations, e.g. for modern color functions

We recommend using a pretty printer like Prettier alongside Stylelint. Linters and pretty printers are complementary tools that work together to help you write consistent and error-free code.

Example output

Guides

• User guide
  • Getting started
  • Customizing
  • Configuring
  • Rules
  • Ignoring code
  • CLI
  • Node.js API
  • PostCSS plugin
  • Options
  • Errors & warnings
• Developer guide
  • Writing rules
  • Writing plugins
  • Writing custom syntaxes
  • Writing custom formatters
  • Writing system tests
• Migration guide
  • Migrating to 16.0.0
  • Migrating to 15.0.0
  • Migrating to 14.0.0
• Maintainer guide
  • Managing issues
  • Managing pull requests
  • Performing releases
• About
  • Vision
  • Semantic versioning

Contributors

Stylelint is maintained by volunteers. Without the code contributions from all these fantastic people, Stylelint would not exist. Become a contributor.

Sponsors

Thank you to all our sponsors! Become a sponsor.

Backers

Thank you to all our backers! Become a backer.

Website hosting

License

The MIT License.

.github's Issues

Remove npm update hack for Node.js. 14 on Windows

Node.js 14 will reach EOL on 2023-04-30. Then, we can remove the following hack:

.github/.github/workflows/test.yml

Lines 44 to 47 in d36a2eb

	# HACK: See https://github.com/npm/cli/issues/4341
	- name: Workaround for npm installation failure on Node.js 14 and Windows
	if: ${{ startsWith(matrix.node-version, '14') && startsWith(matrix.os, 'windows') }}
	run: npm install --global [email protected]

Ref:

• npm/cli#4341
• #15 (comment)
• https://github.com/nodejs/release#release-schedule

0x07c12a725e681ae9cf597ca350eead89b7b2e280

Describe the documentation issue

What solution would you like to see?

0x07c12a725e681ae9cf597ca350eead89b7b2e280

Switch npm v8 to npm v9 on CI testing

See 7bf8053 and stylelint/stylelint#6464 for details.

.github/.github/workflows/test.yml

Lines 45 to 46 in 7bf8053

	# TODO: npm@9 is the latest, but it doesn't work on Node.js v12 and v14 with windows.
	run: npm install --global npm@8

Change label from "ready to implement" to "ask to implement"

The stylelint/stylelint repo now has changed the "ready to implement" label to "ask to implement":

https://github.com/stylelint/stylelint/labels?q=implement

Should we apply this new label to the organization widely?

.github/labels.json

Lines 67 to 71 in 6ee1321

	{
	"name": "status: ready to implement",
	"description": "is ready to be worked on by someone",
	"color": "008672"
	},

Add `internal` label for changes only affects the hidden internals

What is the problem you're trying to solve?

As title

What solution would you like to see?

As title

Remove Node.js 14 from test workflow's default setting

Node.js 14 will be end-of-life soon (on Apr 30, 2023). So, we will be able to remove 14 from the default setting:

.github/.github/workflows/test.yml

Line 9 in 79e27f2

default: '["14", "16", "18"]'

Use YAML for GitHub Issue templates

What is the problem you're trying to solve?

An improved experience for Stylelint users when creating Stylelint bug reports

What solution would you like to see?

Switch to use YAML for the GitHub issue templates

Currently, the template is not much different to this code block:

<!-- Please answer the following. We close issues that don't. -->

> What is the problem you're trying to solve?

An improved experience for Stylelint users when creating Stylelint bug reports

> What solution would you like to see?

Switch to use YAML for the GitHub issue templates

<!--
Before posting, please check that the feature hasn't already been:
-  added in the next release (https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
-  discussed previously (https://github.com/stylelint/stylelint/search)

You can help us add the feature more quickly by:
1. Providing as much detail as possible in this issue.
2. Writing the code and submitting a PR once the feature is approved.
-->

Currently, the template is not much different to this code block:

But, it doesn't have to be this way, it can be different, it can be like this:

Props to @adalinesimonian adding this to https://github.com/stylelint/vscode-stylelint 💯

https://github.com/stylelint/vscode-stylelint/blob/main/.github/ISSUE_TEMPLATE/bug.yml

Remove Node.js 12 from CI testing

Node.js 12 is EOL. See stylelint/stylelint#6311 for details.

.github/.github/workflows/test.yml

Line 9 in 7bf8053

default: '["12", "14", "16", "18"]'