Add code quality checks with cspell, markdownlint, and yamllint

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

Author: Copilot

.cspell.json

@@ -0,0 +1,35 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "SPDX",
+    "SpdxModel",
+    "DemaConsulting",
+    "SBOM",
+    "sbom",
+    "dotnet",
+    "NuGet",
+    "nuget",
+    "spdx",
+    "deserializer",
+    "serializer",
+    "Dema",
+    "workflow",
+    "workflows",
+    "yamllint",
+    "markdownlint",
+    "cspell",
+    "Copilot",
+    "opencover",
+    "OpenCover"
+  ],
+  "ignorePaths": [
+    "**/*.spdx.json",
+    "**/bin/**",
+    "**/obj/**",
+    "**/.git/**",
+    "**/node_modules/**",
+    "**/*.nupkg",
+    "**/*.snupkg"
+  ]
+}

.github/workflows/build_on_push.yaml

@@ -8,6 +8,29 @@ on:
     - cron: '0 17 * * 1'
 
 jobs:
+  code-quality:
+    name: Code Quality
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read  # To read repository contents
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Check Spelling
+        uses: streetsidesoftware/cspell-action@v8
+
+      - name: Check Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v22
+        with:
+          globs: '**/*.md'
+
+      - name: Check YAML
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          file_or_dir: .
+          config_file: .yamllint.yaml
+
   build-windows:
     name: Build Windows
     permissions:

.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "default": true,
+  "MD003": { "style": "atx" },
+  "MD007": { "indent": 2 },
+  "MD013": { "line_length": 120 },
+  "MD033": false,
+  "MD041": false
+}

.yamllint.yaml

@@ -0,0 +1,25 @@
+---
+# yamllint configuration for SpdxModel
+# This configuration defines the rules for YAML file linting
+
+extends: default
+
+rules:
+  # Allow 'on:' in GitHub Actions workflows (not a boolean value)
+  truthy:
+    allowed-values: ['true', 'false', 'on', 'off']
+    check-keys: true
+
+  # Allow longer lines for URLs and complex expressions
+  line-length:
+    max: 120
+    level: error
+
+  # Ensure proper indentation
+  indentation:
+    spaces: 2
+    indent-sequences: true
+
+  # Ensure proper comment formatting
+  comments:
+    min-spaces-from-content: 2

AGENTS.md

@@ -84,6 +84,13 @@ The project uses several code quality and analysis tools:
   - CodeQL for security analysis
   - All code changes must pass static analysis checks
 
+* **Linting and Code Quality**:
+  - `cspell` for spell checking (configured in `.cspell.json`)
+  - `markdownlint-cli2` for Markdown file linting (configured in `.markdownlint.json`)
+  - `yamllint` for YAML file linting (configured in `.yamllint.yaml`)
+  - Code quality checks run automatically in CI pipeline
+  - Run locally: `npx cspell lint "**/*.md"`, `npx markdownlint-cli2 "**/*.md"`, `yamllint .`
+
 * **Editor Configuration**:
   - `.editorconfig` defines consistent code style rules
   - Ensure your editor respects EditorConfig settings
@@ -122,6 +129,7 @@ The project uses several code quality and analysis tools:
 
 * All changes are validated by GitHub Actions CI
 * CI pipeline includes:
+  - Code quality checks (spell checking, Markdown linting, YAML linting)
   - Building on multiple .NET versions (8, 9, 10)
   - Running all unit tests
   - Code coverage collection