|
|
|
@ -4,6 +4,7 @@ import minimatch from 'minimatch'; |
|
|
|
import IGNORED from './ignored'; |
|
|
|
import { resolve } from 'path'; |
|
|
|
import { stat, readdir, readFile } from 'fs-promise'; |
|
|
|
import parser from 'gitignore-parser'; |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns a list of files in the given |
|
|
|
@ -18,90 +19,119 @@ import { stat, readdir, readFile } from 'fs-promise'; |
|
|
|
* @return {Array} comprehensive list of paths to sync |
|
|
|
*/ |
|
|
|
|
|
|
|
export default async function getFiles (path, pkg, { |
|
|
|
deploymentType = 'npm', |
|
|
|
export async function npm (path, pkg, { |
|
|
|
limit = null, |
|
|
|
debug = false |
|
|
|
}) { |
|
|
|
if (!pkg && 'npm' === deploymentType) { |
|
|
|
const pkgPath = resolve(path, 'package.json'); |
|
|
|
const pkgData = await readFile(pkgPath, 'utf8'); |
|
|
|
pkg = JSON.parse(pkgData); |
|
|
|
} = {}) { |
|
|
|
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); |
|
|
|
} |
|
|
|
|
|
|
|
let search = (pkg ? pkg.files || ['.'] : []).concat( |
|
|
|
'npm' === deploymentType |
|
|
|
? 'package.json' |
|
|
|
: 'Dockerfile' |
|
|
|
); |
|
|
|
|
|
|
|
if ('npm' === deploymentType && pkg.main) { |
|
|
|
search = search.concat(pkg.main); |
|
|
|
} |
|
|
|
// convert all filenames into absolute paths
|
|
|
|
const search = search_.map((file) => asAbsolute(file, path)); |
|
|
|
|
|
|
|
search = search.map((file) => asAbsolute(file, path)); |
|
|
|
// locate files
|
|
|
|
if (debug) console.time('> [debug] locating files'); |
|
|
|
const files_ = await explode(search, { limit, debug }); |
|
|
|
if (debug) console.timeEnd('> [debug] locating files'); |
|
|
|
|
|
|
|
// compile list of ignored patterns and files
|
|
|
|
let ignored; |
|
|
|
if ('npm' === deploymentType) { |
|
|
|
const npmIgnore = await maybeRead(resolve(path, '.npmignore')); |
|
|
|
const gitIgnore = npmIgnore |
|
|
|
? '' |
|
|
|
: (await maybeRead(resolve(path, '.gitignore'))); |
|
|
|
ignored = unique(IGNORED |
|
|
|
.concat(gitIgnore.split('\n').filter(invalidFilter)) |
|
|
|
.concat(npmIgnore.split('\n').filter(invalidFilter))); |
|
|
|
} else { |
|
|
|
const dockerIgnore = await maybeRead(resolve(path, '.dockerignore')); |
|
|
|
ignored = unique(IGNORED |
|
|
|
.concat(dockerIgnore.split('\n').filter(invalidFilter))); |
|
|
|
} |
|
|
|
const npmIgnore = await maybeRead(resolve(path, '.npmignore'), null); |
|
|
|
const ignored = parser.compile( |
|
|
|
IGNORED + |
|
|
|
'\n' + |
|
|
|
clearRelative(null != npmIgnore |
|
|
|
? npmIgnore |
|
|
|
: await maybeRead(resolve(path, '.gitignore'))) |
|
|
|
); |
|
|
|
|
|
|
|
ignored = ignored.map((file) => resolve(path, file)); |
|
|
|
// if debugging is turned on, describe which files
|
|
|
|
// are being ignored
|
|
|
|
const prefixLength = path.length + 1; |
|
|
|
const accepts = function (file) { |
|
|
|
const accepted = ignored.accepts(file.substr(prefixLength)); |
|
|
|
if (!accepted && debug) { |
|
|
|
console.log('> [debug] ignoring "%s"', file); |
|
|
|
} |
|
|
|
return accepted; |
|
|
|
}; |
|
|
|
|
|
|
|
// filter files
|
|
|
|
const files = files_.filter(accepts); |
|
|
|
|
|
|
|
// 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((await explode(search, ignored, { limit, debug }))); |
|
|
|
return unique(files); |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns a filter function that |
|
|
|
* excludes ignored files in the path. |
|
|
|
* Returns a list of files in the given |
|
|
|
* directory that are subject to be |
|
|
|
* sent to docker as build context. |
|
|
|
* |
|
|
|
* @param {String} path |
|
|
|
* @return {Function} filter fn |
|
|
|
* @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 |
|
|
|
*/ |
|
|
|
|
|
|
|
// TODO: revisit this to support the entire
|
|
|
|
// .dockerignore format like the `!` prefix
|
|
|
|
const isIgnored = (file, ignored) => { |
|
|
|
return ignored.some((test) => { |
|
|
|
// test that the target file is not under
|
|
|
|
// an ignored directory
|
|
|
|
const dir = test + '/'; |
|
|
|
if (file.substr(0, dir.length) === dir) return true; |
|
|
|
|
|
|
|
// if not match wildcards
|
|
|
|
return minimatch(file, test); |
|
|
|
}); |
|
|
|
}; |
|
|
|
export async function docker (path, { |
|
|
|
limit = null, |
|
|
|
debug = false |
|
|
|
} = {}) { |
|
|
|
// base search path
|
|
|
|
const search_ = ['.']; |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns a filter function that |
|
|
|
* excludes invalid rules for .*ignore files |
|
|
|
* |
|
|
|
* @param {String} path |
|
|
|
* @return {Function} filter fn |
|
|
|
*/ |
|
|
|
// convert all filenames into absolute paths
|
|
|
|
const search = search_.map((file) => asAbsolute(file, path)); |
|
|
|
|
|
|
|
const invalidFilter = (path) => { |
|
|
|
return !( |
|
|
|
/* commments */ |
|
|
|
'#' === path[0] || |
|
|
|
// locate files
|
|
|
|
if (debug) console.time('> [debug] locating files'); |
|
|
|
const files_ = await explode(search, { limit, debug }); |
|
|
|
if (debug) console.timeEnd('> [debug] locating files'); |
|
|
|
|
|
|
|
/* empty lines or newlines */ |
|
|
|
!path.trim().length |
|
|
|
// compile list of ignored patterns and files
|
|
|
|
const ignored = parser.compile( |
|
|
|
IGNORED + |
|
|
|
'\n' + |
|
|
|
await maybeRead(resolve(path, '.dockerignore')) |
|
|
|
); |
|
|
|
}; |
|
|
|
|
|
|
|
// if debugging is turned on, describe which files
|
|
|
|
// are being ignored
|
|
|
|
const prefixLength = path.length + 1; |
|
|
|
const accepts = function (file) { |
|
|
|
const accepted = ignored.accepts(file.substr(prefixLength)); |
|
|
|
if (!accepted && debug) { |
|
|
|
console.log('> [debug] ignoring "%s"', file); |
|
|
|
} |
|
|
|
return accepted; |
|
|
|
}; |
|
|
|
|
|
|
|
// filter files
|
|
|
|
const files = files_.filter(accepts); |
|
|
|
|
|
|
|
// 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); |
|
|
|
} |
|
|
|
|
|
|
|
/** |
|
|
|
* Transform relative paths into absolutes, |
|
|
|
@ -130,7 +160,7 @@ const asAbsolute = function (path, parent) { |
|
|
|
* @return {Array} of {String}s of full paths |
|
|
|
*/ |
|
|
|
|
|
|
|
const explode = async function (paths, ignored, { limit, debug }) { |
|
|
|
const explode = async function (paths, { limit, debug }) { |
|
|
|
const many = async (all) => { |
|
|
|
return await Promise.all(all.map(async (file) => { |
|
|
|
return await list(file); |
|
|
|
@ -155,11 +185,6 @@ const explode = async function (paths, ignored, { limit, debug }) { |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
if (isIgnored(file, ignored)) { |
|
|
|
if (debug) console.log(`> [debug] Ignoring "${file}"`); |
|
|
|
return null; |
|
|
|
} |
|
|
|
|
|
|
|
if (s.isDirectory()) { |
|
|
|
const all = await readdir(file); |
|
|
|
return many(all.map(subdir => asAbsolute(subdir, file))); |
|
|
|
@ -177,10 +202,19 @@ const explode = async function (paths, ignored, { limit, debug }) { |
|
|
|
* @return {String} results or `''` |
|
|
|
*/ |
|
|
|
|
|
|
|
const maybeRead = async function (path) { |
|
|
|
const maybeRead = async function (path, default_ = '') { |
|
|
|
try { |
|
|
|
return (await readFile(path, 'utf8')); |
|
|
|
} catch (e) { |
|
|
|
return ''; |
|
|
|
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'); |
|
|
|
} |
|
|
|
|
Tony Kovanen
9 years ago
GitHub