Merge pull request #34 from OPPIDA/fix/spelling

Author: nolliv22

.gitignore

@@ -1,4 +1,4 @@
-# Artefact
+# Artifact
 build/
 .cache/
 site/

codesectools/datasets/core/dataset.py

@@ -185,7 +185,7 @@ def is_built(self) -> bool:
         return True
 
     def list_prebuilt_files(self) -> list[Path]:
-        """List the pre-built artefact files."""
+        """List the pre-built artifact files."""
         prebuilt_dir, prebuilt_glob = self.prebuilt_expected
         prebuilt_path = USER_CACHE_DIR / self.name / prebuilt_dir
         return list(prebuilt_path.glob(prebuilt_glob))

codesectools/sasts/all/cli.py

@@ -94,12 +94,12 @@ def analyze(
         for sast in all_sast.sasts_by_lang.get(lang, []):
             if isinstance(sast, PrebuiltBuildlessSAST) and artifacts is None:
                 print(
-                    f"[i]{sast.name} can use pre-built artifacts ({sast.artefact_name} {sast.artefact_type}) for more accurate analysis"
+                    f"[i]{sast.name} can use pre-built artifacts ({sast.artifact_name} {sast.artifact_type}) for more accurate analysis"
                 )
                 print("[i]Use the flag --artifacts to provide the artifacts")
             elif isinstance(sast, PrebuiltSAST) and artifacts is None:
                 print(
-                    f"[b]Skipping {sast.name} because it requires pre-built artifacts ({sast.artefact_name} {sast.artefact_type})"
+                    f"[b]Skipping {sast.name} because it requires pre-built artifacts ({sast.artifact_name} {sast.artifact_type})"
                 )
                 print("[b]Use the flag --artifacts to provide the artifacts")
                 continue

codesectools/sasts/core/cli.py

@@ -137,12 +137,12 @@ def add_analyze(self: Self, help: str = "") -> None:
         if isinstance(self.sast, PrebuiltBuildlessSAST):
             artifacts_default = typer.Option(
                 default=None,
-                help=f"Pre-built artifacts ({self.sast.artefact_name} {self.sast.artefact_type}) for more accurate analysis",
+                help=f"Pre-built artifacts ({self.sast.artifact_name} {self.sast.artifact_type}) for more accurate analysis",
                 metavar="ARTIFACTS",
             )
         elif isinstance(self.sast, PrebuiltSAST):
             artifacts_default = typer.Option(
-                help=f"Pre-built artifacts ({self.sast.artefact_name} {self.sast.artefact_type})",
+                help=f"Pre-built artifacts ({self.sast.artifact_name} {self.sast.artifact_type})",
                 metavar="ARTIFACTS",
             )
         else:
@@ -184,7 +184,7 @@ def analyze(
             """
             if isinstance(self.sast, PrebuiltBuildlessSAST) and artifacts is None:
                 print(
-                    f"[i]{self.sast.name} can use pre-built artifacts ({self.sast.artefact_name} {self.sast.artefact_type}) for more accurate analysis"
+                    f"[i]{self.sast.name} can use pre-built artifacts ({self.sast.artifact_name} {self.sast.artifact_type}) for more accurate analysis"
                 )
                 print("[i]Use the flag --artifacts to provide the artifacts")
 

codesectools/sasts/core/sast/__init__.py

@@ -332,13 +332,13 @@ class PrebuiltSAST(SAST):
     """Represent a SAST tool that requires pre-built artifacts for analysis.
 
     Attributes:
-        artefact_name (str): The name of the expected artifact (e.g., 'Java Bytecode').
-        artefact_type (Literal["file", "directory"]): The type of artifact expected.
+        artifact_name (str): The name of the expected artifact (e.g., 'Java Bytecode').
+        artifact_type (Literal["file", "directory"]): The type of artifact expected.
 
     """
 
-    artefact_name: str
-    artefact_type: Literal["file", "directory"]
+    artifact_name: str
+    artifact_type: Literal["file", "directory"]
 
     def analyze_files(
         self,

codesectools/sasts/tools/Cppcheck/sast.py

@@ -67,5 +67,5 @@ class CppcheckSAST(PrebuiltBuildlessSAST):
     }
 
     # PrebuiltSAST
-    artefact_name = "Compilation database"
-    artefact_type = "file"
+    artifact_name = "Compilation database"
+    artifact_type = "file"

codesectools/sasts/tools/SpotBugs/sast.py

@@ -78,5 +78,5 @@ class SpotBugsSAST(PrebuiltSAST):
     }
 
     # PrebuiltSAST
-    artefact_name = "Java Bytecode"
-    artefact_type = "directory"
+    artifact_name = "Java Bytecode"
+    artifact_type = "directory"

docs/home/quick_start_guide.md

@@ -209,7 +209,7 @@ cstools spotbugs benchmark BenchmarkJava_java
 │ Build command:          mvn clean compile                               │
 │ Full command:           (cd                                             │
 │ /home/michel/.codesectools/cache/BenchmarkJava && mvn clean compile)    │
-│ Expected arteficts:                                                     │
+│ Expected artifacts:                                                     │
 │ /home/michel/.codesectools/cache/BenchmarkJava/target/classes/org/owasp │
 │ /benchmark/testcode/*.class                                             │
 ╰─────────────────────────────────────────────────────────────────────────╯

docs/sast/index.md

@@ -45,8 +45,8 @@ classDiagram
     }
 
     class PrebuiltBuildlessSAST {
-        +artefact_name: str
-        +artefact_type: str
+        +artifact_name: str
+        +artifact_type: str
     }
 
     SAST <|-- BuildlessSAST