Skip to content
This repository has been archived by the owner on Feb 7, 2023. It is now read-only.

schema: config

Brian Muenzenmeyer edited this page Apr 20, 2018 · 4 revisions
{
  "$id": "Pattern Lab Node | config", 
  "type": "object", 
  "definitions": {}, 
  "$schema": "http://json-schema.org/draft-07/schema#", 
  "properties": {
    "cacheBust": {
      "$id": "/properties/cacheBust", 
      "type": "boolean", 
      "examples": [
        true
      ]
    }, 
    "cleanPublic": {
      "$id": "/properties/cleanPublic", 
      "type": "boolean", 
      "examples": [
        true
      ]
    }, 
    "defaultPattern": {
      "$id": "/properties/defaultPattern", 
      "type": "string", 
      "examples": [
        "all"
      ]
    }, 
    "defaultShowPatternInfo": {
      "$id": "/properties/defaultShowPatternInfo", 
      "type": "boolean", 
      "examples": [
        false
      ]
    }, 
    "ishControlsHide": {
      "$id": "/properties/ishControlsHide", 
      "type": "object", 
      "properties": {
        "s": {
          "$id": "/properties/ishControlsHide/properties/s", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "m": {
          "$id": "/properties/ishControlsHide/properties/m", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "l": {
          "$id": "/properties/ishControlsHide/properties/l", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "full": {
          "$id": "/properties/ishControlsHide/properties/full", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "random": {
          "$id": "/properties/ishControlsHide/properties/random", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "disco": {
          "$id": "/properties/ishControlsHide/properties/disco", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "hay": {
          "$id": "/properties/ishControlsHide/properties/hay", 
          "type": "boolean", 
          "examples": [
            true
          ]
        }, 
        "mqs": {
          "$id": "/properties/ishControlsHide/properties/mqs", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "find": {
          "$id": "/properties/ishControlsHide/properties/find", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "views-all": {
          "$id": "/properties/ishControlsHide/properties/views-all", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "views-annotations": {
          "$id": "/properties/ishControlsHide/properties/views-annotations", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "views-code": {
          "$id": "/properties/ishControlsHide/properties/views-code", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "views-new": {
          "$id": "/properties/ishControlsHide/properties/views-new", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "tools-all": {
          "$id": "/properties/ishControlsHide/properties/tools-all", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }, 
        "tools-docs": {
          "$id": "/properties/ishControlsHide/properties/tools-docs", 
          "type": "boolean", 
          "examples": [
            false
          ]
        }
      }
    }, 
    "ishViewportRange": {
      "$id": "/properties/ishViewportRange", 
      "type": "object", 
      "properties": {
        "s": {
          "$id": "/properties/ishViewportRange/properties/s", 
          "type": "array", 
          "items": {
            "$id": "/properties/ishViewportRange/properties/s/items", 
            "type": "integer", 
            "examples": [
              240, 
              500
            ]
          }
        }, 
        "m": {
          "$id": "/properties/ishViewportRange/properties/m", 
          "type": "array", 
          "items": {
            "$id": "/properties/ishViewportRange/properties/m/items", 
            "type": "integer", 
            "examples": [
              500, 
              800
            ]
          }
        }, 
        "l": {
          "$id": "/properties/ishViewportRange/properties/l", 
          "type": "array", 
          "items": {
            "$id": "/properties/ishViewportRange/properties/l/items", 
            "type": "integer", 
            "examples": [
              800, 
              2600
            ]
          }
        }
      }
    }, 
    "logLevel": {
      "$id": "/properties/logLevel", 
      "type": "string", 
      "examples": [
        "info"
      ]
    }, 
    "outputFileSuffixes": {
      "$id": "/properties/outputFileSuffixes", 
      "type": "object", 
      "properties": {
        "rendered": {
          "$id": "/properties/outputFileSuffixes/properties/rendered", 
          "type": "string", 
          "examples": [
            ".rendered"
          ]
        }, 
        "rawTemplate": {
          "$id": "/properties/outputFileSuffixes/properties/rawTemplate", 
          "type": "string", 
          "examples": [
            ""
          ]
        }, 
        "markupOnly": {
          "$id": "/properties/outputFileSuffixes/properties/markupOnly", 
          "type": "string", 
          "examples": [
            ".markup-only"
          ]
        }
      }
    }, 
    "paths": {
      "$id": "/properties/paths", 
      "type": "object", 
      "properties": {
        "source": {
          "$id": "/properties/paths/properties/source", 
          "type": "object", 
          "properties": {
            "root": {
              "$id": "/properties/paths/properties/source/properties/root", 
              "type": "string", 
              "examples": [
                "./source/"
              ]
            }, 
            "patterns": {
              "$id": "/properties/paths/properties/source/properties/patterns", 
              "type": "string", 
              "examples": [
                "./source/_patterns/"
              ]
            }, 
            "data": {
              "$id": "/properties/paths/properties/source/properties/data", 
              "type": "string", 
              "examples": [
                "./source/_data/"
              ]
            }, 
            "meta": {
              "$id": "/properties/paths/properties/source/properties/meta", 
              "type": "string", 
              "examples": [
                "./source/_meta/"
              ]
            }, 
            "annotations": {
              "$id": "/properties/paths/properties/source/properties/annotations", 
              "type": "string", 
              "examples": [
                "./source/_annotations/"
              ]
            }, 
            "styleguide": {
              "$id": "/properties/paths/properties/source/properties/styleguide", 
              "type": "string", 
              "examples": [
                "dist/"
              ]
            }, 
            "patternlabFiles": {
              "$id": "/properties/paths/properties/source/properties/patternlabFiles", 
              "type": "object", 
              "properties": {
                "general-header": {
                  "$id": "/properties/paths/properties/source/properties/patternlabFiles/properties/general-header", 
                  "type": "string", 
                  "examples": [
                    "views/partials/general-header.mustache"
                  ]
                }, 
                "general-footer": {
                  "$id": "/properties/paths/properties/source/properties/patternlabFiles/properties/general-footer", 
                  "type": "string", 
                  "examples": [
                    "views/partials/general-footer.mustache"
                  ]
                }, 
                "patternSection": {
                  "$id": "/properties/paths/properties/source/properties/patternlabFiles/properties/patternSection", 
                  "type": "string", 
                  "examples": [
                    "views/partials/patternSection.mustache"
                  ]
                }, 
                "patternSectionSubtype": {
                  "$id": "/properties/paths/properties/source/properties/patternlabFiles/properties/patternSectionSubtype", 
                  "type": "string", 
                  "examples": [
                    "views/partials/patternSectionSubtype.mustache"
                  ]
                }, 
                "viewall": {
                  "$id": "/properties/paths/properties/source/properties/patternlabFiles/properties/viewall", 
                  "type": "string", 
                  "examples": [
                    "views/viewall.mustache"
                  ]
                }
              }
            }, 
            "js": {
              "$id": "/properties/paths/properties/source/properties/js", 
              "type": "string", 
              "examples": [
                "./source/js"
              ]
            }, 
            "images": {
              "$id": "/properties/paths/properties/source/properties/images", 
              "type": "string", 
              "examples": [
                "./source/images"
              ]
            }, 
            "fonts": {
              "$id": "/properties/paths/properties/source/properties/fonts", 
              "type": "string", 
              "examples": [
                "./source/fonts"
              ]
            }, 
            "css": {
              "$id": "/properties/paths/properties/source/properties/css", 
              "type": "string", 
              "examples": [
                "./source/css"
              ]
            }
          }
        }, 
        "public": {
          "$id": "/properties/paths/properties/public", 
          "type": "object", 
          "properties": {
            "root": {
              "$id": "/properties/paths/properties/public/properties/root", 
              "type": "string", 
              "examples": [
                "public/"
              ]
            }, 
            "patterns": {
              "$id": "/properties/paths/properties/public/properties/patterns", 
              "type": "string", 
              "examples": [
                "public/patterns/"
              ]
            }, 
            "data": {
              "$id": "/properties/paths/properties/public/properties/data", 
              "type": "string", 
              "examples": [
                "public/styleguide/data/"
              ]
            }, 
            "annotations": {
              "$id": "/properties/paths/properties/public/properties/annotations", 
              "type": "string", 
              "examples": [
                "public/annotations/"
              ]
            }, 
            "styleguide": {
              "$id": "/properties/paths/properties/public/properties/styleguide", 
              "type": "string", 
              "examples": [
                "public/styleguide/"
              ]
            }, 
            "js": {
              "$id": "/properties/paths/properties/public/properties/js", 
              "type": "string", 
              "examples": [
                "public/js"
              ]
            }, 
            "images": {
              "$id": "/properties/paths/properties/public/properties/images", 
              "type": "string", 
              "examples": [
                "public/images"
              ]
            }, 
            "fonts": {
              "$id": "/properties/paths/properties/public/properties/fonts", 
              "type": "string", 
              "examples": [
                "public/fonts"
              ]
            }, 
            "css": {
              "$id": "/properties/paths/properties/public/properties/css", 
              "type": "string", 
              "examples": [
                "public/css"
              ]
            }
          }
        }
      }
    }, 
    "patternExtension": {
      "$id": "/properties/patternExtension", 
      "type": "string", 
      "examples": [
        "mustache"
      ]
    }, 
    "patternStateCascade": {
      "$id": "/properties/patternStateCascade", 
      "type": "array", 
      "items": {
        "$id": "/properties/patternStateCascade/items", 
        "type": "string", 
        "examples": [
          "inprogress", 
          "inreview", 
          "complete"
        ]
      }
    }, 
    "patternExportDirectory": {
      "$id": "/properties/patternExportDirectory", 
      "type": "string", 
      "examples": [
        "./pattern_exports/"
      ]
    }, 
    "patternExportPatternPartials": {
      "$id": "/properties/patternExportPatternPartials", 
      "type": "array"
    }, 
    "serverOptions": {
      "$id": "/properties/serverOptions", 
      "type": "object", 
      "properties": {
        "wait": {
          "$id": "/properties/serverOptions/properties/wait", 
          "type": "integer", 
          "examples": [
            1000
          ]
        }
      }
    }, 
    "starterkitSubDir": {
      "$id": "/properties/starterkitSubDir", 
      "type": "string", 
      "examples": [
        "dist"
      ]
    }, 
    "styleGuideExcludes": {
      "$id": "/properties/styleGuideExcludes", 
      "type": "array"
    }, 
    "theme": {
      "$id": "/properties/theme", 
      "type": "object", 
      "properties": {
        "color": {
          "$id": "/properties/theme/properties/color", 
          "type": "string", 
          "examples": [
            "dark"
          ]
        }, 
        "density": {
          "$id": "/properties/theme/properties/density", 
          "type": "string", 
          "examples": [
            "compact"
          ]
        }, 
        "layout": {
          "$id": "/properties/theme/properties/layout", 
          "type": "string", 
          "examples": [
            "horizontal"
          ]
        }
      }
    }, 
    "uikits": {
      "$id": "/properties/uikits", 
      "type": "array", 
      "items": {
        "$id": "/properties/uikits/items", 
        "type": "object", 
        "properties": {
          "name": {
            "$id": "/properties/uikits/items/properties/name", 
            "type": "string", 
            "examples": [
              "uikit-workshop"
            ]
          }, 
          "outputDir": {
            "$id": "/properties/uikits/items/properties/outputDir", 
            "type": "string", 
            "examples": [
              "workshop"
            ]
          }, 
          "enabled": {
            "$id": "/properties/uikits/items/properties/enabled", 
            "type": "boolean", 
            "examples": [
              true
            ]
          }, 
          "excludedPatternStates": {
            "$id": "/properties/uikits/items/properties/excludedPatternStates", 
            "type": "array"
          }, 
          "excludedTags": {
            "$id": "/properties/uikits/items/properties/excludedTags", 
            "type": "array"
          }
        }
      }
    }, 
    "plugins": {
      "$id": "/properties/plugins", 
      "type": "object", 
      "properties": {
        "@pattern-lab/plugin-tab": {
          "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab", 
          "type": "object", 
          "properties": {
            "enabled": {
              "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab/properties/enabled", 
              "type": "boolean", 
              "examples": [
                true
              ]
            }, 
            "initialized": {
              "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab/properties/initialized", 
              "type": "boolean", 
              "examples": [
                true
              ]
            }, 
            "options": {
              "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab/properties/options", 
              "type": "object", 
              "properties": {
                "tabsToAdd": {
                  "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab/properties/options/properties/tabsToAdd", 
                  "type": "array", 
                  "items": {
                    "$id": "/properties/plugins/properties/@pattern-lab/plugin-tab/properties/options/properties/tabsToAdd/items", 
                    "type": "string", 
                    "examples": [
                      ".json"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
Clone this wiki locally