staticforge 0.0.0-stage → 0.1.0

package/schema/staticforge.schema.json

@@ -0,0 +1,649 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "site": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "baseUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Absolute production URL, used for canonical links, feeds and sitemaps."
+        },
+        "language": {
+          "default": "en",
+          "type": "string",
+          "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z0-9]{2,8})*$"
+        },
+        "description": {
+          "type": "string"
+        },
+        "author": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "title",
+        "baseUrl"
+      ],
+      "additionalProperties": false
+    },
+    "theme": {
+      "default": "default",
+      "description": "\"default\", a path to a theme directory, or an npm package name.",
+      "type": "string",
+      "minLength": 1
+    },
+    "build": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "outDir": {
+          "default": "dist",
+          "type": "string",
+          "minLength": 1
+        },
+        "cleanUrls": {
+          "default": true,
+          "type": "boolean"
+        },
+        "trailingSlash": {
+          "default": "always",
+          "type": "string",
+          "enum": [
+            "always",
+            "never"
+          ]
+        },
+        "minify": {
+          "default": true,
+          "type": "boolean"
+        },
+        "drafts": {
+          "default": false,
+          "type": "boolean"
+        },
+        "workers": {
+          "default": "auto",
+          "description": "Worker threads for parsing, rendering and checking: \"auto\" (all cores but one, at most 8) or a number; 0 uses the main thread only. SFORGE_WORKERS overrides it.",
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 64
+            },
+            {
+              "type": "string",
+              "const": "auto"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "images": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "formats": {
+          "default": [
+            "avif",
+            "webp"
+          ],
+          "minItems": 1,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "avif",
+              "webp",
+              "jpeg",
+              "png"
+            ]
+          }
+        },
+        "widths": {
+          "default": [
+            480,
+            960,
+            1600
+          ],
+          "minItems": 1,
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 16,
+            "maximum": 8192
+          }
+        },
+        "quality": {
+          "default": 75,
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100
+        },
+        "optimize": {
+          "default": true,
+          "description": "Resize content images into responsive AVIF/WebP variants.",
+          "type": "boolean"
+        },
+        "sizes": {
+          "default": "(min-width: 45rem) 45rem, 100vw",
+          "description": "The `sizes` attribute of responsive images: their width in the layout.",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "styles": {
+      "default": [],
+      "description": "Stylesheets linked on every page, after the theme's, e.g. \"/assets/css/site.css\".",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^(\\/|https?:\\/\\/)"
+      }
+    },
+    "scripts": {
+      "default": [],
+      "description": "ES module scripts loaded on every page, after the theme's.",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^(\\/|https?:\\/\\/)"
+      }
+    },
+    "collections": {
+      "default": {},
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^[a-z][a-z0-9-]{0,31}$"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "dir": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Content directory of the collection, relative to the project."
+          },
+          "sortBy": {
+            "default": "date",
+            "type": "string",
+            "enum": [
+              "date",
+              "title",
+              "order"
+            ]
+          },
+          "perPage": {
+            "default": 10,
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 500
+          },
+          "feed": {
+            "default": {},
+            "type": "object",
+            "properties": {
+              "rss": {
+                "default": true,
+                "type": "boolean"
+              },
+              "atom": {
+                "default": true,
+                "type": "boolean"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "dir"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "search": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "default": true,
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "check": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "wcag": {
+          "default": "2.2-AA",
+          "type": "string",
+          "enum": [
+            "2.1-AA",
+            "2.2-AA",
+            "2.2-AAA"
+          ]
+        },
+        "failOn": {
+          "default": "error",
+          "type": "string",
+          "enum": [
+            "error",
+            "warning"
+          ]
+        },
+        "ignore": {
+          "default": [],
+          "description": "Rule IDs to skip.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "headless": {
+          "default": true,
+          "description": "Run rendered (axe-core + Chromium) checks.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "security": {
+      "description": "Security headers sent by the hosting providers.",
+      "default": {},
+      "type": "object",
+      "properties": {
+        "contentSecurityPolicy": {
+          "default": "default-src 'self'; script-src 'self'; style-src 'self'; style-src-attr 'unsafe-inline'; img-src 'self' data: https:; media-src 'self' https:; frame-src 'self' https:; object-src 'none'; base-uri 'self'; form-action 'self'; frame-ancestors 'self'; upgrade-insecure-requests",
+          "description": "Content-Security-Policy of every page; false sends none. The search page also gets 'wasm-unsafe-eval' (Pagefind).",
+          "anyOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "boolean",
+              "const": false
+            }
+          ]
+        },
+        "hsts": {
+          "description": "Strict-Transport-Security; false sends none.",
+          "default": {},
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "maxAge": {
+                  "default": 63072000,
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "includeSubDomains": {
+                  "default": false,
+                  "type": "boolean"
+                },
+                "preload": {
+                  "default": false,
+                  "type": "boolean"
+                }
+              },
+              "additionalProperties": false
+            },
+            {
+              "type": "boolean",
+              "const": false
+            }
+          ]
+        },
+        "referrerPolicy": {
+          "default": "strict-origin-when-cross-origin",
+          "type": "string",
+          "enum": [
+            "no-referrer",
+            "no-referrer-when-downgrade",
+            "origin",
+            "origin-when-cross-origin",
+            "same-origin",
+            "strict-origin",
+            "strict-origin-when-cross-origin",
+            "unsafe-url"
+          ]
+        },
+        "frameOptions": {
+          "default": "SAMEORIGIN",
+          "anyOf": [
+            {
+              "type": "string",
+              "enum": [
+                "DENY",
+                "SAMEORIGIN"
+              ]
+            },
+            {
+              "type": "boolean",
+              "const": false
+            }
+          ]
+        },
+        "permissionsPolicy": {
+          "default": "camera=(), microphone=(), geolocation=(), payment=(), usb=()",
+          "anyOf": [
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "boolean",
+              "const": false
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "iac": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "Project name used in state keys and cloud resource names. Defaults to the host of site.baseUrl.",
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,39}$"
+        },
+        "engine": {
+          "default": "tofu",
+          "type": "string",
+          "enum": [
+            "tofu",
+            "terraform"
+          ]
+        },
+        "version": {
+          "description": "Override the pinned engine version.",
+          "type": "string"
+        },
+        "vendor": {
+          "default": false,
+          "description": "Copy HCL modules into the workspace for auditing.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "targets": {
+      "default": {},
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^[a-z][a-z0-9-]{0,31}$"
+      },
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "provider": {
+                "type": "string",
+                "const": "aws"
+              },
+              "region": {
+                "type": "string",
+                "pattern": "^[a-z]{2}(-[a-z]+)+-\\d$"
+              },
+              "domain": {
+                "description": "Custom domain. Omit to use the *.cloudfront.net URL.",
+                "type": "string",
+                "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
+              },
+              "hostedZone": {
+                "description": "Route 53 hosted zone for automatic DNS validation and alias records.",
+                "type": "string",
+                "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
+              },
+              "previewDomain": {
+                "description": "Wildcard parent for PR previews (pr-<n>.<previewDomain>). Requires a custom domain.",
+                "type": "string",
+                "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
+              },
+              "retainVersions": {
+                "default": 10,
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 100
+              },
+              "logging": {
+                "default": false,
+                "description": "Enable CloudFront standard access logs.",
+                "type": "boolean"
+              },
+              "wafWebAclArn": {
+                "type": "string",
+                "format": "starts_with",
+                "pattern": "^arn:aws:wafv2:.*"
+              },
+              "state": {
+                "description": "Remote state backend (S3 with native locking), created by --bootstrap-state.",
+                "default": {},
+                "type": "object",
+                "properties": {
+                  "bucket": {
+                    "description": "State bucket. Defaults to \"sforge-state-<accountId>-<region>\".",
+                    "type": "string",
+                    "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"
+                  },
+                  "region": {
+                    "description": "Region of the state bucket. Defaults to the target's region.",
+                    "type": "string",
+                    "pattern": "^[a-z]{2}(-[a-z]+)+-\\d$"
+                  },
+                  "kmsKeyArn": {
+                    "description": "Encrypt state with this KMS key instead of SSE-S3.",
+                    "type": "string",
+                    "format": "starts_with",
+                    "pattern": "^arn:aws:kms:.*"
+                  }
+                },
+                "additionalProperties": false
+              },
+              "ci": {
+                "type": "object",
+                "properties": {
+                  "repo": {
+                    "type": "string",
+                    "pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$",
+                    "description": "GitHub repository allowed to deploy, as \"owner/repo\"."
+                  },
+                  "branches": {
+                    "default": [
+                      "main"
+                    ],
+                    "description": "Branches whose workflows may deploy.",
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  },
+                  "environments": {
+                    "default": [],
+                    "description": "GitHub deployment environments whose workflows may deploy.",
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  },
+                  "pullRequests": {
+                    "default": true,
+                    "description": "Allow pull_request workflows to deploy previews.",
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "repo"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "provider",
+              "region"
+            ],
+            "additionalProperties": false
+          },
+          {
+            "type": "object",
+            "properties": {
+              "provider": {
+                "type": "string",
+                "const": "azure"
+              },
+              "subscriptionId": {
+                "description": "Defaults to the subscription of the active credential.",
+                "type": "string",
+                "format": "uuid",
+                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+              },
+              "resourceGroup": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 90
+              },
+              "createResourceGroup": {
+                "default": true,
+                "description": "Create the resource group (and delete it on destroy). False uses an existing one.",
+                "type": "boolean"
+              },
+              "location": {
+                "type": "string",
+                "minLength": 1,
+                "description": "Azure region, e.g. \"westeurope\". Static Web Apps exist in westus2, centralus, eastus2, westeurope and eastasia."
+              },
+              "sku": {
+                "default": "Free",
+                "type": "string",
+                "enum": [
+                  "Free",
+                  "Standard"
+                ]
+              },
+              "retainVersions": {
+                "default": 10,
+                "description": "Deployed versions kept in the history that rollback chooses from.",
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 100
+              },
+              "domain": {
+                "type": "string",
+                "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
+              },
+              "dnsZone": {
+                "description": "Azure DNS zone resource ID for automatic CNAME records.",
+                "type": "string"
+              },
+              "state": {
+                "description": "Remote state backend (Azure Blob Storage), created by --bootstrap-state.",
+                "default": {},
+                "type": "object",
+                "properties": {
+                  "resourceGroup": {
+                    "description": "Defaults to \"sforge-state\".",
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 90
+                  },
+                  "storageAccount": {
+                    "description": "Defaults to \"sfstate\" + a hash of the subscription ID.",
+                    "type": "string",
+                    "pattern": "^[a-z0-9]{3,24}$"
+                  },
+                  "container": {
+                    "default": "tfstate",
+                    "type": "string",
+                    "minLength": 3,
+                    "maxLength": 63
+                  },
+                  "location": {
+                    "description": "Region of the state storage account. Defaults to the target's location; set it when Azure is not accepting new storage accounts there.",
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "additionalProperties": false
+              },
+              "ci": {
+                "type": "object",
+                "properties": {
+                  "repo": {
+                    "type": "string",
+                    "pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$",
+                    "description": "GitHub repository allowed to deploy, as \"owner/repo\"."
+                  },
+                  "branches": {
+                    "default": [
+                      "main"
+                    ],
+                    "description": "Branches whose workflows may deploy.",
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  },
+                  "environments": {
+                    "default": [],
+                    "description": "GitHub deployment environments whose workflows may deploy.",
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  },
+                  "pullRequests": {
+                    "default": true,
+                    "description": "Allow pull_request workflows to deploy previews.",
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "repo"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "provider",
+              "resourceGroup",
+              "location"
+            ],
+            "additionalProperties": false
+          }
+        ]
+      }
+    }
+  },
+  "required": [
+    "site"
+  ],
+  "additionalProperties": false,
+  "description": "staticforge project configuration",
+  "$id": "urn:staticforge:schema:config:v1",
+  "title": "staticforge configuration"
+}