From da51d1f477c2e9aa392554ba5c1fad271671c3a7 Mon Sep 17 00:00:00 2001 From: skarab42 Date: Tue, 9 Jan 2024 16:51:52 +0100 Subject: [PATCH] docs: add description --- README.md | 4 +++- package.json | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52d01a7..f86a320 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # @skarab/eslint-staged -This package provides a CLI tool (`eslint-staged`) designed to run ESLint on specific files, considering the files in `.eslintignore`. +Refines [lint-staged] functionality, enforcing strict adherence to ESLint's ignored file configurations. + +This package provides a CLI tool (`eslint-staged`) designed to run ESLint on staged files, considering the files in `.eslintignore` and `ignorePatterns`. It resolves the [common issue] ([1], [2]) where [lint-staged] pass files ignored by ESLint. diff --git a/package.json b/package.json index 01d51f4..d7cd958 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@skarab/eslint-staged", - "description": "My skaffolded project", + "description": "Refines lint-staged functionality, enforcing adherence to ESLint's ignored file configurations.", "version": "0.0.0-development", "license": "MIT", "author": {