coz-bud/lib/spec.json

bud for coz

{
  "about": "A bud contains file meta data like witch template to use, where to render it, what permission to give, and so on.",
  "properties": {
    "engine": {
      "configurable": true,
      "default": "'handlebars'",
      "description": "Template engine name or engine itself",
      "required": false,
      "type": "string|object"
    },
    "cwd": {
      "configurable": true,
      "default": "process.cwd()",
      "description": "Working directory path",
      "required": false,
      "type": "string"
    },
    "data": {
      "configurable": true,
      "description": "Data which template render with",
      "required": true,
      "type": "object"
    },
    "done": {
      "configurable": false,
      "description": "Done to writeout or not",
      "type": "boolean"
    },
    "mkdirp": {
      "configurable": true,
      "description": "Make parent directories if needed",
      "default": false,
      "type": "boolean"
    },
    "setup": {
      "configurable": true,
      "description": "Optional settings for template engine",
      "required": false,
      "type": "object"
    },
    "force": {
      "configurable": true,
      "description": "Should overwrite file when already exists, or not",
      "default": "false",
      "required": false,
      "type": "boolean"
    },
    "mode": {
      "configurable": true,
      "description": "Permission of generated files. (eg., '444' for readonly files)",
      "default": "'644'",
      "required": false,
      "type": "string|number"
    },
    "path": {
      "configurable": true,
      "description": "Destination file path. If not provided, guess from bud file path",
      "required": false,
      "type": "string"
    },
    "src": {
      "configurable": false,
      "description": "Bud source file path",
      "type": "string"
    },
    "tmpl": {
      "configurable": true,
      "default": "'json'",
      "description": "Template file path or registered template name or template function",
      "required": "false",
      "type": "string|function"
    }
  }
}