@oddessentials/repo-standards 2.0.0 → 2.1.0

package/dist/config/standards.go.json

@@ -621,48 +621,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.",
@@ -722,5 +726,5 @@
   },
   "stack": "go",
   "stackLabel": "Go",
-  "version": 2
+  "version": 3
 }

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,15 +116,17 @@
           }
         },
         "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": {
               "commands": [
                 "bazel build //... --aspects=@rules_dotnet//dotnet:analyzers.bzl%analyzer_aspect"
               ],
-              "notes": "Use rules_dotnet analyzer aspects for Roslyn-based linting in Bazel."
+              "notes": "Example only; actual targets are repo-defined. Use rules_dotnet analyzer aspects for Roslyn-based linting."
             },
             "exampleConfigFiles": [
               ".editorconfig",
@@ -139,9 +143,6 @@
             "requiredFiles": [
               ".editorconfig"
             ],
-            "requiredScripts": [
-              "lint"
-            ],
             "verification": ".editorconfig must exist to drive the .NET formatting and analysis tooling."
           },
           "go": {
@@ -170,40 +171,38 @@
             "verification": ".golangci.yml or .golangci.yaml indicates linting is configured. Run 'golangci-lint run' to verify."
           },
           "python": {
+            "anyOfFiles": [
+              "pyproject.toml",
+              "ruff.toml",
+              ".flake8",
+              "setup.cfg",
+              "tox.ini"
+            ],
             "bazelHints": {
               "commands": [
                 "bazel test //...:ruff_test",
                 "bazel run //tools/lint:ruff -- check ."
               ],
-              "notes": "Use rules_python with ruff wrapped as py_test or a custom run target."
+              "notes": "Example only; actual targets are repo-defined. Use rules_python with ruff wrapped as py_test or run target."
             },
             "exampleConfigFiles": [
               "pyproject.toml",
-              ".flake8"
+              ".flake8",
+              "ruff.toml"
             ],
             "exampleTools": [
               "ruff",
               "flake8"
             ],
             "notes": "Configure a primary linter (such as ruff) and keep rules focused on catching real issues without overwhelming developers.",
-            "optionalFiles": [
-              "ruff.toml",
-              ".flake8"
-            ],
-            "requiredFiles": [
-              "pyproject.toml"
-            ],
-            "requiredScripts": [
-              "lint"
-            ],
-            "verification": "pyproject.toml (or ruff.toml / .flake8) signals that linting tools are configured for the repository."
+            "verification": "pyproject.toml (or ruff.toml / .flake8 / setup.cfg) signals that linting tools are configured for the repository."
           },
           "rust": {
             "bazelHints": {
               "commands": [
                 "bazel build //... --aspects=@rules_rust//rust:defs.bzl%clippy_aspect --output_groups=clippy_checks"
               ],
-              "notes": "rules_rust includes clippy_aspect for Bazel-native Clippy linting on all Rust targets."
+              "notes": "Example only; actual targets are repo-defined. rules_rust includes clippy_aspect for Bazel-native Clippy linting."
             },
             "exampleConfigFiles": [
               "clippy.toml",
@@ -224,36 +223,40 @@
             "verification": "Clippy is available via rustup component. Run 'cargo clippy' to verify linting is configured."
           },
           "typescript-js": {
+            "anyOfFiles": [
+              "eslint.config.js",
+              "eslint.config.mjs",
+              "eslint.config.cjs",
+              ".eslintrc.js",
+              ".eslintrc.cjs",
+              ".eslintrc.json",
+              ".eslintrc.yaml",
+              ".eslintrc.yml"
+            ],
             "bazelHints": {
               "commands": [
                 "bazel test //... --aspects=//tools:lint.bzl%eslint_aspect --output_groups=report"
               ],
-              "notes": "Wrap eslint via aspect_rules_lint or a custom sh_test rule. Aspect-based linting runs on all source files.",
+              "notes": "Example only; actual targets are repo-defined. Wrap eslint via aspect_rules_lint or a custom sh_test rule.",
               "recommendedTargets": [
                 "//tools/lint:lint"
               ]
             },
             "exampleConfigFiles": [
-              ".eslintrc.*"
+              ".eslintrc.*",
+              "eslint.config.js"
             ],
             "exampleTools": [
               "eslint"
             ],
             "notes": "Treat new lint errors as CI failures; keep existing issues as warnings until addressed.",
             "optionalFiles": [
-              ".eslintrc.js",
-              ".eslintrc.cjs",
-              ".eslintrc.json",
-              ".eslintrc.yaml",
               ".prettierrc",
               "prettier.config.js",
               "prettier.config.cjs",
               "prettier.config.json",
               "prettier.config.yaml"
             ],
-            "requiredFiles": [
-              "eslint.config.js"
-            ],
             "requiredScripts": [
               "lint"
             ],
@@ -280,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": {
@@ -329,7 +334,7 @@
               "commands": [
                 "bazel test //..."
               ],
-              "notes": "Use rules_python py_test for pytest-based tests. Tests are hermetically isolated."
+              "notes": "Example only; actual targets are repo-defined. Use rules_python py_test for pytest-based tests."
             },
             "exampleConfigFiles": [
               "pytest.ini",
@@ -344,9 +349,6 @@
               "pyproject.toml",
               "tests/"
             ],
-            "requiredScripts": [
-              "test"
-            ],
             "verification": "Test framework configuration is present; tests/ directory or pytest configuration exists."
           },
           "rust": {
@@ -417,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": [
@@ -516,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": [
@@ -603,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": [
@@ -685,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": {
@@ -797,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": {
@@ -901,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": {
@@ -1007,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": [
@@ -1086,15 +1102,17 @@
           }
         },
         "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": {
               "commands": [
                 "bazel build //..."
               ],
-              "notes": "C# type errors surface during bazel build with rules_dotnet. No separate typecheck step needed."
+              "notes": "Example only; actual targets are repo-defined. C# type errors surface during bazel build with rules_dotnet."
             },
             "exampleConfigFiles": [
               ".editorconfig",
@@ -1111,9 +1129,6 @@
             "requiredFiles": [
               ".editorconfig"
             ],
-            "requiredScripts": [
-              "typecheck"
-            ],
             "verification": ".editorconfig must exist; Directory.Build.props is optional for shared build configuration."
           },
           "go": {
@@ -1142,7 +1157,7 @@
                 "bazel test //...:mypy_test",
                 "bazel run //tools/typecheck:mypy"
               ],
-              "notes": "Wrap mypy as a py_test or run target for Bazel-based type checking."
+              "notes": "Example only; actual targets are repo-defined. Wrap mypy as a py_test or run target."
             },
             "exampleConfigFiles": [
               "mypy.ini",
@@ -1158,9 +1173,6 @@
             "requiredFiles": [
               "pyproject.toml"
             ],
-            "requiredScripts": [
-              "typecheck"
-            ],
             "verification": "pyproject.toml (or mypy.ini) signals that mypy configuration is available for the repository."
           },
           "rust": {
@@ -1225,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": [
@@ -1275,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"
@@ -1287,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": {
@@ -1331,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": [
@@ -1422,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": [
@@ -1539,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": [
@@ -1650,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": [
@@ -1729,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": [
@@ -1845,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": [
@@ -1941,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": [
@@ -2020,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": [
@@ -2099,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": [
@@ -2178,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": [],
@@ -2234,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.",
@@ -2355,5 +2394,5 @@
       "languageFamily": "js"
     }
   },
-  "version": 2
+  "version": 3
 }