Giter Club home page Giter Club logo

yaml-encoder's Introduction

yaml-encoder

This is a yaml encoder which implements yaml.Marshaler for marshal with comments.

Inspired by The doc's encoder of talos

example

package main

import (
	"fmt"
	encoder "github.com/wetor/yaml-encoder"
)

type DBConfig struct {
	Username string `yaml:"username" comment:"this is the username of database"`
	Password string `yaml:"password" comment:"this is the password of database"`
	Host string `yaml:"host"`
	Port int `yaml:"port" comment_key:"PORT"`
}

func main(){
	config := DBConfig{
		Username: "root",
		Password: "xxxxxx",
		Host: "127.0.0.1",
		Port: 4444,
	}

	encoder := encoder.NewEncoder(config,
		encoder.WithComments(encoder.CommentsOnHead),
		encoder.WithCommentsMap(map[string]string{
			"host": "主机名",
			"PORT": "端口号",
		}),
	)
	content, _ := encoder.Encode()
	fmt.Printf("%s", content)
}

output:

# this is the username of database
username: root
# this is the password of database
password: xxxxxx
# 主机名
host: 127.0.0.1
# 端口号
port: 4444
want:
# this is the username of database
username: root
# this is the password of database
password: xxxxxx

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.