@oddessentials/repo-standards 2.0.1 → 3.0.0

package/dist/config/standards.json

@@ -20,8 +20,10 @@
           }
         },
         "description": "Maintain proper .gitignore and .dockerignore files to prevent committing secrets, build artifacts, or unnecessary files.",
+        "enforcement": "required",
         "id": "gitignore-and-dockerignore",
         "label": "Git and Docker Ignore Files",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -114,8 +116,10 @@
           }
         },
         "description": "Run static code linting to enforce consistency and catch common issues early.",
+        "enforcement": "required",
         "id": "linting",
         "label": "Linting",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -279,8 +283,10 @@
           }
         },
         "description": "Provide a deterministic unit test framework with a single command to run all tests.",
+        "enforcement": "required",
         "id": "unit-test-runner",
         "label": "Unit Test Runner",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -413,8 +419,10 @@
           }
         },
         "description": "Provide a Dockerfile and, if applicable, a docker-compose file for local dev and CI parity.",
+        "enforcement": "required",
         "id": "containerization",
         "label": "Containerization (Docker / Docker Compose)",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -512,8 +520,10 @@
           }
         },
         "description": "Use MAJOR.MINOR.PATCH versioning with clear rules and automated changelog generation based on commit history.",
+        "enforcement": "required",
         "id": "semantic-versioning",
         "label": "Semantic Versioning",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -599,8 +609,10 @@
           }
         },
         "description": "Enforce structured commit messages such as Conventional Commits.",
+        "enforcement": "required",
         "id": "commit-linting",
         "label": "Commit Linting",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -681,8 +693,10 @@
           }
         },
         "description": "Generate readable unit test and coverage reports and enforce a minimum coverage threshold (around 80%) for new or changed code.",
+        "enforcement": "required",
         "id": "unit-test-reporter",
         "label": "Unit Test Reporter / Coverage",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -793,8 +807,10 @@
           }
         },
         "description": "Single CI pipeline that runs linting, formatting, type checking, tests, coverage, build, and containerization.",
+        "enforcement": "required",
         "id": "ci-quality-gates",
         "label": "CI Quality Gates",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -897,8 +913,10 @@
           }
         },
         "description": "Automatic code formatting to maintain a consistent style across all contributors.",
+        "enforcement": "required",
         "id": "code-formatter",
         "label": "Code Formatter",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -1003,8 +1021,10 @@
           }
         },
         "description": "Use git hooks to run linting, formatting, tests, and commit linting before changes are committed.",
+        "enforcement": "required",
         "id": "pre-commit-hooks",
         "label": "Pre-Commit Hooks",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1082,8 +1102,10 @@
           }
         },
         "description": "Use static type checking to catch errors before runtime and enforce strictness on new code.",
+        "enforcement": "required",
         "id": "type-checking",
         "label": "Type Checking",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "bazelHints": {
@@ -1215,8 +1237,10 @@
           }
         },
         "description": "Lock dependencies and scan regularly for known vulnerabilities; fail CI on newly introduced high-severity issues.",
+        "enforcement": "required",
         "id": "dependency-security",
         "label": "Dependency Management & Vulnerability Scanning",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1265,6 +1289,9 @@
             "verification": "Dependency lockfile is present; security scanning is configured in CI or project tooling."
           },
           "rust": {
+            "anyOfFiles": [
+              "Cargo.lock"
+            ],
             "exampleConfigFiles": [
               "Cargo.lock",
               "deny.toml"
@@ -1277,9 +1304,7 @@
             "optionalFiles": [
               "deny.toml"
             ],
-            "requiredFiles": [
-              "Cargo.lock"
-            ],
+            "pinningNotes": "Required for binaries/services; optional for libraries (add to .gitignore for libs). See https://doc.rust-lang.org/cargo/faq.html#why-have-cargolock-in-version-control",
             "verification": "Cargo.lock is present; run 'cargo audit' or 'cargo deny check' to verify security scanning."
           },
           "typescript-js": {
@@ -1321,8 +1346,10 @@
           }
         },
         "description": "Specify required runtime/engine versions in package manifests to ensure environment stability and prevent version-related issues across development teams.",
+        "enforcement": "required",
         "id": "runtime-version",
         "label": "Runtime Version Specification",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1412,8 +1439,10 @@
           }
         },
         "description": "Maintain a comprehensive README and, where applicable, auto-generated API docs to support onboarding and maintainability.",
+        "enforcement": "required",
         "id": "documentation",
         "label": "Documentation Standards",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1529,8 +1558,10 @@
           }
         },
         "description": "Include standard governance files (LICENSE, CODE_OF_CONDUCT.md, CONTRIBUTING.md), branch protection rules, and review standards to define legal, ethical, and workflow expectations.",
+        "enforcement": "required",
         "id": "repository-governance",
         "label": "Repository Governance",
+        "severity": "error",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1640,8 +1671,10 @@
           }
         },
         "description": "Standardize error handling and structured logging to make debugging and production monitoring easier.",
+        "enforcement": "optional",
         "id": "observability",
         "label": "Observability (Logging & Error Handling)",
+        "severity": "info",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1719,8 +1752,10 @@
           }
         },
         "description": "Automate dependency updates using Renovate or Dependabot to keep dependencies current and reduce security exposure window.",
+        "enforcement": "recommended",
         "id": "dependency-update-automation",
         "label": "Dependency Update Automation",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "anyOfFiles": [
@@ -1835,8 +1870,10 @@
           }
         },
         "description": "Enforce module boundaries and import constraints to prevent architectural drift and unwanted coupling.",
+        "enforcement": "recommended",
         "id": "dependency-architecture-rules",
         "label": "Dependency Architecture Rules",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -1931,8 +1968,10 @@
           }
         },
         "description": "Test how components interact with each other and external systems, running after unit tests with more relaxed coverage thresholds.",
+        "enforcement": "recommended",
         "id": "integration-testing",
         "label": "Integration Testing",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -2010,8 +2049,10 @@
           }
         },
         "description": "Establish performance baselines and monitor for regressions using lightweight benchmarks or audits in CI.",
+        "enforcement": "recommended",
         "id": "performance-baselining",
         "label": "Performance Baselines",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -2089,8 +2130,10 @@
           }
         },
         "description": "Measure cyclomatic complexity or similar metrics to keep code maintainable, starting as a warning-only check.",
+        "enforcement": "recommended",
         "id": "complexity-analysis",
         "label": "Complexity Analysis",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [
@@ -2168,8 +2211,10 @@
           }
         },
         "description": "Run accessibility checks on web-facing components to detect critical issues and improve inclusive UX.",
+        "enforcement": "recommended",
         "id": "accessibility-auditing",
         "label": "Accessibility Auditing",
+        "severity": "warn",
         "stackHints": {
           "csharp-dotnet": {
             "exampleConfigFiles": [],
@@ -2224,48 +2269,52 @@
     "github-actions"
   ],
   "meta": {
-    "bazelIntegration": {
-      "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
-      "ciContract": {
-        "configFlag": "--config=ci (define in .bazelrc)",
-        "deterministicFlags": [
-          "--nokeep_going",
-          "--test_output=errors"
-        ],
-        "remoteCache": "Optional; not required for CI",
-        "versionPinning": "Use .bazelversion file for Bazelisk"
-      },
-      "description": "Bazel build executor support for quality checks. All hints are ADVISORY—stack-native commands remain the default execution path.",
-      "detectionRules": {
-        "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
-        "optionalMarkers": [
-          ".bazelrc",
-          ".bazelversion"
-        ],
-        "rootMarkers": [
-          "MODULE.bazel",
-          "WORKSPACE.bazel",
-          "WORKSPACE"
-        ]
-      },
-      "optOut": {
-        "configPath": "meta.bazelIntegration.enabled",
-        "description": "Set meta.bazelIntegration.enabled = false in repo config to disable Bazel hints"
-      },
-      "targetConventions": {
-        "build": "bazel build //...",
-        "coverage": "bazel coverage //...",
-        "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
-        "format": "bazel run //tools/format:check",
-        "lint": "//tools/lint:lint or bazel test //... with lint aspects",
-        "test": "bazel test //..."
-      }
-    },
     "complexityChecks": {
       "description": "When supported by the stack, run cyclomatic complexity or similar metrics in CI as a warning-only check initially.",
       "enabledByDefault": true
     },
+    "coverageThresholdDescription": "Expressed as a ratio (0-1), e.g., 0.8 = 80% coverage. Must be between 0 and 1.",
+    "coverageThresholdUnit": "ratio",
     "defaultCoverageThreshold": 0.8,
+    "executorHints": {
+      "bazel": {
+        "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
+        "ciContract": {
+          "configFlag": "--config=ci (define in .bazelrc)",
+          "deterministicFlags": [
+            "--nokeep_going",
+            "--test_output=errors"
+          ],
+          "remoteCache": "Optional; not required for CI",
+          "versionPinning": "Use .bazelversion file for Bazelisk"
+        },
+        "detectionRules": {
+          "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
+          "optionalMarkers": [
+            ".bazelrc",
+            ".bazelversion"
+          ],
+          "rootMarkers": [
+            "MODULE.bazel",
+            "WORKSPACE.bazel",
+            "WORKSPACE"
+          ]
+        },
+        "optOut": {
+          "configPath": "meta.executorHints.bazel.enabled",
+          "description": "Set meta.executorHints.bazel.enabled = false in repo config to disable Bazel hints"
+        },
+        "targetConventions": {
+          "build": "bazel build //...",
+          "coverage": "bazel coverage //...",
+          "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
+          "format": "bazel run //tools/format:check",
+          "lint": "//tools/lint:lint or bazel test //... with lint aspects",
+          "test": "bazel test //..."
+        }
+      },
+      "description": "Advisory execution substrate hints. Bazel is the first supported executor; future monorepo executors may follow the same pattern."
+    },
     "migrationGuide": [
       {
         "description": "Start by adding pre-commit hooks and core formatting/linting so developers get fast feedback without touching CI.",

package/dist/config/standards.python.azure-devops.json

@@ -577,48 +577,52 @@
     "azure-devops"
   ],
   "meta": {
-    "bazelIntegration": {
-      "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
-      "ciContract": {
-        "configFlag": "--config=ci (define in .bazelrc)",
-        "deterministicFlags": [
-          "--nokeep_going",
-          "--test_output=errors"
-        ],
-        "remoteCache": "Optional; not required for CI",
-        "versionPinning": "Use .bazelversion file for Bazelisk"
-      },
-      "description": "Bazel build executor support for quality checks. All hints are ADVISORY—stack-native commands remain the default execution path.",
-      "detectionRules": {
-        "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
-        "optionalMarkers": [
-          ".bazelrc",
-          ".bazelversion"
-        ],
-        "rootMarkers": [
-          "MODULE.bazel",
-          "WORKSPACE.bazel",
-          "WORKSPACE"
-        ]
-      },
-      "optOut": {
-        "configPath": "meta.bazelIntegration.enabled",
-        "description": "Set meta.bazelIntegration.enabled = false in repo config to disable Bazel hints"
-      },
-      "targetConventions": {
-        "build": "bazel build //...",
-        "coverage": "bazel coverage //...",
-        "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
-        "format": "bazel run //tools/format:check",
-        "lint": "//tools/lint:lint or bazel test //... with lint aspects",
-        "test": "bazel test //..."
-      }
-    },
     "complexityChecks": {
       "description": "When supported by the stack, run cyclomatic complexity or similar metrics in CI as a warning-only check initially.",
       "enabledByDefault": true
     },
+    "coverageThresholdDescription": "Expressed as a ratio (0-1), e.g., 0.8 = 80% coverage. Must be between 0 and 1.",
+    "coverageThresholdUnit": "ratio",
     "defaultCoverageThreshold": 0.8,
+    "executorHints": {
+      "bazel": {
+        "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
+        "ciContract": {
+          "configFlag": "--config=ci (define in .bazelrc)",
+          "deterministicFlags": [
+            "--nokeep_going",
+            "--test_output=errors"
+          ],
+          "remoteCache": "Optional; not required for CI",
+          "versionPinning": "Use .bazelversion file for Bazelisk"
+        },
+        "detectionRules": {
+          "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
+          "optionalMarkers": [
+            ".bazelrc",
+            ".bazelversion"
+          ],
+          "rootMarkers": [
+            "MODULE.bazel",
+            "WORKSPACE.bazel",
+            "WORKSPACE"
+          ]
+        },
+        "optOut": {
+          "configPath": "meta.executorHints.bazel.enabled",
+          "description": "Set meta.executorHints.bazel.enabled = false in repo config to disable Bazel hints"
+        },
+        "targetConventions": {
+          "build": "bazel build //...",
+          "coverage": "bazel coverage //...",
+          "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
+          "format": "bazel run //tools/format:check",
+          "lint": "//tools/lint:lint or bazel test //... with lint aspects",
+          "test": "bazel test //..."
+        }
+      },
+      "description": "Advisory execution substrate hints. Bazel is the first supported executor; future monorepo executors may follow the same pattern."
+    },
     "migrationGuide": [
       {
         "description": "Start by adding pre-commit hooks and core formatting/linting so developers get fast feedback without touching CI.",

package/dist/config/standards.python.github-actions.json

@@ -577,48 +577,52 @@
     "github-actions"
   ],
   "meta": {
-    "bazelIntegration": {
-      "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
-      "ciContract": {
-        "configFlag": "--config=ci (define in .bazelrc)",
-        "deterministicFlags": [
-          "--nokeep_going",
-          "--test_output=errors"
-        ],
-        "remoteCache": "Optional; not required for CI",
-        "versionPinning": "Use .bazelversion file for Bazelisk"
-      },
-      "description": "Bazel build executor support for quality checks. All hints are ADVISORY—stack-native commands remain the default execution path.",
-      "detectionRules": {
-        "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
-        "optionalMarkers": [
-          ".bazelrc",
-          ".bazelversion"
-        ],
-        "rootMarkers": [
-          "MODULE.bazel",
-          "WORKSPACE.bazel",
-          "WORKSPACE"
-        ]
-      },
-      "optOut": {
-        "configPath": "meta.bazelIntegration.enabled",
-        "description": "Set meta.bazelIntegration.enabled = false in repo config to disable Bazel hints"
-      },
-      "targetConventions": {
-        "build": "bazel build //...",
-        "coverage": "bazel coverage //...",
-        "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
-        "format": "bazel run //tools/format:check",
-        "lint": "//tools/lint:lint or bazel test //... with lint aspects",
-        "test": "bazel test //..."
-      }
-    },
     "complexityChecks": {
       "description": "When supported by the stack, run cyclomatic complexity or similar metrics in CI as a warning-only check initially.",
       "enabledByDefault": true
     },
+    "coverageThresholdDescription": "Expressed as a ratio (0-1), e.g., 0.8 = 80% coverage. Must be between 0 and 1.",
+    "coverageThresholdUnit": "ratio",
     "defaultCoverageThreshold": 0.8,
+    "executorHints": {
+      "bazel": {
+        "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
+        "ciContract": {
+          "configFlag": "--config=ci (define in .bazelrc)",
+          "deterministicFlags": [
+            "--nokeep_going",
+            "--test_output=errors"
+          ],
+          "remoteCache": "Optional; not required for CI",
+          "versionPinning": "Use .bazelversion file for Bazelisk"
+        },
+        "detectionRules": {
+          "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
+          "optionalMarkers": [
+            ".bazelrc",
+            ".bazelversion"
+          ],
+          "rootMarkers": [
+            "MODULE.bazel",
+            "WORKSPACE.bazel",
+            "WORKSPACE"
+          ]
+        },
+        "optOut": {
+          "configPath": "meta.executorHints.bazel.enabled",
+          "description": "Set meta.executorHints.bazel.enabled = false in repo config to disable Bazel hints"
+        },
+        "targetConventions": {
+          "build": "bazel build //...",
+          "coverage": "bazel coverage //...",
+          "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
+          "format": "bazel run //tools/format:check",
+          "lint": "//tools/lint:lint or bazel test //... with lint aspects",
+          "test": "bazel test //..."
+        }
+      },
+      "description": "Advisory execution substrate hints. Bazel is the first supported executor; future monorepo executors may follow the same pattern."
+    },
     "migrationGuide": [
       {
         "description": "Start by adding pre-commit hooks and core formatting/linting so developers get fast feedback without touching CI.",

package/dist/config/standards.python.json

@@ -646,48 +646,52 @@
     "github-actions"
   ],
   "meta": {
-    "bazelIntegration": {
-      "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
-      "ciContract": {
-        "configFlag": "--config=ci (define in .bazelrc)",
-        "deterministicFlags": [
-          "--nokeep_going",
-          "--test_output=errors"
-        ],
-        "remoteCache": "Optional; not required for CI",
-        "versionPinning": "Use .bazelversion file for Bazelisk"
-      },
-      "description": "Bazel build executor support for quality checks. All hints are ADVISORY—stack-native commands remain the default execution path.",
-      "detectionRules": {
-        "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
-        "optionalMarkers": [
-          ".bazelrc",
-          ".bazelversion"
-        ],
-        "rootMarkers": [
-          "MODULE.bazel",
-          "WORKSPACE.bazel",
-          "WORKSPACE"
-        ]
-      },
-      "optOut": {
-        "configPath": "meta.bazelIntegration.enabled",
-        "description": "Set meta.bazelIntegration.enabled = false in repo config to disable Bazel hints"
-      },
-      "targetConventions": {
-        "build": "bazel build //...",
-        "coverage": "bazel coverage //...",
-        "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
-        "format": "bazel run //tools/format:check",
-        "lint": "//tools/lint:lint or bazel test //... with lint aspects",
-        "test": "bazel test //..."
-      }
-    },
     "complexityChecks": {
       "description": "When supported by the stack, run cyclomatic complexity or similar metrics in CI as a warning-only check initially.",
       "enabledByDefault": true
     },
+    "coverageThresholdDescription": "Expressed as a ratio (0-1), e.g., 0.8 = 80% coverage. Must be between 0 and 1.",
+    "coverageThresholdUnit": "ratio",
     "defaultCoverageThreshold": 0.8,
+    "executorHints": {
+      "bazel": {
+        "advisoryNotice": "bazelHints are suggestions, not required execution paths. Consumers should prefer stack-native commands unless explicitly adopting Bazel.",
+        "ciContract": {
+          "configFlag": "--config=ci (define in .bazelrc)",
+          "deterministicFlags": [
+            "--nokeep_going",
+            "--test_output=errors"
+          ],
+          "remoteCache": "Optional; not required for CI",
+          "versionPinning": "Use .bazelversion file for Bazelisk"
+        },
+        "detectionRules": {
+          "notes": "Detection uses repo-root markers only. Nested BUILD files do not trigger Bazel mode.",
+          "optionalMarkers": [
+            ".bazelrc",
+            ".bazelversion"
+          ],
+          "rootMarkers": [
+            "MODULE.bazel",
+            "WORKSPACE.bazel",
+            "WORKSPACE"
+          ]
+        },
+        "optOut": {
+          "configPath": "meta.executorHints.bazel.enabled",
+          "description": "Set meta.executorHints.bazel.enabled = false in repo config to disable Bazel hints"
+        },
+        "targetConventions": {
+          "build": "bazel build //...",
+          "coverage": "bazel coverage //...",
+          "description": "Recommended target naming (not assumed to exist). These are illustrative patterns; actual targets are repo-defined.",
+          "format": "bazel run //tools/format:check",
+          "lint": "//tools/lint:lint or bazel test //... with lint aspects",
+          "test": "bazel test //..."
+        }
+      },
+      "description": "Advisory execution substrate hints. Bazel is the first supported executor; future monorepo executors may follow the same pattern."
+    },
     "migrationGuide": [
       {
         "description": "Start by adding pre-commit hooks and core formatting/linting so developers get fast feedback without touching CI.",