ksyaml

README

KS-YAML (Kambing-Style YAML)

A better way to write human-readable, developer-friendly YAML

View Specification

About The Project

YAML is a data serialization language that often used for writing configuration files. It is designed in a way that makes it easy for developers to quickly write configuration files using a syntax that might be familiar to developers well-versed in indentation based languages such as Python.

However, this reliance on indentation oftentimes lead to problems due to parsing errors caused by inconsistent usage of tabs and spaces. We argue that it also causes readability problems when defining configurations that requires multiple levels of nested indentations, hence more often than not causing headaches for developers.

The KS-YAML formatting rules aims to solve this problem by leveraging the fact that YAML is designed as a superset of the JSON standard to create a more sensible way of writing YAML files.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Documentation

Index

• func Convert(in string) (string, error)
• type Converter
  • func NewConverter(opts ...ConverterOption) *Converter
  • func (c *Converter) Convert(in string) (string, error)
• type ConverterOption
  • func WithIndentation(indentation int) ConverterOption

Functions

func Convert

func Convert(in string) (string, error)

Types

type Converter

type Converter struct {
	// contains filtered or unexported fields
}

func NewConverter

func NewConverter(opts ...ConverterOption) *Converter

func (*Converter) Convert

func (c *Converter) Convert(in string) (string, error)

type ConverterOption

type ConverterOption func(*Converter)

func WithIndentation

func WithIndentation(indentation int) ConverterOption