format

Documentation

Overview

Package format provides functions to format shell scripts and file paths.

Index

• func Hash(included map[string]string) (string, error)
• func Map[T any](data map[string]T, format string) string
• func PosixPath(path string) string
• func Shell(src string, singleLine bool) (string, error)
• func WindowsPath(path string) string

Functions

func Hash

func Hash(included map[string]string) (string, error)

Hash deterministically combines each file's contents and its exported variables into a single SHA-256 digest.

func Map

func Map[T any](data map[string]T, format string) string

Map takes a map and a format string (like "export %s=%q") and returns a sorted, joined string.

func PosixPath

func PosixPath(path string) string

PosixPath converts a Windows path (like `C:/...`) to Posix format (`/c/...`). Converts regardless of platform if a drive letter is detected.

func Shell

func Shell(src string, singleLine bool) (string, error)

Shell formats a shell script source code.

func WindowsPath

func WindowsPath(path string) string

WindowsPath converts a Posix path (like `/c/...`) to Windows format (`C:/...`). Converts regardless of platform if a drive letter is detected.