shellescape

README

shellescape

Usage

local shellescape = require("shellescape")

escaped = shellescape.quote("foo bar baz")
-- 'foo bar baz'

escaped_command = shellescape.quote_command({ "echo", "foo bar baz" })
-- echo 'foo bar baz'

Documentation

Index

• func Loader(L *lua.LState) int
• func Preload(L *lua.LState)
• func Quote(L *lua.LState) int
• func QuoteCommand(L *lua.LState) int
• func StripUnsafe(L *lua.LState) int

Examples

• Quote
• QuoteCommand
• StripUnsafe

Functions

func Loader

func Loader(L *lua.LState) int

Loader is the module loader function.

func Preload

func Preload(L *lua.LState)

Preload adds json to the given Lua state's package.preload table. After it has been preloaded, it can be loaded using require:

local json = require("json")

func Quote

func Quote(L *lua.LState) int

Example

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.quote("foo"))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:

foo

func QuoteCommand

func QuoteCommand(L *lua.LState) int

Example

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.quote_command({"echo", "foo bar baz"}))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:

echo 'foo bar baz'

func StripUnsafe

func StripUnsafe(L *lua.LState) int

Example

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.strip_unsafe("foo\nbar"))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:

foobar