keisukeyamashita / go-vcl

🐇 VCL parser written in Go

VCL

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

VCL parser written in Go

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

• KeisukeYamashita

go-vcl's Issues

Improve documents

What

• Improve documents

Why

• Mainly for godoc

Refactor decoder

What

• Refactor decode script

Why

• Write better code

Update Go version

What

Update to 1.17

Why

Use latest go.

Configure dependabot

What

Introduce Dependabot

Why

To managed the dependencies.

go.mod/go.sum should be on the module root

What

Same as the title.

Why

According to Using Go Modules, it says

The go.mod file defines the module’s module path, which is also the import path used for the root directory, and its dependency requirements, which are the other modules needed for a successful build.

So, the directory that go.mod has also should have Go files to succeeded in build.

Add map[string]interface{} decoder

What

• Decode as `map[string]interface{}

Why

• Flexibability

Support the director and table

What

Same as a title

Why

director and table are not defined as follows:
https://github.com/KeisukeYamashita/go-vcl/blob/master/internal/token/token.go#L59-L70

Would you please consider supporting the director and table?

Thanks

refs

• https://docs.fastly.com/vcl/directors/
• https://docs.fastly.com/vcl/table/

Improve test coverage

What

• May be great if it is upper than 80% all the time.

Why

• Maintainability

Add comment getter

What

• In VCL, we can write comments. Is will be great if there are comment fields.

Why

• We should support what VCL can write.
• Not to drop information from the VCL file.