/go-vcl

🐇 VCL parser written in Go

Primary LanguageGoApache License 2.0Apache-2.0

VCL

      ::::::::   ::::::::    :::     :::  ::::::::  :::  
    :+:    :+: :+:    :+:   :+:     :+: :+:    :+: :+:   
   +:+        +:+    +:+   +:+     +:+ +:+        +:+    
  :#:        +#+    +:+   +#+     +:+ +#+        +#+     
 +#+   +#+# +#+    +#+    +#+   +#+  +#+        +#+      
#+#    #+# #+#    #+#     #+#+#+#   #+#    #+# #+#       
########   ########        ###      ########  ########## 

VCL parser written in Go

GitHub Actions GoDoc

codecov Go Report Card GolangCI

License Dependabot

DeepSource

Usage

Decode

Let's say you have a VCL file.

acl purge_ip {
    "localhost";
    "127.0.0.1";
}

Define a go struct how you what to retrieve the VCL expressions and attributes.

type Root struct {
    ACLs []*ACL `vcl:"acl,block"`
}

type ACL struct {
    Type      string   `vcl:"type,label`
    Endpoints []string `vcl:",flat"`
}  

Then decode your like following.

var r Root
err := vcl.Decode(b, &r)
fmt.Println(r.ACLs[0].Type)
fmt.Println(r.ACLs[0].Endpoints)
$ go run main.go
=> "purge_ip"
=> []string{"localhost","127.0.0.1"}

Supported tags

I am not a VCL master so there may be not supported features.

There are struct tags you can use for you input.

  • block: Represents a unit of your block like acl, sub, etc...
  • label: The label of your block.
  • flat: Represents a expression field
  • comment: Get comments
  • attr: (Default) Attribute of your block

Releases

Release tag will be based on Semantic Versioning 2.0.0.
See the CHANGELOGS.md

How to Contribute

I am always welcome for any contributions.

  • Raise a Issue.
  • Create a PR.

Simple:)

License

go-vcl is released under the MIT license.
© 2019 KeisukeYamashita.

Author