From 1a07e913821df2264d42f785fe840797865bdbbb Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Mon, 18 Mar 2024 21:07:04 -0700 Subject: [PATCH 1/3] Some small typo corrections in README Couple of nit fixes: filemane -> filename genrator -> generator Signed-off-by: Eric Brown --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aaefb28..ec4f119 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The following are very important to sync analyzers with DeepSource: c. `logo.svg` file. -2. `.deepsource/issues` directory. This contains all issues detected by the analyzer. Each issue's filemane should be `.toml` or `` with the following fields: +2. `.deepsource/issues` directory. This contains all issues detected by the analyzer. Each issue's filename should be `.toml` or `` with the following fields: - `title`: Title of the issue. No periods are allowed in the title. - `category`: Category of the issue. Allowed values are: "bug-risk", "doc", "style", "antipattern", "coverage", "security", "performance", "typecheck", and, "secrets". @@ -51,7 +51,7 @@ Each file should be names as `.`. Example: `github.yml`, `c 4. `utils` directory: -It should contain all the utilities required for the analyzer like issue genrator, issue-map, etc. +It should contain all the utilities required for the analyzer like issue generator, issue-map, etc. For example, please check out `analyzers/kube-linter/utils`. 5. Add a sample sarif report from the analyzer in `tests/fixtures` directory. The file should be named as `.sarif`. From 6157ca17bce978954a4ef4638d1a55b538b4bf8c Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Mon, 18 Mar 2024 21:11:49 -0700 Subject: [PATCH 2/3] Update README.md analyzer should also analyzers directory Signed-off-by: Eric Brown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec4f119..3c6ee5c 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Hub of all open-source third-party static analyzers supported by DeepSource. Usa To add a new analyzer, create a new directory with the analyzer shortcode under the `analyzers` folder. The following are very important to sync analyzers with DeepSource: -1. `.deepsource/analyzer` directory under `analyzer/` directory. +1. `.deepsource/analyzer` directory under `analyzers/` directory. a. It should contain an `analyzer.toml` file with the following fields: From 5682ad6d58d00212ac04426961a0d05e6e8290a3 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Mon, 18 Mar 2024 21:14:18 -0700 Subject: [PATCH 3/3] Update README.md am -> an example.toml -> example_config.toml Signed-off-by: Eric Brown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c6ee5c..9cf854b 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The following are very important to sync analyzers with DeepSource: - `tool_latest_version`: Analyzer's latest version for which issues are synced on DeepSource. - `description`: A readable descrioption for this analyzer. - b. It should contain am `example.toml` file with a snippet to activate this analyzer in `.deepsource.toml` config. + b. It should contain an `example_config.toml` file with a snippet to activate this analyzer in `.deepsource.toml` config. c. `logo.svg` file.