Function downloadTemplate

packages/sf-core/src/utils/https/index.js:333–395

(inputUrl, newTemplateName)

 * @returns A Promise
 */
export const downloadTemplate = async (inputUrl, newTemplateName) => {
  // Parse the repository URL
  const repoInformation = await parseRepoURL(inputUrl)
  const { username, password } = repoInformation

  let subdirectory
  if (repoInformation.isSubdirectory) {
    subdirectory = repoInformation.pathToDirectory.split('/').splice(-1)[0]
  }

  const existingServiceName = subdirectory || repoInformation.repo
  const tmpDownloadPath = path.join(os.tmpdir(), repoInformation.repo)
  const newServicePath = path.join(
    process.cwd(),
    newTemplateName || existingServiceName,
  )

  // Check if a folder with the same name already exists
  if (await dirExists(newServicePath)) {
    const errorMessage = `A folder named "${newServicePath}" already exists.`
    throw new Error(errorMessage)
  }

  // Download repo contents
  const downloadOptions = {
    timeout: 30000,
    extract: true,
    strip: 1,
    username,
    password,
  }
  let downloadedDataPath = await downloadDataFromUri(
    repoInformation.downloadUrl,
    tmpDownloadPath,
    downloadOptions,
  )

  // Check if the downloaded file is a zip file
  if (downloadedDataPath.endsWith('.zip')) {
    const unzipPath = path.join(
      tmpDownloadPath,
      path.basename(repoInformation.downloadUrl, '.zip'),
    )
    // Get the extracted contents and point to the path variable to it
    downloadedDataPath = await unzipFile(downloadedDataPath, unzipPath)
  }

  const directory = path.join(
    downloadedDataPath,
    repoInformation.pathToDirectory,
  )
  await copyDirContents(directory, newServicePath)

  // Remove the temporary directory
  await removeFileOrDirectory(tmpDownloadPath)

  // Remove serverless.template.yml if it exists
  await removeFileOrDirectory(