https://github.com/bmatcuk/stylelint-lsp

A stylelint Language Server
https://github.com/bmatcuk/stylelint-lsp

Last synced: about 1 year ago
JSON representation

A stylelint Language Server

• Host: GitHub
• URL: https://github.com/bmatcuk/stylelint-lsp
• Owner: bmatcuk
• License: mit
• Created: 2019-07-20T00:39:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-14T01:32:51.000Z (over 1 year ago)
• Last Synced: 2025-03-30T04:10:00.254Z (about 1 year ago)
• Language: TypeScript
• Size: 575 KB
• Stars: 48
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Release](https://img.shields.io/npm/v/stylelint-lsp.svg)](https://www.npmjs.com/package/stylelint-lsp)

[![Build Status](https://github.com/bmatcuk/stylelint-lsp/actions/workflows/test.yml/badge.svg)](https://github.com/bmatcuk/stylelint-lsp/actions)

[![codecov.io](https://img.shields.io/codecov/c/github/bmatcuk/stylelint-lsp.svg?branch=master)](https://codecov.io/github/bmatcuk/stylelint-lsp?branch=master)

# stylelint-lsp

stylelint-lsp is an implementation of the [Language Server Protocol] for

[stylelint]. It supports the following features:

* Document formatting, like running `stylelint --fix` on the file.

* Commands to disable stylelint rules inline, above the line, for the entire

  file, or surrounding a block.

* Linting on change or on save

Formatting (ie, `stylelint --fix`) can be configured to run automatically on

save, in response to format requests, or run manually using a command.

## Client Implementations

* [coc-stylelintplus]: a client for [coc.nvim]

* [nvim-lspconfig]: configs for [neovim]'s built-in lsp support

## Settings

* **autoFixOnFormat** (default `false`) - automatically apply fixes in response

  to format requests.

* **autoFixOnSave** (default `false`) - automatically apply fixes on save.

* **config** (default `null`) - stylelint config to use.

* **configFile** (default `null`) - path to stylelint config file.

* **enable** (default `true`) - if false, disable linting and auto-formatting.

* **validateOnSave** (default `false`) - lint on save.

* **validateOnType** (default `true`) - lint after changes.

If neither **config** nor **configFile** are specified, stylelint will attempt

to automatically find a config file based on the location of the file you are

editing.

If both **validateOnSave** and **validateOnType** are set to `false`, no

linting will occur but auto-fixes can still be applied if you have it enabled.

**validateOnSave** is automatically enabled if you enable **autoFixOnSave**

because revalidation must occur after fixes are applied. You may wish to

explicitly turn on **validateOnSave** if you are using another editor extension

that will make changes to the file on save, otherwise, diagnostic messages from

stylelint may be out-of-date after a save (ie, may point to the wrong line or

may have been fixed by the automatic changes on save, etc).

Note that v2 of stylelint-lsp no longer supports **configOverrides** because

the latest version of stylelint no longer supports it.

## Inspiration

Some ideas were borrowed from [vscode-eslint] and [coc-eslint].

[Language Server Protocol]: https://microsoft.github.io/language-server-protocol/

[coc-eslint]: https://github.com/neoclide/coc-eslint

[coc-stylelintplus]: https://github.com/bmatcuk/coc-stylelintplus

[coc.nvim]: https://github.com/neoclide/coc.nvim

[neovim]: https://github.com/neovim/neovim

[nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig

[stylelint]: https://stylelint.io/

[vscode-eslint]: https://github.com/Microsoft/vscode-eslint