now-cli/lib/get-files.js

// Native
import {resolve} from 'path'

// Packages
import flatten from 'arr-flatten'
import ignore from 'ignore'
import Mode from 'stat-mode'
import unique from 'array-unique'
import {stat, readdir, readFile} from 'fs-promise'

// Ours
import IGNORED from './ignored'

/**
 * Returns a list of files in the given
 * directory that are subject to be
 * synchronized for npm.
 *
 * @param {String} full path to directory
 * @param {String} contents of `package.json` to avoid lookup
 * @param {Object} options:
 *  - `limit` {Number|null} byte limit
 *  - `debug` {Boolean} warn upon ignore
 * @return {Array} comprehensive list of paths to sync
 */

export async function npm(path, pkg, {
  limit = null,
  debug = false
} = {}) {
  const whitelist = pkg.now && pkg.now.files ? pkg.now.files : pkg.files

  // the package.json `files` whitelist still
  // honors ignores: https://docs.npmjs.com/files/package.json#files
  const search_ = whitelist || ['.']

  // always include the "main" file
  if (pkg.main) {
    search_.push(pkg.main)
  }

  // convert all filenames into absolute paths
  const search = search_.map(file => asAbsolute(file, path))

  // compile list of ignored patterns and files
  const npmIgnore = await maybeRead(resolve(path, '.npmignore'), null)

  const filter = ignore().add(
    IGNORED +
    '\n' +
    clearRelative(npmIgnore === null ? await maybeRead(resolve(path, '.gitignore')) : npmIgnore)
  ).createFilter()

  const prefixLength = path.length + 1
  const accepts = async function (file) {
    const relativePath = file.substr(prefixLength)

    if (relativePath === '') {
      return true
    }

    const st = await stat(file)
    const mode = new Mode(st)
    if (!(mode.isDirectory() || mode.isFile() || mode.isSymbolicLink())) {
      if (debug) {
        console.log('> [debug] ignoring special file "%s"', file)
      }
      return false
    }

    const accepted = filter(relativePath)
    if (!accepted && debug) {
      console.log('> [debug] ignoring "%s"', file)
    }
    return accepted
  }

  // locate files
  if (debug) {
    console.time(`> [debug] locating files ${path}`)
  }

  const files = await explode(search, {
    accepts,
    limit,
    debug
  })

  if (debug) {
    console.timeEnd(`> [debug] locating files ${path}`)
  }

  // always include manifest as npm does not allow ignoring it
  // source: https://docs.npmjs.com/files/package.json#files
  files.push(asAbsolute('package.json', path))

  // get files
  return unique(files)
}

/**
 * Transform relative paths into absolutes,
 * and maintains absolutes as such.
 *
 * @param {String} maybe relative path
 * @param {String} parent full path
 */

const asAbsolute = function (path, parent) {
  if (path[0] === '/') {
    return path
  }

  return resolve(parent, path)
}

/**
 * Returns a list of files in the given
 * directory that are subject to be
 * sent to docker as build context.
 *
 * @param {String} full path to directory
 * @param {String} contents of `Dockerfile`
 * @param {Object} options:
 *  - `limit` {Number|null} byte limit
 *  - `debug` {Boolean} warn upon ignore
 * @return {Array} comprehensive list of paths to sync
 */

export async function docker(path, {
  limit = null,
  debug = false
} = {}) {
  // base search path
  const search_ = ['.']

  // convert all filenames into absolute paths
  const search = search_.map(file => asAbsolute(file, path))

  // compile list of ignored patterns and files
  const filter = ignore().add(
    IGNORED +
    '\n' +
    await maybeRead(resolve(path, '.dockerignore'))
  ).createFilter()

  const prefixLength = path.length + 1
  const accepts = async function (file) {
    const relativePath = file.substr(prefixLength)

    if (relativePath === '') {
      return true
    }

    const st = await stat(file)
    const mode = new Mode(st)
    if (!(mode.isDirectory() || mode.isFile() || mode.isSymbolicLink())) {
      if (debug) {
        console.log('> [debug] ignoring special file "%s"', file)
      }
      return false
    }

    const accepted = filter(relativePath)
    if (!accepted && debug) {
      console.log('> [debug] ignoring "%s"', file)
    }
    return accepted
  }

  // locate files
  if (debug) {
    console.time(`> [debug] locating files ${path}`)
  }

  const files = await explode(search, {accepts, limit, debug})

  if (debug) {
    console.timeEnd(`> [debug] locating files ${path}`)
  }

  // always include manifest as npm does not allow ignoring it
  // source: https://docs.npmjs.com/files/package.json#files
  files.push(asAbsolute('Dockerfile', path))

  // get files
  return unique(files)
}

/**
 * Explodes directories into a full list of files.
 * Eg:
 *   in:  ['/a.js', '/b']
 *   out: ['/a.js', '/b/c.js', '/b/d.js']
 *
 * @param {Array} of {String}s representing paths
 * @param {Array} of ignored {String}s.
 * @param {Object} options:
 *  - `limit` {Number|null} byte limit
 *  - `debug` {Boolean} warn upon ignore
 * @return {Array} of {String}s of full paths
 */

const explode = async function (paths, {accepts}) {
  const list = async file => {
    let path = file
    let s

    if (!(await accepts(file))) {
      return null
    }

    try {
      s = await stat(path)
    } catch (e) {
      // in case the file comes from `files` or `main`
      // and it wasn't specified with `.js` by the user
      path = file + '.js'

      try {
        s = await stat(path)
      } catch (e2) {
        return null
      }
    }

    if (s.isDirectory()) {
      const all = await readdir(file)
      return many(all.map(subdir => asAbsolute(subdir, file)))
    }

    return path
  }

  const many = async all => {
    return await Promise.all(all.map(async file => {
      return await list(file)
    }))
  }

  return flatten((await many(paths))).filter(v => v !== null)
}

/**
 * Returns the contents of a file if it exists.
 *
 * @return {String} results or `''`
 */

const maybeRead = async function (path, default_ = '') {
  try {
    return (await readFile(path, 'utf8'))
  } catch (err) {
    return default_
  }
}

/**
 * Remove leading `./` from the beginning of ignores
 * because our parser doesn't like them :|
 */

const clearRelative = function (str) {
  return str.replace(/(\n|^)\.\//g, '$1')
}