yq/usage/lua.md

Basic input example

Given a sample.lua file of:

return {
	["country"] = "Australia"; -- this place
	["cities"] = {
		"Sydney",
		"Melbourne",
		"Brisbane",
		"Perth",
	};
};

then

yq -oy '.' sample.lua

will output

country: Australia
cities:
  - Sydney
  - Melbourne
  - Brisbane
  - Perth

Basic output example

Given a sample.yml file of:

---
country: Australia # this place
cities:
- Sydney
- Melbourne
- Brisbane
- Perth

then

yq -o=lua '.' sample.yml

will output

return {
	["country"] = "Australia"; -- this place
	["cities"] = {
		"Sydney",
		"Melbourne",
		"Brisbane",
		"Perth",
	};
};

Unquoted keys

Uses the --lua-unquoted option to produce a nicer-looking output.

Given a sample.yml file of:

---
country: Australia # this place
cities:
- Sydney
- Melbourne
- Brisbane
- Perth

then

yq -o=lua --lua-unquoted '.' sample.yml

will output

return {
	country = "Australia"; -- this place
	cities = {
		"Sydney",
		"Melbourne",
		"Brisbane",
		"Perth",
	};
};

Globals

Uses the --lua-globals option to export the values into the global scope.

Given a sample.yml file of:

---
country: Australia # this place
cities:
- Sydney
- Melbourne
- Brisbane
- Perth

then

yq -o=lua --lua-globals '.' sample.yml

will output

country = "Australia"; -- this place
cities = {
	"Sydney",
	"Melbourne",
	"Brisbane",
	"Perth",
};

Elaborate example

Given a sample.yml file of:

---
hello: world
tables:
  like: this
  keys: values
  ? look: non-string keys
  : True
numbers:
  - decimal: 12345
  - hex: 0x7fabc123
  - octal: 0o30
  - float: 123.45
  - infinity: .inf
    plus_infinity: +.inf
    minus_infinity: -.inf
  - not: .nan

then

yq -o=lua '.' sample.yml

will output

return {
	["hello"] = "world";
	["tables"] = {
		["like"] = "this";
		["keys"] = "values";
		[{
			["look"] = "non-string keys";
		}] = true;
	};
	["numbers"] = {
		{
			["decimal"] = 12345;
		},
		{
			["hex"] = 0x7fabc123;
		},
		{
			["octal"] = 24;
		},
		{
			["float"] = 123.45;
		},
		{
			["infinity"] = (1/0);
			["plus_infinity"] = (1/0);
			["minus_infinity"] = (-1/0);
		},
		{
			["not"] = (0/0);
		},
	};
};