当前位置: 首页 > 文档资料 > FIS3 中文文档 >

project

优质
小牛编辑
136浏览
2023-12-01

fis. project

fis 项目相关

Source:

Members

(static) getSourceByPatterns

返回项目目录下符合检索规则的文件。以 project.files 为匹配规则,project.ignore 为排除规则进行检索

Source:

(static) currentMedia() → {String}

返回当前用户所在的 media 名称。

Source:
Returns:

当前用户所在分支

Type
String

(static) getCachePath() → {String}

获取对应缓存的文件路径,缓存存放在 TEMP_ROOT/cache 下

Source:
Returns:

对应缓存的路径

Type
String

(static) getProjectPath(subpathopt) → {String}

获取项目所在目录。
注意:返回的文件路径,已经被 normalize 了。

Parameters:
NameTypeAttributesDescription
subpathString<optional>

如果指定了子目录,将返回子目录路径。

Source:
Returns:
Type
String

(static) getSource()

获取项目目录中,需要编译的文件集合,返回格式为对象,key 为文件基于项目目录的绝对路径, value 为文件对象。

当前 media 环境下面设置有 project.files 列表时,走 fis.project.getSourceByPatterns, 否则兼容 fis 2 中
的用法,基于 project.includefis.excludefis.util.find 查找。

Source:

(static) getTempPath() → {String}

获取临时文件夹路径

Source:
Returns:
Type
String

(static) getTempRoot()

获取临时文件夹根目录,若未手动设置,则遍历用户环境变量中['FIS_TEMP_DIR', 'LOCALAPPDATA', 'APPDATA', 'HOME']这几项是否有设置,有则作为临时目录path,没有则以fis3/.fis-tmp作为临时文件夹

Source:

(static) lookup(path, file) → {Object}

根据路径查找路径,支持相对路径和基于项目文件夹的绝对路径。

Parameters:
NameTypeDescription
pathstring

文件路径。

fileFile

文件对象,当路径为相对路径时,此文件对象所在目录将用于查找目标文件。

Source:
Returns:

返回查找结果对象。

Type
Object

(static) setProjectRoot(path)

设置项目根目录

Parameters:
NameTypeDescription
pathString

项目根目录

Source:

(static) setTempRoot(tmp)

设置并创建临时文件夹

Parameters:
NameTypeDescription
tmpString

临时文件夹路径

Source: