Skip to content

feat(compliance): validate LICENSE and vscode settings content

Summary

Add content validation for key configuration files to ensure project compliance with organizational standards. Specifically:

  • Verify that the LICENSE file uses AGPLv3.
  • Ensure .vscode/settings.json includes ruff and uv for linting and environment management.

This improves project consistency, legal compliance, and developer tooling alignment across teams.

Problem to Solve

As a project maintainer or compliance officer, I want the tool to inspect the contents of critical files so that I can ensure:

  • Projects use the correct open-source license (AGPLv3), not MIT or Apache.
  • Development environments are standardized using modern tooling (uv, ruff).

Currently, the tool only checks file presence, not content — leading to false positives in compliance.

Intended Users

  • Project Maintainers – Ensure their repos meet org standards.
  • Compliance Officers / DevOps Engineers – Audit multiple projects efficiently.
  • New Contributors – Get clear feedback on required configurations.

User Experience Goal

Users should be able to run the compliance check and immediately see:

  • If the license is AGPLv3 or invalid.
  • If .vscode/settings.json is missing required tools (ruff, uv).
  • Clear suggestions with images to fix issues.

The experience should guide them from "present" → "correctly configured".

Proposal

Extend the compliance checker to:

  1. Read the LICENSE or LICENSE.md file and check for keywords like:

    • "Affero General Public License"
    • "AGPL"
      → Flag as invalid if not found.

  2. Parse .vscode/settings.json and validate:

    • Presence of ruff in linting configuration.
    • Use of uv in interpreter path or terminal settings.

  3. Add new compliance items:

    • ✅ license_valid
    • ✅ vscode_has_ruff
    • ✅ vscode_has_uv

  4. Update UI:

    • Show dedicated checks under "Project Configuration".
    • Display warning messages and images when content is invalid.

  5. Update suggestion logic:

    • Show files.png before template suggestions.
    • Include new image assets: license-wrong.png, vscode-ruff.png, vscode-uv.png.

Further Details

Example Valid Configurations

LICENSE (must contain):