isobit/vim-caddyfile

Caddyfile syntax support for Vim

vim-caddyfile

Vim support for Caddy's Caddyfile.

Includes syntax, indentation, and comment support, without depending on a static list of directives.

Installation

VimPlug

Put Plug 'isobit/vim-caddyfile' in your vimrc and do :PlugInstall.

Vundle

Put Bundle 'isobit/vim-caddyfile' in your vimrc and do :BundleInstall.

Preview

vim-caddyfile's Issues

[Question] File extension?

Is there a "common" or "accepted" or "best practice" file extension for Caddyfiles?

I'm not being dogmatic; I just don't see a way to trigger the syntax support except by invoking it manually every time. Am I misreading the code? Do I just need to use ".caddy" or something obvious like that?

@mholt , can you comment?

Thanks in advance.

I have installed using vundle, but I still don't see caddyfiles syntax

I added both in .vimrc, and relevant .vimrc changes:

set nocompatible              " be iMproved, required
filetype off                  " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/Vundle.vim
call vundle#begin()
" alternatively, pass a path where Vundle should install plugins
"call vundle#begin('~/some/path/here')

" let Vundle manage Vundle, required
Plugin 'VundleVim/Vundle.vim'
Bundle 'isobit/vim-caddyfile'

But still don't get any syntax when I do "vim Caddyfile"

Error on loading a second Caddyfile

If I load more than one Caddyfile without quitting vim first, I get the following error:

Error detected while processing [...]/indent/caddyfile.vim:
  1 line   17:
38  E122: Function <SNR>99_sw already exists, add ! to replace it

I'm not much good at vimscript. Should the definition perhaps use func!?

Consider defining each directive

While it's nice that you don't have to update the Caddyfile each time a new directive pops up, it makes anything you type at the beginning of the line look like a valid directive, which doesn't make syntax highlighting very helpful.

You could automate it using the output of

curl -s https://caddyserver.com/api/download-page | jq -r '.plugins[] | .Name' | sed 's/\./\n/g' | sort -u

which looks like

awslambda
cgi
cloudflare
cors
digitalocean
dns
dnsimple
dnspod
dyn
exoscale
expires
filemanager
filter
gandi
git
googlecloud
hook
http
hugo
ipfilter
jwt
linode
mailout
minify
namecheap
net
ovh
prometheus
proxyprotocol
rackspace
ratelimit
realip
rfc2136
route53
service
tls
upload
vultr

These are some more things than the directives alone, but it's a starting point.