mrdocs::files
Filesystem helpers (join, temp, real‐path resolution) used throughout MrDocs.
Description
The files namespace centralizes cross‐platform path manipulation so CLI, generators, and tests can share the same normalization and staging logic.
Functions
Name |
Description |
|
|
Create a directory. |
|
Determine if a path exists |
|
Return the filename part of the path. |
|
Return the contents of a file as a string. |
|
Return the file type or an error |
|
Return the parent directory. |
|
Return the relevant suffix of a source file path. |
|
Return true if pathName is absolute. |
|
Determine if a path is a directory. |
|
Return true if pathName ends in a separator. |
|
Check if the path is posix style. |
|
Determine if a path is a regular file. |
|
Checks whether the given path lies within the specified prefix, tolerating symlinks. |
|
Checks whether the given path lies within the specified prefix. |
|
Determine whether a path looks like a directory. |
|
Determine whether a path looks like a file. |
|
Return an absolute path from a possibly relative path. |
|
Append a trailing native separator if not already present. |
|
Convert all backward slashes to forward slashes. |
|
Return the real, symlink‐resolved form of a path. |
|
Return a normalized directory. |
|
Return a normalized path. |
|
Return an error if pathName is not absolute. |
|
Return an error if the path is not a directory. |
|
Return the filename with a new or different extension. |
Created with MrDocs