ngx-matomo-client/schematics/ng-add/schema.json

Matomo (fka. Piwik) client for Angular applications

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "properties": {
    "skipImport": {
      "type": "boolean",
      "default": false,
      "description": "Do not add ngx-matomo-client module/providers into the application."
    },
    "skipLegacyPackageMigration": {
      "type": "boolean",
      "default": false,
      "description": "Do not migrate legacy @ngx-matomo/* imports to ngx-matomo-client imports."
    },
    "useModuleImport": {
      "type": "boolean",
      "default": false,
      "description": "Use module-based setup style instead of provider-based setup."
    },
    "project": {
      "type": "string",
      "description": "The name of the project.",
      "$default": {
        "$source": "projectName"
      }
    },
    "serverUrl": {
      "type": "string",
      "description": "The Matomo server url",
      "alias": "s",
      "x-prompt": "What is your Matomo server url? (leave blank if pre-defined)"
    },
    "siteId": {
      "type": "string",
      "description": "The Matomo site ID",
      "alias": "id",
      "x-prompt": "What is your Matomo site ID? (leave blank if pre-defined)"
    },
    "scriptUrl": {
      "type": "string",
      "description": "The Matomo script url",
      "alias": "js",
      "x-prompt": "What is your Matomo script url? (leave blank to use default)"
    },
    "router": {
      "type": "boolean",
      "default": true,
      "description": "Specifies if automatic page views tracking should be set-up (requires @angular/router as a dependency)",
      "alias": "r",
      "x-prompt": "Would you like to automatically track page views? (requires @angular/router as a dependency)"
    }
  }
}