Giter Site home page Giter Site logo

go-vcl's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.