Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.14 KB

File metadata and controls

43 lines (32 loc) · 1.14 KB

lib/portalUtils module

Use this module to retrieve various portal information.

.getPom(config, path)

returns JXON parsed presentation of pom.xml

  • config - common configuration object containing config, bbrest and jxon, see lib/config docs
  • path - by default pom.xml from the root of the project is returned. use this parameter to add string to the path
portalUtils.getPom
.then(function(jx) {
    // jx is pom.xml in jxon notation
});

.getStaticFiles(config, mask)

traverses target/static and returns all file paths or the masked ones only

  • config - common configuration object containing config, bbrest and jxon, see lib/config docs
  • mask - filename mask
portalUtils.getStaticFiles(config, 'readme.md')
.then(function(files) {
    // files will contain paths to all files
});

.getMasterTemplatePaths(config)

returns paths to .jsp templates used in master pages

  • config - common configuration object containing config, bbrest and jxon, see lib/config docs
portalUtils.getMasterTemplatePaths(config)
.then(function(templates) {
    // templates will contain paths to template files
});