Lua module to work with file paths.

Module for file path manipulations.

The character that separates directories.

The character that is used to separate the entries in the PATH environment variable.

Get the directory name; move up one level.

Parameters:

filepath
path (string)

Returns:

• The filepath up to the last directory separator. (string)

Get the file name.

Parameters:

filepath
path (string)

Returns:

• File name part of the input path. (string)

Checks whether a path is absolute, i.e. not fixed to a root.

Parameters:

filepath
path (string)

Returns:

• true iff filepath is an absolute path, false otherwise. (boolean)

Checks whether a path is relative or fixed to a root.

Parameters:

filepath
path (string)

Returns:

• true iff filepath is a relative path, false otherwise. (boolean)

Join path elements back together by the directory separator.

Parameters:

filepaths
path components (list of strings)

Returns:

• The joined path. (string)

Contract a filename, based on a relative path. Note that the resulting path will never introduce .. paths, as the presence of symlinks means ../b may not reach a/b if it starts from a/c. For a worked example see this blog post.

Parameters:

path
path to be made relative (string)

root
root path (string)

unsafe
whether to allow .. in the result. (boolean)

Returns:

• contracted filename (string)

Normalizes a path.

• // outside of the drive can be made blank
• / becomes the path.separator
• ./ -> ’’
• an empty path becomes .

Parameters:

filepath
path (string)

Returns:

• The normalized path. (string)

Splits a path by the directory separator.

Parameters:

filepath
path (string)

Returns:

• List of all path components. (list of strings)

Splits the last extension from a file path and returns the parts. The extension, if present, includes the leading separator; if the path has no extension, then the empty string is returned as the extension.

Parameters:

filepath
path (string)

Returns:

• filepath without extension (string)

• extension or empty string (string)

Takes a string and splits it on the search_path_separator character. Blank items are ignored on Windows, and converted to . on Posix. On Windows path elements are stripped of quotes.

Parameters:

search_path
platform-specific search path (string)

Returns:

• list of directories in search path (list of strings)