Skip to main content

CONFIG_SCHEMA_JSON

Constant CONFIG_SCHEMA_JSON 

Source
pub const CONFIG_SCHEMA_JSON: &str = "{\n  \"$defs\": {\n    \"CommandEntry\": {\n      \"anyOf\": [\n        {\n          \"description\": \"Shell command string.\",\n          \"type\": \"string\"\n        },\n        {\n          \"$ref\": \"#/$defs/CommandObject\",\n          \"description\": \"Command object entry.\"\n        }\n      ]\n    },\n    \"CommandObject\": {\n      \"anyOf\": [\n        {\n          \"$ref\": \"#/$defs/ShellCommandObject\",\n          \"description\": \"Shell command object.\"\n        },\n        {\n          \"$ref\": \"#/$defs/DirectCommandObject\",\n          \"description\": \"Direct program command object.\"\n        }\n      ]\n    },\n    \"CopyEntry\": {\n      \"anyOf\": [\n        {\n          \"description\": \"Source and target use the same relative path.\",\n          \"type\": \"string\"\n        },\n        {\n          \"$ref\": \"#/$defs/CopyObject\",\n          \"description\": \"Copy object entry.\"\n        }\n      ]\n    },\n    \"CopyObject\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"ignore\": {\n          \"description\": \"Source-relative path patterns that copy should skip.\",\n          \"items\": {\n            \"type\": \"string\"\n          },\n          \"type\": \"array\"\n        },\n        \"ignore_metadata\": {\n          \"description\": \"Metadata fields that copy should not compare or apply.\",\n          \"items\": {\n            \"$ref\": \"#/$defs/MetadataField\"\n          },\n          \"type\": \"array\"\n        },\n        \"include\": {\n          \"description\": \"Source-relative path patterns that narrow directory copies to\\nmatching source paths.\",\n          \"items\": {\n            \"type\": \"string\"\n          },\n          \"type\": \"array\"\n        },\n        \"required\": {\n          \"description\": \"Whether a missing source should fail validation.\",\n          \"type\": \"boolean\"\n        },\n        \"source\": {\n          \"description\": \"Source path, relative to the root checkout unless absolute.\",\n          \"type\": \"string\"\n        },\n        \"symlinks\": {\n          \"$ref\": \"#/$defs/SymlinkMode\",\n          \"description\": \"How safe source symlinks are handled.\"\n        },\n        \"target\": {\n          \"description\": \"Target path, relative to the current worktree unless absolute.\",\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"source\"\n      ],\n      \"type\": \"object\"\n    },\n    \"DirectCommandObject\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"allow_failure\": {\n          \"description\": \"Whether a non-zero exit status should be non-fatal.\",\n          \"type\": \"boolean\"\n        },\n        \"args\": {\n          \"description\": \"Program arguments.\",\n          \"items\": {\n            \"type\": \"string\"\n          },\n          \"type\": \"array\"\n        },\n        \"cwd\": {\n          \"description\": \"Command working directory, relative to the worktree unless absolute.\",\n          \"type\": \"string\"\n        },\n        \"env\": {\n          \"additionalProperties\": {\n            \"type\": \"string\"\n          },\n          \"description\": \"Extra environment variables for this command.\",\n          \"type\": \"object\"\n        },\n        \"name\": {\n          \"description\": \"Optional display name.\",\n          \"type\": \"string\"\n        },\n        \"program\": {\n          \"description\": \"Program executable.\",\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"program\"\n      ],\n      \"type\": \"object\"\n    },\n    \"MetadataField\": {\n      \"enum\": [\n        \"permissions\",\n        \"owner\",\n        \"group\",\n        \"ownership\"\n      ],\n      \"type\": \"string\"\n    },\n    \"MixedFileObject\": {\n      \"oneOf\": [\n        {\n          \"additionalProperties\": false,\n          \"description\": \"Copy object entry for mixed `files` and `[[file]]` declarations.\",\n          \"properties\": {\n            \"ignore\": {\n              \"description\": \"Source-relative path patterns that copy should skip.\",\n              \"items\": {\n                \"type\": \"string\"\n              },\n              \"type\": \"array\"\n            },\n            \"ignore_metadata\": {\n              \"description\": \"Metadata fields that copy should not compare or apply.\",\n              \"items\": {\n                \"$ref\": \"#/$defs/MetadataField\"\n              },\n              \"type\": \"array\"\n            },\n            \"include\": {\n              \"description\": \"Source-relative path patterns that narrow directory copies to\\nmatching source paths.\",\n              \"items\": {\n                \"type\": \"string\"\n              },\n              \"type\": \"array\"\n            },\n            \"operation\": {\n              \"const\": \"copy\",\n              \"type\": \"string\"\n            },\n            \"required\": {\n              \"description\": \"Whether a missing source should fail validation.\",\n              \"type\": \"boolean\"\n            },\n            \"source\": {\n              \"description\": \"Source path, relative to the root checkout unless absolute.\",\n              \"type\": \"string\"\n            },\n            \"symlinks\": {\n              \"$ref\": \"#/$defs/SymlinkMode\",\n              \"description\": \"How safe source symlinks are handled.\"\n            },\n            \"target\": {\n              \"description\": \"Target path, relative to the current worktree unless absolute.\",\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"operation\",\n            \"source\"\n          ],\n          \"type\": \"object\"\n        },\n        {\n          \"additionalProperties\": false,\n          \"description\": \"Symlink object entry for mixed `files` and `[[file]]` declarations.\",\n          \"properties\": {\n            \"operation\": {\n              \"const\": \"symlink\",\n              \"type\": \"string\"\n            },\n            \"required\": {\n              \"description\": \"Whether a missing source should fail validation.\",\n              \"type\": \"boolean\"\n            },\n            \"source\": {\n              \"description\": \"Source path, relative to the root checkout unless absolute.\",\n              \"type\": \"string\"\n            },\n            \"target\": {\n              \"description\": \"Target path, relative to the current worktree unless absolute.\",\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"operation\",\n            \"source\"\n          ],\n          \"type\": \"object\"\n        },\n        {\n          \"additionalProperties\": false,\n          \"description\": \"Sync object entry for mixed `files` and `[[file]]` declarations.\",\n          \"not\": {\n            \"properties\": {\n              \"delete\": {\n                \"const\": true\n              },\n              \"include\": {\n                \"minItems\": 1\n              }\n            },\n            \"required\": [\n              \"delete\",\n              \"include\"\n            ]\n          },\n          \"properties\": {\n            \"compare\": {\n              \"$ref\": \"#/$defs/SyncCompare\",\n              \"description\": \"File comparison mode.\"\n            },\n            \"delete\": {\n              \"description\": \"Whether target-only files are deleted for directory sync.\",\n              \"type\": \"boolean\"\n            },\n            \"ignore\": {\n              \"description\": \"Source-relative path patterns that sync should skip.\",\n              \"items\": {\n                \"type\": \"string\"\n              },\n              \"type\": \"array\"\n            },\n            \"ignore_metadata\": {\n              \"description\": \"Metadata fields that sync should not compare or apply.\",\n              \"items\": {\n                \"$ref\": \"#/$defs/MetadataField\"\n              },\n              \"type\": \"array\"\n            },\n            \"include\": {\n              \"description\": \"Source-relative path patterns that narrow directory sync to\\nmatching source paths. A non-empty list cannot combine with\\n`delete = true`.\",\n              \"items\": {\n                \"type\": \"string\"\n              },\n              \"type\": \"array\"\n            },\n            \"operation\": {\n              \"const\": \"sync\",\n              \"type\": \"string\"\n            },\n            \"required\": {\n              \"description\": \"Whether a missing source should fail validation.\",\n              \"type\": \"boolean\"\n            },\n            \"source\": {\n              \"description\": \"Source path, relative to the root checkout unless absolute.\",\n              \"type\": \"string\"\n            },\n            \"symlinks\": {\n              \"$ref\": \"#/$defs/SymlinkMode\",\n              \"description\": \"How safe source symlinks are handled.\"\n            },\n            \"target\": {\n              \"description\": \"Target path, relative to the current worktree unless absolute.\",\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"operation\",\n            \"source\"\n          ],\n          \"type\": \"object\"\n        }\n      ]\n    },\n    \"ShellCommandObject\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"allow_failure\": {\n          \"description\": \"Whether a non-zero exit status should be non-fatal.\",\n          \"type\": \"boolean\"\n        },\n        \"cwd\": {\n          \"description\": \"Command working directory, relative to the worktree unless absolute.\",\n          \"type\": \"string\"\n        },\n        \"env\": {\n          \"additionalProperties\": {\n            \"type\": \"string\"\n          },\n          \"description\": \"Extra environment variables for this command.\",\n          \"type\": \"object\"\n        },\n        \"name\": {\n          \"description\": \"Optional display name.\",\n          \"type\": \"string\"\n        },\n        \"run\": {\n          \"description\": \"Shell command to execute.\",\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"run\"\n      ],\n      \"type\": \"object\"\n    },\n    \"SymlinkEntry\": {\n      \"anyOf\": [\n        {\n          \"description\": \"Source and target use the same relative path.\",\n          \"type\": \"string\"\n        },\n        {\n          \"$ref\": \"#/$defs/SymlinkObject\",\n          \"description\": \"Symlink object entry.\"\n        }\n      ]\n    },\n    \"SymlinkMode\": {\n      \"enum\": [\n        \"preserve\"\n      ],\n      \"type\": \"string\"\n    },\n    \"SymlinkObject\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"required\": {\n          \"description\": \"Whether a missing source should fail validation.\",\n          \"type\": \"boolean\"\n        },\n        \"source\": {\n          \"description\": \"Source path, relative to the root checkout unless absolute.\",\n          \"type\": \"string\"\n        },\n        \"target\": {\n          \"description\": \"Target path, relative to the current worktree unless absolute.\",\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"source\"\n      ],\n      \"type\": \"object\"\n    },\n    \"SyncCompare\": {\n      \"enum\": [\n        \"metadata\",\n        \"checksum\"\n      ],\n      \"type\": \"string\"\n    },\n    \"SyncEntry\": {\n      \"anyOf\": [\n        {\n          \"description\": \"Source and target use the same relative path.\",\n          \"type\": \"string\"\n        },\n        {\n          \"$ref\": \"#/$defs/SyncObject\",\n          \"description\": \"Sync object entry.\"\n        }\n      ]\n    },\n    \"SyncObject\": {\n      \"additionalProperties\": false,\n      \"not\": {\n        \"properties\": {\n          \"delete\": {\n            \"const\": true\n          },\n          \"include\": {\n            \"minItems\": 1\n          }\n        },\n        \"required\": [\n          \"delete\",\n          \"include\"\n        ]\n      },\n      \"properties\": {\n        \"compare\": {\n          \"$ref\": \"#/$defs/SyncCompare\",\n          \"description\": \"File comparison mode.\"\n        },\n        \"delete\": {\n          \"description\": \"Whether target-only files are deleted for directory sync.\",\n          \"type\": \"boolean\"\n        },\n        \"ignore\": {\n          \"description\": \"Source-relative path patterns that sync should skip.\",\n          \"items\": {\n            \"type\": \"string\"\n          },\n          \"type\": \"array\"\n        },\n        \"ignore_metadata\": {\n          \"description\": \"Metadata fields that sync should not compare or apply.\",\n          \"items\": {\n            \"$ref\": \"#/$defs/MetadataField\"\n          },\n          \"type\": \"array\"\n        },\n        \"include\": {\n          \"description\": \"Source-relative path patterns that narrow directory sync to matching\\nsource paths. A non-empty list cannot combine with `delete = true`.\",\n          \"items\": {\n            \"type\": \"string\"\n          },\n          \"type\": \"array\"\n        },\n        \"required\": {\n          \"description\": \"Whether a missing source should fail validation.\",\n          \"type\": \"boolean\"\n        },\n        \"source\": {\n          \"description\": \"Source path, relative to the root checkout unless absolute.\",\n          \"type\": \"string\"\n        },\n        \"symlinks\": {\n          \"$ref\": \"#/$defs/SymlinkMode\",\n          \"description\": \"How safe source symlinks are handled.\"\n        },\n        \"target\": {\n          \"description\": \"Target path, relative to the current worktree unless absolute.\",\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"source\"\n      ],\n      \"type\": \"object\"\n    },\n    \"WorktreeIdConfig\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"length\": {\n          \"description\": \"Number of lowercase Crockford base32 digest characters.\",\n          \"format\": \"uint\",\n          \"maximum\": 52,\n          \"minimum\": 1,\n          \"type\": \"integer\"\n        }\n      },\n      \"type\": \"object\"\n    },\n    \"WorktreeSlugConfig\": {\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"max_length\": {\n          \"description\": \"Maximum length of the complete slug.\",\n          \"format\": \"uint\",\n          \"minimum\": 3,\n          \"type\": \"integer\"\n        },\n        \"separator\": {\n          \"$ref\": \"#/$defs/WorktreeSlugSeparator\",\n          \"description\": \"Separator used inside the readable name and before the ID.\"\n        }\n      },\n      \"type\": \"object\"\n    },\n    \"WorktreeSlugSeparator\": {\n      \"enum\": [\n        \"-\",\n        \"_\"\n      ],\n      \"type\": \"string\"\n    }\n  },\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"additionalProperties\": false,\n  \"properties\": {\n    \"command\": {\n      \"description\": \"Verbose command entries. TOML uses this as [[command]].\",\n      \"items\": {\n        \"$ref\": \"#/$defs/CommandObject\"\n      },\n      \"type\": \"array\"\n    },\n    \"commands\": {\n      \"description\": \"Command entries. Entries run before verbose [[command]] entries.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/CommandEntry\"\n      },\n      \"type\": \"array\"\n    },\n    \"copy\": {\n      \"description\": \"Copy file entries. Entries run before symlink, sync, files, and file.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/CopyEntry\"\n      },\n      \"type\": \"array\"\n    },\n    \"dangerously_allow_sources_outside_root\": {\n      \"description\": \"Allows file operation sources outside the root checkout.\",\n      \"type\": \"boolean\"\n    },\n    \"dangerously_allow_targets_outside_worktree\": {\n      \"description\": \"Allows file operation targets outside the current worktree.\",\n      \"type\": \"boolean\"\n    },\n    \"default_ignore\": {\n      \"description\": \"Default path ignore patterns prepended to copy and sync operations.\",\n      \"items\": {\n        \"type\": \"string\"\n      },\n      \"type\": \"array\"\n    },\n    \"file\": {\n      \"description\": \"Verbose mixed file operation entries. TOML uses this as [[file]].\",\n      \"items\": {\n        \"$ref\": \"#/$defs/MixedFileObject\"\n      },\n      \"type\": \"array\"\n    },\n    \"files\": {\n      \"description\": \"Mixed file operation entries. Entries run after copy, symlink, and sync.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/MixedFileObject\"\n      },\n      \"type\": \"array\"\n    },\n    \"strict\": {\n      \"description\": \"Enables strict declarative validation and conflict handling.\",\n      \"type\": \"boolean\"\n    },\n    \"symlink\": {\n      \"description\": \"Symlink file entries. Entries run after copy and before sync.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/SymlinkEntry\"\n      },\n      \"type\": \"array\"\n    },\n    \"sync\": {\n      \"description\": \"Sync file entries. Entries run after symlink and before files.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/SyncEntry\"\n      },\n      \"type\": \"array\"\n    },\n    \"teardown_command\": {\n      \"description\": \"Verbose teardown entries. TOML uses this as [[teardown_command]].\",\n      \"items\": {\n        \"$ref\": \"#/$defs/CommandObject\"\n      },\n      \"type\": \"array\"\n    },\n    \"teardown_commands\": {\n      \"description\": \"Teardown command entries. Entries run before verbose\\n[[teardown_command]] entries.\",\n      \"items\": {\n        \"$ref\": \"#/$defs/CommandEntry\"\n      },\n      \"type\": \"array\"\n    },\n    \"worktree_id\": {\n      \"$ref\": \"#/$defs/WorktreeIdConfig\",\n      \"description\": \"Stable compact worktree ID settings.\"\n    },\n    \"worktree_slug\": {\n      \"$ref\": \"#/$defs/WorktreeSlugConfig\",\n      \"description\": \"Readable worktree slug presentation settings.\"\n    }\n  },\n  \"title\": \"TreebootConfig\",\n  \"type\": \"object\"\n}\n";
Expand description

Canonical Treeboot configuration JSON Schema document.