@antora/ 扩展路径帮助器
一个节点(Node.js)模块,提供辅助功能来扩展一条通向正态绝对路径的路径.
此函数在用作第一个路径段时也会扩展以下短手表达式: dot (.),平面(平面~),或平面加(~+) (中文(简体) ).
扩展路径是系统依赖的.
开发用于安多拉.
安装
$ npm i @antora/expand-path-helper
API 密码
function expandPath (path[, context])
将指定的路径扩展为正态的绝对路径. 这一职能的主要目的是扩大路径和正常化.
path< string> - 要扩展的路径 . 需要这个参数 . 如果路径已经绝对,则路径会正常化并返回.context<Object> - 控制路径解析方法的命名参数. 所有被命名的参数都是可选的. 此参数也可以被指定为字符串,在这种情况下,它被用作基准上下文参数. 默认 :{}。 。 。 .base< string> - 用来解决相对路径而不是工作目录的基础目录. 默认 :~+cwd< string> - 要用作工作目录而不是当前工作目录的绝对目录. 如果没有指定,则使用当前工作目录. 默认 :undefineddot< string > - 用于替换一主要点的值(.) 部分. 如果值是.,该数值base则使用上下文参数. 默认 :.
如果路径参数的第一部分,基上下文参数,或点上下文参数是 ~ 或者说 ~+,该值将分别扩展至用户主目录或当前工作目录.
如果路径参数的第一部分是 .,该值在点上下文参数被扩展后被点上下文参数所取代.
使用量
产出 expandPath 取决于其运行的系统(具体取决于 path.sep 数值).
*没有
const expandPath = require('@antora/expand-path-helper')
expandPath('/absolute/path')
//=> /absolute/path
expandPath('/absolute/./path/..')
//=> /absolute
expandPath('foo/bar')
//=> $PWD/foo/bar
expandPath('./foo/bar')
//=> $PWD/foo/bar
expandPath('~/foo/bar')
//=> $HOME/foo/bar
expandPath('~+/foo/bar')
//=> $PWD/foo/bar
expandPath('~+/foo/bar', { cwd: '/working/dir' })
//=> /working/dir/foo/bar
expandPath('foo/bar', '/base/dir')
//=> /base/dir/foo/bar
expandPath('foo/bar', { base: '/base/dir' })
//=> /base/dir/foo/bar
expandPath('./foo/bar', { base: '/base/dir' })
//=> /base/dir/foo/bar
expandPath('./foo/bar', { dot: '/dot/dir' })
//=> /dot/dir/foo/bar
窗口
const expandPath = require('@antora/expand-path-helper')
expandPath('C:\\absolute\\path')
//=> C:\absolute\path
expandPath('C:/absolute/path')
//=> C:\absolute\path
expandPath('C:\\absolute\\.\\path\\..')
//=> C:\absolute
expandPath('foo\\bar')
//=> C:\current\directory\foo\bar
expandPath('.\\foo\\bar')
//=> C:\current\directory\foo\bar
expandPath('~\\foo\\bar')
//=> C:\Users\user\foo\bar
expandPath('~+\\foo\\bar')
//=> C:\current\directory\foo\bar
expandPath('~+\\foo\\bar', { cwd: 'C:\\working\\dir' })
//=> C:\working\dir\foo\bar
expandPath('foo\\bar', 'C:\\base\\dir')
//=> C:\base\dir\foo\bar
expandPath('foo\\bar', { base: 'C:\\base\\dir' })
//=> C:\base\dir\foo\bar
expandPath('.\\foo\\bar', { base: 'C:\\base\\dir' })
//=> C:\base\dir\foo\bar
expandPath('.\\foo\\bar', { dot: 'C:\\dot\\dir' })
//=> C:\dot\dir\foo\bar
在Windows上,输入路径可能使用前向鞭打,但被扩展的路径总是有后向鞭打.
版权和许可证
版权(C)2018年-由OpenDevise Inc. 和Antora的个人贡献者提供.
该软件的使用按照下列规定进行: Mozilla 公共许可版本 2.0 (MPL-2.0) (中文(简体) ).