2022

Author: FredHappyface

.pre-commit-config.yaml

@@ -1,28 +1,43 @@
 repos:
   - repo: https://github.com/FHPythonUtils/Blackt
-    rev: '2021'
+    rev: '2022.0.2'
     hooks:
       - id: blackt
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.9.3
+    rev: 5.10.1
     hooks:
       - id: isort
 
   - repo: https://github.com/pycqa/pylint
-    rev: v2.11.1
+    rev: v2.13.5
     hooks:
       - id: pylint
         args: [--disable=import-error,--jobs=0, --fail-under=9.8, --ignore-patterns=test.*?py]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.2.0
     hooks:
       - id: trailing-whitespace
+        exclude: "tests/"
       - id: end-of-file-fixer
+        exclude: "tests/"
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.29.0
+    rev: v2.32.0
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
+  - repo: https://github.com/boidolr/pre-commit-images
+    rev: v1.0.4
+    hooks:
+      - id: optimize-avif
+        exclude: "tests/"
+      - id: optimize-jpg
+        exclude: "tests/"
+      - id: optimize-png
+        exclude: "tests/"
+      - id: optimize-svg
+        exclude: "tests/"
+      - id: optimize-webp
+        exclude: "tests/"

CHANGELOG.md

@@ -3,6 +3,13 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2022 - 2022/04/09
+
+- Move docs
+- Exclude env/venv etc per https://github.com/FHPythonUtils/SimpleSecurity/issues/1
+- `semgrep` no longer works on windows so output message
+- Update pre-commit
+
 ## 2021.3.3 - 2021/10/26
 
 - Use pre-commit to enforce reasonable standards + consistency

DOCS/README.md

@@ -111,7 +111,7 @@ in the DOCS
 ### Generate semgrep_sec.yaml
 
 1. Clone https://github.com/returntocorp/semgrep-rules
-2. cd to project/python
+2. cd to `semgrep-rules/python`
 3. do
 
    ```bash
@@ -125,7 +125,20 @@ in the DOCS
 
 ## Documentation
 
-See the [Docs](/DOCS/) for more information.
+A high-level overview of how the documentation is organized organized will help you know
+where to look for certain things:
+
+<!--
+- [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get
+  started using the software. Start here if you’re new.
+-->
+- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
+  machinery. This documentation describes how to use the classes and functions at a lower level
+  and assume that you have a good high-level understanding of the software.
+<!--
+- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
+  may have.
+-->
 
 ## Install With PIP
 

README.md

@@ -0,0 +1,14 @@
+# Simplesecurity Modules
+
+> Auto-generated documentation modules index.
+
+Full list of [Simplesecurity](README.md#simplesecurity-index) project modules.
+
+- [Simplesecurity Index](README.md#simplesecurity-index)
+- [Simplesecurity](simplesecurity/index.md#simplesecurity)
+    - [Module](simplesecurity/module.md#module)
+    - [Filter](simplesecurity/filter.md#filter)
+    - [Formatter](simplesecurity/formatter.md#formatter)
+    - [Level](simplesecurity/level.md#level)
+    - [Plugins](simplesecurity/plugins.md#plugins)
+    - [Types](simplesecurity/types.md#types)

documentation/reference/MODULES.md

@@ -0,0 +1,14 @@
+# Simplesecurity Modules
+
+> Auto-generated documentation modules index.
+
+Full list of [Simplesecurity](README.md#simplesecurity-index) project modules.
+
+- [Simplesecurity Index](README.md#simplesecurity-index)
+- [Simplesecurity](simplesecurity/index.md#simplesecurity)
+    - [Module](simplesecurity/module.md#module)
+    - [Filter](simplesecurity/filter.md#filter)
+    - [Formatter](simplesecurity/formatter.md#formatter)
+    - [Level](simplesecurity/level.md#level)
+    - [Plugins](simplesecurity/plugins.md#plugins)
+    - [Types](simplesecurity/types.md#types)

documentation/reference/README.md

@@ -1,18 +1,18 @@
-# filter
+# Filter
 
-> Auto-generated documentation for [simplesecurity.filter](../../simplesecurity/filter.py) module.
+> Auto-generated documentation for [simplesecurity.filter](../../../simplesecurity/filter.py) module.
 
 Some of our analysis tools overlap one-another so lets remove duplicates.
 
-- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../README.md#simplesecurity-modules) / [simplesecurity](index.md#simplesecurity) / filter
+- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../MODULES.md#simplesecurity-modules) / [Simplesecurity](index.md#simplesecurity) / Filter
     - [deduplicate](#deduplicate)
     - [filterSeverityAndConfidence](#filterseverityandconfidence)
     - [findingsEqual](#findingsequal)
     - [lookupId](#lookupid)
 
 ## deduplicate
 
-[[find in source code]](../../simplesecurity/filter.py#L58)
+[[find in source code]](../../../simplesecurity/filter.py#L58)
 
 ```python
 def deduplicate(findings: list[Finding]) -> list[Finding]:
@@ -28,9 +28,13 @@ Deduplicate the list of findings.
 
 - `list[Finding]` - new deduplicated list
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## filterSeverityAndConfidence
 
-[[find in source code]](../../simplesecurity/filter.py#L78)
+[[find in source code]](../../../simplesecurity/filter.py#L78)
 
 ```python
 def filterSeverityAndConfidence(
@@ -52,9 +56,13 @@ Filter the list of findings.
 
 - `list[Finding]` - new deduplicated list
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## findingsEqual
 
-[[find in source code]](../../simplesecurity/filter.py#L36)
+[[find in source code]](../../../simplesecurity/filter.py#L36)
 
 ```python
 def findingsEqual(findingA: Finding, findingB: Finding) -> int:
@@ -78,7 +86,7 @@ Basically and __eq__ method for findings.
 
 ## lookupId
 
-[[find in source code]](../../simplesecurity/filter.py#L22)
+[[find in source code]](../../../simplesecurity/filter.py#L22)
 
 ```python
 def lookupId(identifier: str) -> list[str]:

DOCS/simplesecurity/filter.md …ation/reference/simplesecurity/filter.mdDOCS/simplesecurity/filter.md renamed to documentation/reference/simplesecurity/filter.md DOCS/simplesecurity/filter.md renamed to documentation/reference/simplesecurity/filter.md

@@ -1,10 +1,10 @@
-# formatter
+# Formatter
 
-> Auto-generated documentation for [simplesecurity.formatter](../../simplesecurity/formatter.py) module.
+> Auto-generated documentation for [simplesecurity.formatter](../../../simplesecurity/formatter.py) module.
 
 Take our findings dictionary and give things a pretty format.
 
-- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../README.md#simplesecurity-modules) / [simplesecurity](index.md#simplesecurity) / formatter
+- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../MODULES.md#simplesecurity-modules) / [Simplesecurity](index.md#simplesecurity) / Formatter
     - [ansi](#ansi)
     - [csv](#csv)
     - [formatEvidence](#formatevidence)
@@ -36,7 +36,7 @@ Formats
 
 ## ansi
 
-[[find in source code]](../../simplesecurity/formatter.py#L162)
+[[find in source code]](../../../simplesecurity/formatter.py#L162)
 
 ```python
 def ansi(
@@ -59,9 +59,13 @@ Format to ansi.
 
 - `str` - String to write to a file of stdout
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## csv
 
-[[find in source code]](../../simplesecurity/formatter.py#L120)
+[[find in source code]](../../../simplesecurity/formatter.py#L120)
 
 ```python
 def csv(
@@ -84,9 +88,13 @@ Format to CSV.
 
 - `str` - String to write to a file of stdout
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## formatEvidence
 
-[[find in source code]](../../simplesecurity/formatter.py#L35)
+[[find in source code]](../../../simplesecurity/formatter.py#L35)
 
 ```python
 def formatEvidence(evidence: list[Line], newlineChar: bool = True) -> str:
@@ -103,9 +111,13 @@ Format evidence to plaintext.
 
 - `str` - string representation of this
 
+#### See also
+
+- [Line](types.md#line)
+
 ## json
 
-[[find in source code]](../../simplesecurity/formatter.py#L97)
+[[find in source code]](../../../simplesecurity/formatter.py#L97)
 
 ```python
 def json(
@@ -128,9 +140,13 @@ Format to Json.
 
 - `str` - String to write to a file of stdout
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## markdown
 
-[[find in source code]](../../simplesecurity/formatter.py#L51)
+[[find in source code]](../../../simplesecurity/formatter.py#L51)
 
 ```python
 def markdown(
@@ -153,9 +169,13 @@ Format to Markdown.
 
 - `str` - String to write to a file of stdout
 
+#### See also
+
+- [Finding](types.md#finding)
+
 ## sarif
 
-[[find in source code]](../../simplesecurity/formatter.py#L253)
+[[find in source code]](../../../simplesecurity/formatter.py#L253)
 
 ```python
 def sarif(
@@ -177,3 +197,7 @@ Format to sarif https://sarifweb.azurewebsites.net/.
 #### Returns
 
 - `str` - String to write to a file of stdout
+
+#### See also
+
+- [Finding](types.md#finding)

DOCS/simplesecurity/formatter.md …on/reference/simplesecurity/formatter.mdDOCS/simplesecurity/formatter.md renamed to documentation/reference/simplesecurity/formatter.md DOCS/simplesecurity/formatter.md renamed to documentation/reference/simplesecurity/formatter.md

@@ -1,20 +1,20 @@
-# simplesecurity
+# Simplesecurity
 
-> Auto-generated documentation for [simplesecurity](../../simplesecurity/__init__.py) module.
+> Auto-generated documentation for [simplesecurity](../../../simplesecurity/__init__.py) module.
 
 Combine multiple popular python security tools and generate reports or output
 into different formats
 
-- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../README.md#simplesecurity-modules) / simplesecurity
+- [Simplesecurity](../README.md#simplesecurity-index) / [Modules](../MODULES.md#simplesecurity-modules) / Simplesecurity
     - [cli](#cli)
     - [runAllPlugins](#runallplugins)
     - Modules
-        - [\_\_main\_\_](module.md#__main__)
-        - [filter](filter.md#filter)
-        - [formatter](formatter.md#formatter)
-        - [level](level.md#level)
-        - [plugins](plugins.md#plugins)
-        - [types](types.md#types)
+        - [Module](module.md#module)
+        - [Filter](filter.md#filter)
+        - [Formatter](formatter.md#formatter)
+        - [Level](level.md#level)
+        - [Plugins](plugins.md#plugins)
+        - [Types](types.md#types)
 
 Plugins (these require the plugin executable in the system path. e.g. bandit
 requires bandit to be in the system path...)
@@ -35,7 +35,7 @@ Formats
 
 ## cli
 
-[[find in source code]](../../simplesecurity/__init__.py#L67)
+[[find in source code]](../../../simplesecurity/__init__.py#L67)
 
 ```python
 def cli():
@@ -45,11 +45,11 @@ Cli entry point.
 
 ## runAllPlugins
 
-[[find in source code]](../../simplesecurity/__init__.py#L38)
+[[find in source code]](../../../simplesecurity/__init__.py#L38)
 
 ```python
 def runAllPlugins(
-    pluginMap: dict[(str, Any)],
+    pluginMap: dict[str, Any],
     severity: int,
     confidence: int,
     fast: bool,
@@ -68,3 +68,7 @@ pluginMap (dict[str, Any]): the plugin map
 #### Returns
 
 - `list[Finding]` - list of findings
+
+#### See also
+
+- [Finding](types.md#finding)