generate-examples-index-webpack-plugin/schema/plugin.json

Generate an examples index page from your examples folder

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "examples": {
      "description": "Path were your examples are",
      "type": "string"
    },
    "outputPath": {
      "description": "Your examples will be built and placed here",
      "type": "string"
    },
    "assets": {
      "description": "Name for the assets folder",
      "type": "string"
    },
    "static": {
      "description": "Path with the static contents to copy into the assets folder",
      "type": "string"
    },
    "vendorName": {
      "description": "Name to use for the generated vendor file",
      "type": "string"
    },
    "vendorFolder": {
      "description": "Path of the folder with files to include in the vendor file",
      "type": "string"
    },
    "vendorContent": {
      "description": "List of contents to include in the vendor file",
      "type": "array"
    },
    "packageJson": {
      "description": "Object or path of the project package.json to retrieve information",
      "test": {
        "anyOf": [
          { "type": "string" },
          { "type": "boolean" }
        ]
      }
    },
    "analyzer": {
      "description": "Path for the file with the analysis results of your examples provided by `webpack-bundle-analyzer`. Leave undefined to disable it",
      "type": "string"
    },
    "templateIndex": {
      "description": "Path to the file with the HTML template to use for the examples index",
      "type": "string"
    },
    "breadcrumbsHtmlGenerator": {
      "description": "function(route) returning the HTML for the breadcrumbs placeholder",
      "instanceof": "Function"
    },
    "examplesIndexHtmlGenerator": {
      "description": "function(entry) returning the HTML for the examplesIndex placeholder",
      "instanceof": "Function"
    },
    "buildTimeLocale": {
      "description": "Locale for the buildTime placeholder (accepted by Date.toLocaleString)",
      "type": "string"
    },
    "buildTimeOptions": {
      "description": "Options for the buildTime placeholder (accepted by Date.toLocaleString)",
      "type": "object"
    },
    "addJsExtension": {
      "description": "Set to true if your webpack options output.filename has no extension (because it comes from the vendor/file name)",
      "type": "boolean"
    },
    "noEntries": {
      "description": "Set to `true` if your project has no entry files (webpack is just used to generate examples with this plugin), to avoid the message *ERROR in Entry module not found: Error: Can't resolve './src'*",
      "type": "boolean"
    },
    "excludeAssets": {
      "description": "Set to `true` to hide the assets produced by this plugin",
      "type": "boolean"
    }
  }
}