docgen

README

DocGen

This package provides documentation generator with JSON or Markdown output.

Usage

Create a file and put next code into it.

package main

import (
	"encoding/json"
	"fmt"
  
	"github.com/expr-lang/expr/docgen"
)

func main() {
	// TODO: Replace env with your own types.
	doc := docgen.CreateDoc(env)
  
	buf, err := json.MarshalIndent(doc, "", "  ")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(buf))
}

Run go run your_file.go. Documentation will be printed in JSON format.

Markdown

To generate markdown documentation:

package main

import "github.com/expr-lang/expr/docgen"

func main() {
	// TODO: Replace env with your own types.
	doc := docgen.CreateDoc(env)

	print(doc.Markdown())
}

Documentation

Index

• Variables
• type Context
  • func CreateDoc(i any) *Context
  • func (c *Context) Markdown() string
• type Identifier
• type Kind
• type Type
• type TypeName

Variables

var (
	Operators = []string{"matches", "contains", "startsWith", "endsWith"}
	Builtins  = map[Identifier]*Type{
		"true":  {Kind: "bool"},
		"false": {Kind: "bool"},
		"len": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}},
			Return: &Type{Kind: "int"},
		},
		"all": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "bool"},
		},
		"none": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "bool"},
		},
		"any": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "bool"},
		},
		"one": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "bool"},
		},
		"filter": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "array", Type: &Type{Kind: "any"}},
		},
		"map": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "array", Type: &Type{Kind: "any"}},
		},
		"count": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}, {Kind: "func"}},
			Return: &Type{Kind: "int"},
		},

		"trim": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "cutstr", Kind: "string"}},
			Return:    &Type{Name: "string", Kind: "string"},
		},
		"trimPrefix": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "cutstr", Kind: "string"}},
			Return:    &Type{Name: "string", Kind: "string"},
		},
		"trimSuffix": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "cutstr", Kind: "string"}},
			Return:    &Type{Name: "string", Kind: "string"},
		},

		"upper": {
			Kind: "func", Arguments: []*Type{{Name: "string", Kind: "string"}},
			Return: &Type{Name: "string", Kind: "string"},
		},
		"lower": {
			Kind: "func", Arguments: []*Type{{Name: "string", Kind: "string"}},
			Return: &Type{Name: "string", Kind: "string"},
		},
		"repeat": {
			Kind: "func", Arguments: []*Type{{Name: "n", Kind: "int"}},
			Return: &Type{Name: "string", Kind: "string"},
		},

		"join": {
			Kind: "func", Arguments: []*Type{
				{Kind: "array", Type: &Type{Kind: "any"}}, {Name: "glue", Kind: "string"},
			}, Return: &Type{Name: "string", Kind: "string"},
		},
		"indexOf": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "substr", Kind: "string"}},
			Return:    &Type{Name: "index", Kind: "int"},
		},
		"lastIndexOf": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "substr", Kind: "string"}},
			Return:    &Type{Name: "index", Kind: "int"},
		},

		"hasPrefix": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "prefix", Kind: "string"}},
			Return:    &Type{Kind: "bool"},
		},
		"hasSuffix": {
			Kind:      "func",
			Arguments: []*Type{{Name: "string", Kind: "string"}, {Name: "prefix", Kind: "string"}},
			Return:    &Type{Kind: "bool"},
		},

		"toJSON":   {Kind: "func", Arguments: []*Type{{Kind: "any"}}, Return: &Type{Kind: "string"}},
		"fromJSON": {Kind: "func", Arguments: []*Type{{Kind: "string"}}, Return: &Type{Kind: "any"}},

		"toBase64":   {Kind: "func", Arguments: []*Type{{Kind: "string"}}, Return: &Type{Kind: "string"}},
		"fromBase64": {Kind: "func", Arguments: []*Type{{Kind: "string"}}, Return: &Type{Kind: "string"}},

		"first": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}},
			Return: &Type{Kind: "any"},
		},
		"last": {
			Kind: "func", Arguments: []*Type{{Kind: "array", Type: &Type{Kind: "any"}}},
			Return: &Type{Kind: "any"},
		},

		"now":      {Kind: "func", Return: &Type{Name: "time.Time", Kind: "struct"}},
		"duration": {Kind: "func", Arguments: []*Type{{Kind: "string"}}, Return: &Type{Kind: "time.Duration"}},
	}
)

Types

type Context

type Context struct {
	Variables map[Identifier]*Type `json:"variables"`
	Types     map[TypeName]*Type   `json:"types"`
	PkgPath   string
}

func CreateDoc

func CreateDoc(i any) *Context

func (*Context) Markdown

func (c *Context) Markdown() string

type Identifier

type Identifier string

Identifier represents variable names and field names.

type Kind

type Kind string

Kind can be any of array, map, struct, func, string, int, float, bool or any.

type Type

type Type struct {
	Name      TypeName             `json:"name,omitempty"`
	Kind      Kind                 `json:"kind,omitempty"`
	Type      *Type                `json:"type,omitempty"`
	Key       *Type                `json:"key_type,omitempty"`
	Fields    map[Identifier]*Type `json:"fields,omitempty"`
	Arguments []*Type              `json:"arguments,omitempty"`
	Return    *Type                `json:"return,omitempty"`
}

type TypeName

type TypeName string

TypeName is a name of type in types map.