Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thibaudcolas/pre-commit-stylelint
Mirrors all Stylelint releases for the pre-commit hooks framework.
https://github.com/thibaudcolas/pre-commit-stylelint
pre-commit-hooks stylelint
Last synced: 15 days ago
JSON representation
Mirrors all Stylelint releases for the pre-commit hooks framework.
- Host: GitHub
- URL: https://github.com/thibaudcolas/pre-commit-stylelint
- Owner: thibaudcolas
- License: mit
- Created: 2022-02-08T11:03:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T06:41:38.000Z (2 months ago)
- Last Synced: 2024-10-04T15:44:34.067Z (about 1 month ago)
- Topics: pre-commit-hooks, stylelint
- Homepage:
- Size: 74.2 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-stylelint - pre-commit-stylelint - Mirrors all releases for the pre-commit hooks framework. (Tools)
README
# Stylelint mirror for pre-commit
Mirrors all* [Stylelint](https://stylelint.io/) releases for the [pre-commit](https://pre-commit.com/) hooks framework.
## Usage
Add the following to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
```
Change [rev](https://pre-commit.com/#repos-rev) to the stylelint version you want to use from the [available versions as tags](https://github.com/thibaudcolas/pre-commit-stylelint/tags).
### With additional dependencies
To use plugins or shared configurations with `stylelint`, declare them (and stylelint) with [`additional_dependencies`](https://pre-commit.com/#config-additional_dependencies):
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
additional_dependencies:
# stylelint itself needs to be here when using additional_dependencies.
- [email protected]
- [email protected]
# Package names starting with `@` need to be quoted.
- "@scope/[email protected]"
```
### With additional stylelint options
Use pre-commit’s [`args`](https://pre-commit.com/#config-args):
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
args: [--report-needless-disables, --report-invalid-scope-disables]
```
### Automatically fix issues
Stylelint supports a [`--fix`](https://stylelint.io/user-guide/usage/cli#--fix) option that will automatically fix the code. This requires the [`args`](https://pre-commit.com/#config-args) option:
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
args: [--fix]
```
### File types
By default, this hook will run stylelint for the following file extensions: `.css`, `.sass`, `.scss`. If you want to change this, use [`files`](https://pre-commit.com/#config-files):
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
files: \.(scss|vue)$
```
## Migrating from `awebdeveloper/pre-commit-stylelint`
Compared to [awebdeveloper/pre-commit-stylelint](https://github.com/awebdeveloper/pre-commit-stylelint), this repository makes it possible to control the stylelint version with the `rev` property. This tiny difference removes the guesswork of trying to understand how to set up the hook.
Switching is just a matter of updating the `repo`, and setting a `rev` for the desired version:
```diff
-- repo: https://github.com/awebdeveloper/pre-commit-stylelint
- rev: c4c991cd38b0218735858716b09924f8b20e3812
+- repo: https://github.com/thibaudcolas/pre-commit-stylelint
+ rev: v14.4.0
hooks:
- id: stylelint
```
### With an unavailable stylelint versions
\* some versions of stylelint may be missing, though this isn’t the case as of June 2024 (v16.6.1 and below). This repository doesn’t automatically mirror patch releases to older versions of Stylelint, when they get released after another version with a "bigger" version number. If this happens, please [open an issue](https://github.com/thibaudcolas/pre-commit-stylelint/issues/new) so we manually add the release to the mirror.
As a temporary workaround, you can configure pre-commit to install from any arbitrary version of stylelint with [`additional_dependencies`](https://pre-commit.com/#config-additional_dependencies):
```yaml
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v14.4.0
hooks:
- id: stylelint
additional_dependencies:
# v14.16.43 isn’t available as a tag, so we instead load it directly from npm:
- [email protected]
```
## Why this mirror exists
pre-commit itself has poor support for the Node ecosystem, preferring to install projects with git rather than using packages as published. Setting up a mirror completely sidesteps those issues, and results in [much faster installation times](https://github.com/thibaudcolas/pre-commit-stylelint/discussions/1).
See:
- [Document pre-commit framework integration stylelint/stylelint#5373](https://github.com/stylelint/stylelint/issues/5373)
- [Add mirror for stylelint pre-commit/pre-commit#1768](https://github.com/pre-commit/pre-commit/issues/1768)
- [Suggestion: move pre-commit support to another repo prettier/prettier#8925](https://github.com/prettier/prettier/issues/8925)
- [Chore: Add .pre-commit-hooks.yaml file eslint/eslint#13628](https://github.com/eslint/eslint/pull/13628)
## Credits
This repository is based on [mirrors-prettier](https://github.com/pre-commit/mirrors-prettier), with the hook configuration options of [awebdeveloper/pre-commit-stylelint](https://github.com/awebdeveloper/pre-commit-stylelint).