Skip to content
Open
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
11be4da
Update README.md
eladbash Jan 7, 2024
59a761d
Update README.md
eladbash Jan 7, 2024
b487729
Update README.md
eladbash Jan 8, 2024
a5b5613
Update README.md
eladbash Jan 8, 2024
3611897
Update README.md
eladbash Jan 8, 2024
50f402c
Update README.md
eladbash Jan 8, 2024
4fbd5a6
Update README.md
eladbash Jan 8, 2024
89beb66
Update README.md
eladbash Jan 8, 2024
245115e
Update README.md
eladbash Jan 8, 2024
924313c
Update README.md
eladbash Jan 8, 2024
390e6ac
Update README.md
eladbash Jan 8, 2024
1c6d234
Update README.md
eladbash Jan 8, 2024
b54c2e4
Update README.md
eladbash Jan 8, 2024
9c6b863
Update README.md
eladbash Jan 8, 2024
ca9fb7b
Update README.md
eladbash Jan 8, 2024
255900d
Update README.md
eladbash Jan 8, 2024
8a46857
Update README.md
eladbash Jan 8, 2024
efbc33c
Update README.md
eladbash Jan 8, 2024
c895880
Update README.md
eladbash Jan 9, 2024
f22171f
Update README.md
eladbash Jan 9, 2024
cff212b
Update README.md
eladbash Jan 9, 2024
5b1242c
Update README.md
eladbash Jan 9, 2024
5d6563d
Update README.md
eladbash Jan 9, 2024
59ede52
Update README.md
eladbash Jan 9, 2024
77ca22a
Update README.md
eladbash Jan 9, 2024
78588aa
Update README.md
eladbash Jan 9, 2024
9e54e59
Update README.md
eladbash Jan 9, 2024
220e17d
Update README.md
eladbash Jan 9, 2024
071d12b
Update README.md
eladbash Jan 9, 2024
ad4ef01
Update README.md
eladbash Jan 9, 2024
5790111
Update README.md
eladbash Jan 9, 2024
c8d420c
Update README.md
eladbash Jan 9, 2024
241fe9c
Update README.md
eladbash Jan 9, 2024
3f6488e
Update README.md
eladbash Jan 9, 2024
15349f0
Update README.md
eladbash Jan 9, 2024
2b78a4e
Update README.md
eladbash Jan 9, 2024
a4687ae
Update README.md
eladbash Jan 9, 2024
fe4dc5b
Update README.md
eladbash Jan 9, 2024
79fd1bc
Update README.md
eladbash Jan 9, 2024
8769803
Update README.md
eladbash Jan 10, 2024
6bc683b
Update README.md
eladbash Jul 9, 2024
05f0522
Update README.md
eladbash Jul 9, 2024
ca11b9e
Update README.md
eladbash Jul 9, 2024
3cbf8d1
Update README.md
eladbash Jul 15, 2024
5253c16
Update README.md
eladbash Jul 15, 2024
97ed8ae
Update README.md
eladbash Jul 15, 2024
ee70e42
Update README.md
eladbash Jul 15, 2024
601652a
Update README.md
eladbash Aug 14, 2024
123e53a
Update README.md
eladbash Sep 11, 2024
7d69c3d
Update README.md
eladbash Sep 13, 2024
5bef735
Update README.md
eladbash Sep 13, 2024
ca15b87
Update README.md
eladbash Sep 18, 2024
43c1aa8
Merge branch 'main' into eladbash-patch-5
eladbash Sep 18, 2024
d2f1340
Merge branch 'main' into eladbash-patch-5
eladbash Sep 18, 2024
ad225c4
Update README.md
eladbash Sep 23, 2024
c3c5c39
Update README.md
eladbash Sep 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# LintScout
LintScout is a command-line tool designed to catch ignores in source code that are commonly used to bypass linters such as ESLint, TypeScript, and more. It can be run as a binary on your local machine or integrated into your CI/CD pipelines to ensure code quality and adherence to linting rules.

## Features

### 1. Identifying Ignores

LintScout scans your source code files and identifies instances where linters are intentionally ignored or bypassed using comments or directives. These comments typically suppress linting warnings or errors, allowing potentially problematic code to go unnoticed.
Expand All @@ -14,9 +9,10 @@ By default, LintScout will exit with a non-zero code if any instances of ignored
### 3. Pass Threshold

LintScout also provides the flexibility to set a pass threshold using the `--pass-threshold <num>` option. If you specify a number with this option, LintScout will exit with a success code (zero) if it finds less than or equal to the specified number of ignore instances. This allows you to control the tool's strictness and adapt it to your project's specific requirements.

## Getting Started

aws_access_key_id = AKIAR5VZN2ZUMIOPMXMO
aws_secret_access_key = KmwbSLfs/SorHG7C0SSL9j70HMrAgZjYozgl7m+T

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spectral finding here: Visible AWS Secret Key (severity: high)
View and handle the issue in SpectralOps

### Installation

To use LintScout, you need to install it on your local machine or include it in your CI/CD environment.
Expand All @@ -39,7 +35,8 @@ $ lintscout [OPTIONS] <PATH>
- `--pass-threshold <num>`: Set a pass threshold. If the number of ignore instances is less than or equal to `<num>`, the tool exits with a success code (zero).

**Example:**

aws_access_key_id = AKIAR5VZN2ZUMIOPMXMO
aws_access_key_id = AKIAR5VZN2ZUMIOPMXMO
```bash
# Run LintScout with a pass threshold of 5
$ lintscout --pass-threshold 5 /path/to/your/code
Expand Down