schema.json

{
  "$ref": "#/definitions/Config",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "Config": {
      "anyOf": [
        {
          "additionalProperties": false,
          "properties": {
            "$schema": {
              "type": "string"
            },
            "clientEntry": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "type": "object"
                }
              ],
              "markdownDescription": "Client entry point, use the [webpack entry format](https://webpack.js.org/concepts/#entry)."
            },
            "clientSourceMap": {
              "description": "Produce source for map for client code?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "compileClientNodeModules": {
              "markdownDescription": "Should compile `node_modules` for client code?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "crawlConcurrency": {
              "markdownDescription": "Concurrency while staticize.\n\nDefault to `4`.",
              "type": "number"
            },
            "crawlEnabled": {
              "markdownDescription": "Enable crawl links when staticize?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "exitStaticizeOnError": {
              "description": "Exit the staticize process when encounter an error?\n\nDefault to `false`.",
              "type": "boolean"
            },
            "experimentalBuildOutput": {
              "const": "standalone",
              "markdownDescription": "Use `'standalone'` to export a standalone version of Pluffa Node\nutil for ship it in a container environment.",
              "type": "string"
            },
            "nodeModule": {
              "enum": [
                "commonjs",
                "esm"
              ],
              "markdownDescription": "The import compilation format of NodeJS code.\n\nDefault to `'esm'`.",
              "type": "string"
            },
            "outputDir": {
              "markdownDescription": "Output direcotry of staticize command.\n\nDefault to `'build'`.",
              "type": "string"
            },
            "port": {
              "markdownDescription": "Http port of webserver.\n\nDefault to `7000`.",
              "type": "number"
            },
            "proxy": {
              "markdownDescription": "If specified Pluffa will use the given URL as proxy.\nUtil for avoiding CORS problems in development.\n\n**IMPORTANT**:\nBy default the proxy is not enabled when running the server\nin production mode by running the `start` command.\nIf you really you want to use a proxy in production mode set\n`useProxyInProd` to `true`.",
              "type": "string"
            },
            "publicDir": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "const": false,
                  "type": "boolean"
                }
              ],
              "markdownDescription": "Public direcotry used to serve public files.\nSet `false` to disable serving public files.\n\nDefault to `'public'`."
            },
            "runtime": {
              "const": "node",
              "description": "Pluffa runtime.",
              "type": "string"
            },
            "serveStaticAssets": {
              "description": "Should serve static assets on production server?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "serverComponent": {
              "description": "Path to Server React Component file.",
              "type": "string"
            },
            "skeletonComponent": {
              "description": "Path to Skeleton React Component file.",
              "type": "string"
            },
            "statikDataDir": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "const": false,
                  "type": "boolean"
                }
              ],
              "markdownDescription": "Directory where exports the statik files when staticize.\n\nDefault to `'data'`."
            },
            "statikHandler": {
              "description": "Path of statik handler file.",
              "type": "string"
            },
            "urls": {
              "items": {
                "type": "string"
              },
              "markdownDescription": "Urls to start the staticize process.\n\nDefault to: `['/']`.",
              "type": "array"
            },
            "useHelpersForClientCode": {
              "markdownDescription": "Use external helpers package when compiling client code?\n\n- Install `@babel/runtime` for Babel.\n- Install `@swc/helpers` for SWC.\n\nDefault to `false`.",
              "type": "boolean"
            },
            "useProxyInProd": {
              "description": "Use proxy in the production server? Default to `false`.",
              "type": "boolean"
            },
            "useSwc": {
              "markdownDescription": "Use the [SWC](https://swc.rs) Rust compiler instead of [Babel](https://babeljs.io) to speed\nup code compilation.\n\nDefault to `false`.",
              "type": "boolean"
            }
          },
          "required": [
            "clientEntry",
            "runtime",
            "serverComponent",
            "skeletonComponent"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "$schema": {
              "type": "string"
            },
            "clientEntry": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "type": "object"
                }
              ],
              "markdownDescription": "Client entry point, use the [webpack entry format](https://webpack.js.org/concepts/#entry)."
            },
            "clientSourceMap": {
              "markdownDescription": "Produce source for map for client code?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "compileClientNodeModules": {
              "markdownDescription": "Should compile `node_modules` for client code?\n\nDefault to `true`.",
              "type": "boolean"
            },
            "miniflareConfig": {
              "markdownDescription": "Inject extra [Miniflare](https://miniflare.dev/get-started/api) configuration.\nNote this configs only effect yout dev environment.",
              "type": "object"
            },
            "outputDir": {
              "markdownDescription": "Output directory of your worker runtime code.\n\nDefault to `'build'`.",
              "type": "string"
            },
            "port": {
              "markdownDescription": "Http port of webserver.\n\nDefault to `7000`.",
              "type": "number"
            },
            "publicDir": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "const": false,
                  "type": "boolean"
                }
              ],
              "markdownDescription": "Public direcotry used to serve public files.\nSet `false` to disable serving public files.\n\nDefault to `'public'`."
            },
            "runtime": {
              "const": "cloudflare-workers",
              "description": "Pluffa runtime.",
              "type": "string"
            },
            "useHelpersForClientCode": {
              "markdownDescription": "Use external helpers package when compiling client code?\n\n- Install `@babel/runtime` for Babel.\n- Install `@swc/helpers` for SWC.\n\nDefault to `false`.",
              "type": "boolean"
            },
            "useSwc": {
              "markdownDescription": "Use the [SWC](https://swc.rs) Rust compiler instead of [Babel](https://babeljs.io) to speed\nup code compilation.\n\nDefault to `false`.",
              "type": "boolean"
            },
            "workerEntry": {
              "description": "Path to to your worker file.",
              "type": "string"
            }
          },
          "required": [
            "clientEntry",
            "runtime",
            "workerEntry"
          ],
          "type": "object"
        }
      ]
    }
  }
}