https://github.com/abiosoft/caddy-json-schema
JSON schema generator for Caddy v2
https://github.com/abiosoft/caddy-json-schema
caddy caddy-module caddy-plugin caddyserver intellisense json json-schema
Last synced: 3 months ago
JSON representation
JSON schema generator for Caddy v2
- Host: GitHub
- URL: https://github.com/abiosoft/caddy-json-schema
- Owner: abiosoft
- License: apache-2.0
- Created: 2020-05-22T10:17:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T03:19:27.000Z (almost 3 years ago)
- Last Synced: 2025-03-16T07:41:34.438Z (3 months ago)
- Topics: caddy, caddy-module, caddy-plugin, caddyserver, intellisense, json, json-schema
- Language: Go
- Homepage:
- Size: 5.01 MB
- Stars: 140
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# caddy-json-schema
JSON schema generator for Caddy v2.
The generated schema can be integrated with editors for intellisense and better experience with configuration and plugin development.
## Installation
The generated schema is for the caddy binary. i.e. all modules in the binary will
be include in the schema.
```sh
xcaddy build v2.4.1 \
--with github.com/abiosoft/caddy-json-schema \
# any other module you want to include in the generated schema
```
## Usage
Run `caddy help json-schema` to view help.
```
usage:
caddy json-schema [--output ] [--indent ] [--vscode] [--no-cache]
flags:
-indent int
Number of spaces to indent the generated JSON with (default 2)
-no-cache
Discard local cache and fetch latest API docs
-output string
The file to write the generated schema (default "./caddy_schema.json")
-vscode
Generate VSCode configuration
```
## Editors
### Visual Studio Code
`caddy json-schema --vscode` generates Visual Studio Code configuration in the current directory.
Open the directory in Visual Studio Code and it should just work.
Ensure the config filename is of the format `*caddy*.[json|yaml]`.
**Note** that you need [vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) plugin to get similar experience for YAML files.
### Vim/NeoVim
There are multiple Vim/NeoVim plugins with language server and JSON schema support.
Below is a config for [coc-json](https://github.com/neoclide/coc-json) and [coc-yaml](https://github.com/neoclide/coc-yaml). The path to schema file is relative to the config file being edited.
```json
{
"json.schemas": [
{
"fileMatch": ["*caddy*.json"],
"url": "./caddy_schema.json"
}
],
"yaml.schemas": {
".vscode/caddy_schema.json": ["*caddy*.yaml", "*caddy*.yml"]
}
}
```
## Features
| Modules | Intellisense | Documentation |
| ----------- | ------------ | ------------------------------------------------------ |
| Standard | Supported | Supported |
| Third Party | Supported | Supported (if plugin is registered on caddyserver.com) |
## License
Apache 2