@netlify/config/lib/path.js

Netlify config module

import { existsSync } from 'fs';
import { join, resolve } from 'path';
import { findUp } from 'find-up';
import pLocate from 'p-locate';
const FILENAME = 'netlify.toml';
/**
 * Configuration location can be:
 * - a local path with the --config CLI flag
 * - a `netlify.*` file in the `repositoryRoot/{base}/{packagePath}`
 * - a `netlify.*` file in the `repositoryRoot/{base}`
 * - a `netlify.*` file in the `repositoryRoot`
 * - a `netlify.*` file in the current directory or any parent
 */
export const getConfigPath = async function ({ configOpt, cwd, repositoryRoot, configBase, packagePath, }) {
    const configPath = await pLocate([
        searchConfigOpt(cwd, configOpt),
        searchBaseConfigFile(repositoryRoot, configBase, packagePath),
        searchConfigFile(repositoryRoot),
        findUp(FILENAME, { cwd }),
    ], Boolean);
    return configPath;
};
/** --config CLI flag */
const searchConfigOpt = function (cwd, configOpt) {
    if (configOpt === undefined || configOpt.length === 0) {
        return;
    }
    return resolve(cwd, configOpt);
};
/**
 * Look for `repositoryRoot/{base}/{packagePath || '}/netlify.*`
 */
const searchBaseConfigFile = function (repoRoot, base, packagePath) {
    if (base === undefined && packagePath === undefined) {
        return;
    }
    const cwd = join(base ? base : repoRoot, packagePath || '');
    return searchConfigFile(cwd);
};
/**
 * Look for several file extensions for `netlify.*`
 */
const searchConfigFile = function (cwd) {
    const path = resolve(cwd, FILENAME);
    if (!existsSync(path)) {
        return;
    }
    return path;
};