filelink/lib/filelink.js

Create file links.

/**
 * @file Link files.
 * @function filelink
 * @param {string} src - Source file (actual file) path.
 * @param {string} dest - Destination file (link) path.
 * @param {object} [options] - Optional settings.
 * @param {string} [options.type='symlink'] - Link type
 * @param {boolean} [options.mkdirp] - Make parent directories.
 * @param {boolean} [options.force] - Force to symlink or not.
 * @param {function} callback - Callback when done.
 */

'use strict'

const fs = require('fs')
const argx = require('argx')
const path = require('path')
const {mkdirpAsync, existsAsync, statAsync} = require('asfs')
const _cleanDest = require('./_clean_dest')
const _followSymlink = require('./_follow_symlink')

/** @lends filelink */
async function filelink (src, dest, options) {
  let args = argx(arguments)
  if (args.pop('function')) {
    throw new Error('Callback is no more supported. Use promise interface instead')
  }
  options = args.pop('object') || {}

  const cwd = options.cwd || process.cwd()
  src = path.resolve(cwd, args.shift('string'))
  dest = path.resolve(cwd, args.shift('string'))

  const type = options.type || 'symlink'
  const force = !!options.force
  const destDir = path.dirname(dest)

  src = await _followSymlink(src)
  if (options.mkdirp) {
    await mkdirpAsync(destDir)
  } else {
    let exists = await existsAsync(destDir)
    if (!exists) {
      throw new Error(`Directory not exists: ${destDir}`)
    }
  }
  let srcName = path.relative(destDir, src)
  let destName = path.relative(destDir, dest)

  let before = (await existsAsync(dest)) && (await statAsync(dest))

  if (force) {
    await _cleanDest(dest)
  }

  process.chdir(destDir)
  _doLinkSync(srcName, destName, type)
  process.chdir(cwd)

  let after = (await existsAsync(dest)) && (await statAsync(dest))

  await new Promise((resolve) => process.nextTick(() => resolve()))

  let unchanged = (before && before.size) === (after && after.size)
  return !unchanged
}

module.exports = filelink

function _doLinkSync (src, dest, type) {
  switch (type) {
    case 'link':
      fs.linkSync(src, dest)
      break
    case 'symlink':
      fs.symlinkSync(src, dest)
      break
    default:
      throw new Error('Unknown type:' + type)
  }
}