nx-uvu/schema.json

An Nx executor for the uvu test runner

{
  "$schema": "http://json-schema.org/schema",
  "type": "object",
  "cli": "nx",
  "properties": {
    "rootDir": {
      "type": "string",
      "description": "The root directory to run the uvu command"
    },
    "pattern": {
      "type": "string",
      "description": "The test pattern to pass to the uvu cli",
      "default": "\"(test|spec)\\.ts\""
    },
    "coverage": {
      "type": "boolean",
      "description": "Whether or not c8 should be used to collect coverage",
      "default": false
    },
    "coverageConfig": {
      "type": "string",
      "description": "The path to the c8 config file"
    },
    "typescript": {
      "type": "boolean",
      "description": "If you are testing typescript files. This will register ts-node unless useSwc is set to true",
      "default": true
    },
    "useSwc": {
      "type": "boolean",
      "description": "Use SWC instead of ts-node and tsconfig-paths",
      "default": false
    },
    "tsconfigPaths": {
      "type": "boolean",
      "description": "If tsconfig-paths should be registered. This will only be register if \"typescript\" is true and \"useSwc\" is false",
      "default": true
    },
    "tsconfigPath": {
      "type": "string",
      "description": "The custom path to the tsconfig, if there is one"
    },
    "runtimeArgs": {
      "type": "array",
      "description": "Other arguments that should be ran by using the -r hook",
      "default": [],
      "items": {
        "type": "string"
      }
    },
    "color": {
      "type": "boolean",
      "description": "If colors should be used with the test output",
      "default": true
    }
  },
  "required": ["rootDir"]
}