payload/dist/config/find.js

Node, React, Headless CMS and Application Framework built on Next.js

// @ts-strict-ignore
import { getTsconfig } from 'get-tsconfig';
import path from 'path';
import { findUpSync } from '../utilities/findUp.js';
/**
 * List of all filenames to detect as a Payload configuration file.
 */ export const payloadConfigFileNames = [
    'payload.config.js',
    'payload.config.ts'
];
/**
 * Returns the source and output paths from the nearest tsconfig.json file.
 * If no tsconfig.json file is found, returns the current working directory.
 * @returns An object containing the source and output paths.
 */ const getTSConfigPaths = ()=>{
    const tsConfigResult = getTsconfig();
    const tsConfig = tsConfigResult.config;
    const tsConfigDir = path.dirname(tsConfigResult.path);
    try {
        const rootConfigDir = path.resolve(tsConfigDir, tsConfig.compilerOptions.baseUrl || '');
        const srcPath = tsConfig.compilerOptions?.rootDir || path.resolve(process.cwd(), 'src');
        const outPath = tsConfig.compilerOptions?.outDir || path.resolve(process.cwd(), 'dist');
        let configPath = tsConfig.compilerOptions?.paths?.['@payload-config']?.[0];
        if (configPath) {
            configPath = path.resolve(rootConfigDir, configPath);
        }
        return {
            configPath,
            outPath,
            rootPath: rootConfigDir,
            srcPath,
            tsConfigPath: tsConfigResult.path
        };
    } catch (error) {
        console.error(`Error parsing tsconfig.json: ${error}`) // Do not throw the error, as we can still continue with the other config path finding methods
        ;
        return {
            rootPath: process.cwd()
        };
    }
};
/**
 * Searches for a Payload configuration file.
 * @returns The absolute path to the Payload configuration file.
 * @throws An error if no configuration file is found.
 */ export const findConfig = ()=>{
    // If the developer has specified a config path,
    // format it if relative and use it directly if absolute
    if (process.env.PAYLOAD_CONFIG_PATH) {
        if (path.isAbsolute(process.env.PAYLOAD_CONFIG_PATH)) {
            return process.env.PAYLOAD_CONFIG_PATH;
        }
        return path.resolve(process.cwd(), process.env.PAYLOAD_CONFIG_PATH);
    }
    const { configPath, outPath, rootPath, srcPath } = getTSConfigPaths();
    // if configPath is absolute file, not folder, return it
    if (configPath && (path.extname(configPath) === '.js' || path.extname(configPath) === '.ts')) {
        return configPath;
    }
    const searchPaths = process.env.NODE_ENV === 'production' ? [
        configPath,
        outPath,
        srcPath,
        rootPath
    ] : [
        configPath,
        srcPath,
        rootPath
    ];
    for (const searchPath of searchPaths){
        if (!searchPath) {
            continue;
        }
        const configPath = findUpSync({
            dir: searchPath,
            fileNames: payloadConfigFileNames
        });
        if (configPath) {
            return configPath;
        }
    }
    // If no config file is found in the directories defined by tsconfig.json,
    // try searching in the 'src' and 'dist' directory as a last resort, as they are most commonly used
    if (process.env.NODE_ENV === 'production') {
        const distConfigPath = findUpSync({
            dir: path.resolve(process.cwd(), 'dist'),
            fileNames: [
                'payload.config.js'
            ]
        });
        if (distConfigPath) {
            return distConfigPath;
        }
    } else {
        const srcConfigPath = findUpSync({
            dir: path.resolve(process.cwd(), 'src'),
            fileNames: payloadConfigFileNames
        });
        if (srcConfigPath) {
            return srcConfigPath;
        }
    }
    throw new Error('Error: cannot find Payload config. Please create a configuration file located at the root of your current working directory called "payload.config.js" or "payload.config.ts".');
};

//# sourceMappingURL=find.js.map