corde/schema/corde.schema.json

A simple library for Discord bot tests

{
  "$id": "https://raw.githubusercontent.com/cordejs/corde/master/schema/corde.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Schema for Corde config",
  "type": "object",
  "description": "Corde's config",
  "examples": [
    {
      "cordeBotToken": "YaA4MDMiOTY2O4I2MjAwODMy.X2iRwg.Rf3-TqLExWuPQjxnVaDCGv9V7cB",
      "botTestId": "12412142412",
      "guildId": "514212632960122287894",
      "channelId": "514212632960122287894",
      "modulePathIgnorePatterns": ["(?:^|/)node_modules/"],
      "botPrefix": "!",
      "testMatches": ["./test/**"],
      "timeout": 5000
    }
  ],
  "required": ["cordeBotToken", "botTestId", "guildId", "channelId", "botPrefix", "testMatches"],
  "properties": {
    "cordeBotToken": {
      "default": "",
      "description": "",
      "title": "The bot token that Corde will use to simulate a user."
    },
    "botTestId": {
      "default": "",
      "title": "Your bot's id."
    },
    "guildId": {
      "default": "",
      "title": "The id of the guild where both bots are."
    },
    "channelId": {
      "default": "",
      "title": "The id of the channel where both bots are."
    },
    "botPrefix": {
      "default": "",
      "title": "Prefix for call your bot."
    },
    "testMatches": {
      "default": [],
      "title": "Array with the pattern for tests",
      "additionalItems": true
    },
    "timeout": {
      "default": 5000,
      "title": "Timeout for each test. Value mesuared in miliseconds.",
      "type": "number"
    },
    "modulePathIgnorePatterns": {
      "title": "Definition of all paterns to ignore in tests search",
      "default": ["(?:^|/)node_modules/"],
      "additionalItems": true,
      "type": "array"
    },
    "extentions": {
      "title": "Define file extensions to be loaded",
      "default": "['.js','.ts']",
      "additionalItems": true,
      "type": "array"
    },
    "rootDir": {
      "title": "Defines root dir of the project.",
      "default": ".",
      "type": "string"
    },
    "project": {
      "title": "Definition of tsconfig path.",
      "default": "<rootDir>/tsconfig.json",
      "type": "string"
    },
    "exitOnFileReadingError": {
      "title": "Define if corde should stop if any problem occour when importing a test file.",
      "default": true,
      "type": "boolean"
    }
  },
  "additionalProperties": true
}