all files / node-docref/lib/ docref.js

100% Statements 91/91
94% Branches 47/50
100% Functions 18/18
100% Lines 84/84
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229                                                                  55×                                       36× 35× 35× 35×                   30× 29× 29×                                                   18×           18× 18×   18× 18×                                                   10× 10× 10× 10× 10×   10× 10×                                                      
'use strict'
 
const path = require('path')
const cheerio = require('cheerio')
 
const mimes = require('./_mimes.json')
 
const REGEX_CSS_URL = /url\s*\(\s*(['"]?)([^"'\)]*)\1\s*\)/gi
 
// do NOT contains <a> which means non-resource
const HTML_REF_RULES = [
  { tag: 'link[rel="stylesheet"]', attr: 'href' },
  { tag: 'link[rel="shortcut icon"]', attr: 'href' },
  { tag: 'img', attr: 'src' },
  { tag: 'script', attr: 'src' },
  { tag: 'iframe', attr: 'src' }
]
 
module.exports = {
  isAbsolute,
  infectRefs,
  getFileMIME,
  getSameBaseUri,
 
  getCSSRefs,
  setCSSRefs,
  getHTMLRefs,
  setHTMLRefs,
 
  getHTMLLinks,
  setHTMLLinks
}
 
/**
 * test if url is absolute
 *
 * @param  {String} url
 * @return {Boolean}
 */
function isAbsolute(url) {
  return !url || /^(([a-z0-9]+:)|(\/\/)|#)/i.test(url)
}
 
/**
 * infect file refs
 *
 * @param  {Object} maps - { file: refs }
 * @return {Object} maps - { file: refs }
 */
function infectRefs(maps) {
  var files = Object.keys(maps)
  files.forEach(function (file) {
    var refs = maps[file]
    refs.forEach(function (ref) {
      if (maps.hasOwnProperty(ref)) {
        maps[file] = maps[file].concat(maps[ref])
      }
    })
  })
  return maps
}
 
/**
 * get MIME by file name
 *
 * @param  {String} file - file name
 * @return {String} MIME
 */
function getFileMIME(file) {
  if (!file) return 'text/plain'
  var ext = path.extname(file)
  if (ext) ext = ext.toLowerCase().substring(1)
  return mimes[ext] || mimes.txt
}
 
/**
 * resolve uri as file
 *
 * @param  {String} file - not dir
 * @param  {String} uri - relative uri
 * @return {String} uri - resolved uri
 */
function getSameBaseUri(file, uri) {
  if (!uri) return ''
  var base = path.dirname(file)
  return uri.startsWith('/') ? uri : path.join(base, uri)
}
 
/**
 * get CSS refs
 *
 * @param  {String} text
 * @param  {String} file
 * @return {String[]} urls
 */
function getCSSRefs(text, file) {
  var matches = text.match(REGEX_CSS_URL) || []
  return matches.map(match => {
    var url = match
      // remove spaces & url(''|"") to get url
      .replace(/\s*/g, '').slice(4, -1).replace(/"|'/g, '')
      // replace \ to /
      .replace(/\\/g, '/')
    if (file && !isAbsolute(url)) {
      url = getSameBaseUri(file, url)
    }
    return url
  }).filter(Boolean)
}
 
/**
 * set CSS refs
 *
 * @param  {String} text
 * @param  {String} file
 * @param  {Function} edit - fn(url, mime, abs)
 * @return {String} fixed content
 */
function setCSSRefs(text, file, edit) {
  return text.replace(REGEX_CSS_URL, match => {
    var url = match
      // remove spaces & url(''|"") to get url
      .replace(/\s*/g, '').slice(4, -1).replace(/"|'/g, '')
      // replace \ to /
      .replace(/\\/g, '/')
 
    var absolute = isAbsolute(url)
    if (file && !absolute) {
      url = getSameBaseUri(file, url)
    }
    url = edit(url, getFileMIME(url), absolute)
    return url ? `url(${url})` : match
  })
}
 
/**
 * get HTML refs
 *
 * @param  {String} text
 * @param  {String} file
 * @return {String[]} url[]
 */
function getHTMLRefs(text, file) {
  var refs = []
  var $ = cheerio.load(text)
  // never use arrow function here
  HTML_REF_RULES.forEach(function (rule) {
    $(rule.tag).each(function () {
      var elem = $(this)
      var url = elem.attr(rule.attr)
      if (file && !isAbsolute(url)) {
        url = getSameBaseUri(file, url)
      }
      Eif (url) refs.push(url)
    })
  })
  return refs
}
 
/**
 * set HTML refs
 *
 * @param  {String} text
 * @param  {String} file
 * @param  {Function} edit - fn(url, mime, abs)
 * @return {String} fixed content
 */
function setHTMLRefs(text, file, edit) {
  var $ = cheerio.load(text)
  // never use arrow function here
  HTML_REF_RULES.forEach(function (rule) {
    $(rule.tag).each(function () {
      var elem = $(this)
      var url = elem.attr(rule.attr)
      var absolute = isAbsolute(url)
      if (file && !absolute) {
        url = getSameBaseUri(file, url)
      }
      url = edit(url, getFileMIME(url), absolute)
      if (url) elem.attr(rule.attr, url)
    })
  })
  return $.html()
}
 
/**
 * get HTML links
 *
 * @param  {String} text
 * @param  {String} file
 * @return {String[]} url[]
 */
function getHTMLLinks(text, file) {
  var refs = []
  var $ = cheerio.load(text)
  $('a').each(function () {
    var elem = $(this)
    var url = elem.attr('href')
    if (file && !isAbsolute(url)) {
      url = getSameBaseUri(file, url)
    }
    Eif (url) refs.push(url)
  })
  return refs
}
 
/**
 * set HTML links
 *
 * @param  {String} text
 * @param  {String} file
 * @param  {Function} edit - fn(url, mime, abs)
 * @return {String} fixed content
 */
function setHTMLLinks(text, file, edit) {
  var $ = cheerio.load(text)
  $('a').each(function () {
    var elem = $(this)
    var url = elem.attr('href')
    var absolute = isAbsolute(url)
    if (file && !absolute) {
      url = getSameBaseUri(file, url)
    }
    url = edit(url, getFileMIME(url), absolute)
    if (url) elem.attr('href', url)
  })
  return $.html()
}