Skip to content
Starlite Docs

Standards

Standards let you see how the technical context presented in a Record conforms to your organizational Standards.

Standards is one of the dimensions of the overall Health Score.

Record with example Standards

Standards are the “results”, so to speak. As an Organization, you will also want to set the Baselines that the Standards are calculated against.

During the integration step, Standards are calculated using StandardLint, an open-source Node.js package. Checks are written in a pattern as demonstrated below:

{
  "checks": [
    {
      "name": "checkForPresenceContributing",
      "severity": "warn"
    },
    {
      "name": "checkForPresenceLicense",
      "severity": "error"
    }
  ]
}

Running it, an example result for these checks could look like this:

{
  "passes": 0,
  "warnings": 1,
  "failures": 1,
  "results": [
    {
      "name": "Contribution information",
      "status": "warn",
      "message": "Check for CONTRIBUTING file",
      "path": "CONTRIBUTING.md"
    },
    {
      "name": "License",
      "status": "fail",
      "message": "Check for LICENSE file",
      "path": "LICENSE.md"
    }
  ]
}

These are then sent to Starlite and the Record will represent the latest Standards data.