netlify-cli/dist/utils/get-repo-data.js

Netlify command line tool

import { dirname } from 'path';
import util from 'util';
import { findUp } from 'find-up';
import gitRepoInfo from 'git-repo-info';
import gitconfiglocal from 'gitconfiglocal';
import parseGithubUrl from 'parse-github-url';
import { log } from './command-helpers.js';
/**
 *
 * @param {object} config
 * @param {string} [config.remoteName]
 * @param {string} config.workingDir
 * @returns
 */
const getRepoData = async function ({ remoteName, workingDir }) {
    try {
        const [gitConfig, gitDirectory] = await Promise.all([
            util.promisify(gitconfiglocal)(workingDir),
            findUp('.git', { cwd: workingDir, type: 'directory' }),
        ]);
        if (!gitDirectory || !gitConfig || !gitConfig.remote || Object.keys(gitConfig.remote).length === 0) {
            throw new Error('No Git remote found');
        }
        const baseGitPath = dirname(gitDirectory);
        if (workingDir !== baseGitPath) {
            log(`Git directory located in ${baseGitPath}`);
        }
        if (!remoteName) {
            const remotes = Object.keys(gitConfig.remote);
            remoteName = remotes.find((remote) => remote === 'origin') || remotes[0];
        }
        if (!Object.prototype.hasOwnProperty.call(gitConfig.remote, remoteName) ||
            !gitConfig.remote[remoteName] ||
            Object.keys(gitConfig.remote[remoteName]).length === 0) {
            throw new Error(`The specified remote "${remoteName}" is not defined in Git repo. Please use --git-remote-name flag to specify a remote.`);
        }
        const { url } = gitConfig.remote[remoteName];
        const parsedUrl = parseGithubUrl(url);
        if (parsedUrl == null) {
            throw new Error(`The specified Git remote ${remoteName} is not a valid URL: ${url}`);
        }
        const { host, name, owner, repo } = parsedUrl;
        const { branch } = gitRepoInfo();
        return {
            name,
            owner,
            repo,
            url,
            branch,
            provider: host != null ? PROVIDERS[host] ?? host : host,
            httpsUrl: `https://${host}/${repo}`,
        };
    }
    catch (error) {
        return {
            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
            error: error.message,
        };
    }
};
const PROVIDERS = {
    'github.com': 'github',
    'gitlab.com': 'gitlab',
};
export default getRepoData;