lowdefy/dist/utils/getLowdefyYaml.js

Lowdefy CLI

/*
  Copyright 2020-2026 Lowdefy, Inc

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/ import path from 'path';
import { get, type } from '@lowdefy/helpers';
import { ConfigError } from '@lowdefy/errors';
import { readFile } from '@lowdefy/node-utils';
import YAML from 'yaml';
async function getLowdefyYaml({ configDirectory, requiresLowdefyYaml }) {
    const filePath = 'lowdefy.yaml';
    let lowdefyYaml = await readFile(path.join(configDirectory, filePath));
    if (!lowdefyYaml) {
        lowdefyYaml = await readFile(path.join(configDirectory, 'lowdefy.yml'));
    }
    if (!lowdefyYaml) {
        if (requiresLowdefyYaml) {
            throw new Error(`Could not find "lowdefy.yaml" file in specified config directory ${configDirectory}.`);
        }
        return {
            cliConfig: {}
        };
    }
    let lowdefy;
    try {
        lowdefy = YAML.parse(lowdefyYaml);
    } catch (error) {
        throw new ConfigError('Could not parse YAML.', {
            cause: error,
            filePath
        });
    }
    if (!lowdefy.lowdefy) {
        throw new Error('No version specified in "lowdefy.yaml" file. Specify a version in the "lowdefy" field.');
    }
    if (!type.isString(lowdefy.lowdefy)) {
        throw new ConfigError('Version number specified in "lowdefy.yaml" file should be a string.', {
            received: lowdefy.lowdefy,
            filePath
        });
    }
    // TODO: Validate plugins
    return {
        lowdefyVersion: lowdefy.lowdefy,
        cliConfig: get(lowdefy, 'cli', {
            default: {}
        }),
        plugins: get(lowdefy, 'plugins', {
            default: []
        })
    };
}
export default getLowdefyYaml;