@shopify/cli-kit 3.33.0 → 3.35.0

package/dist/public/node/fs.js

@@ -1,10 +1,346 @@
-import { exists as fileExists } from '../../file.js';
-import { join as joinPath } from '../../path.js';
+import { content as outputContent, token, debug } from '../../output.js';
 import { getRandomName } from '../common/string.js';
+import { join as joinPath } from '../../path.js';
+import { copy as fsCopy, ensureFile as fsEnsureFile, ensureFileSync as fsEnsureFileSync, remove as fsRemove, removeSync as fsRemoveSync, move as fsMove,
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+ } from 'fs-extra/esm';
+import { temporaryDirectoryTask } from 'tempy';
+import { sep, join, extname } from 'pathe';
+import { mkdirSync as fsMkdirSync, readFileSync as fsReadFileSync, writeFileSync as fsWriteFileSync, appendFileSync as fsAppendFileSync, statSync as fsStatSync, createReadStream as fsCreateReadStream, constants as fsConstants, } from 'fs';
+import { mkdir as fsMkdir, writeFile as fsWriteFile, readFile as fsReadFile, realpath as fsRealPath, appendFile as fsAppendFile, mkdtemp as fsMkdtemp, stat as fsStat, lstat as fsLstat, chmod as fsChmod, access as fsAccess, } from 'fs/promises';
+const DEFAULT_PRETTIER_CONFIG = {
+    arrowParens: 'always',
+    singleQuote: true,
+    bracketSpacing: false,
+    trailingComma: 'all',
+};
+/**
+ * Strip the first `strip` parts of the path.
+ *
+ * @param path - Path to strip.
+ * @param strip - Number of parts to strip.
+ * @returns The stripped path.
+ */
+export function stripUpPath(path, strip) {
+    const parts = path.split(sep);
+    return join(...parts.slice(strip));
+}
+/**
+ * Creates a temporary directory and ties its lifecycle to the lifecycle of the callback.
+ *
+ * @param callback - The callback that receives the temporary directory.
+ */
+export async function inTemporaryDirectory(callback) {
+    return temporaryDirectoryTask(callback);
+}
+/**
+ * It reads a file and returns its content as a string.
+ * Uses utf-8 encoding by default.
+ *
+ * @param path - Path to the file to read.
+ * @param options - Options to read the file with (defaults to utf-8 encoding).
+ * @returns A promise that resolves with the content of the file.
+ */
+export async function readFile(path, options = { encoding: 'utf8' }) {
+    debug(outputContent `Reading the content of file at ${token.path(path)}...`);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return fsReadFile(path, options);
+}
+/**
+ * Synchronously reads a file and returns its content as a string.
+ *
+ * @param path - Path to the file to read.
+ * @param options - Options to read the file with (defaults to utf-8 encoding).
+ * @returns The content of the file.
+ */
+export function readSync(path, options = { encoding: 'utf-8' }) {
+    debug(outputContent `Sync-reading the content of file at ${token.path(path)}...`);
+    const content = fsReadFileSync(path, options);
+    return content.toString();
+}
+/**
+ * Given a path, it determines the actual path. This is useful when working
+ * with paths that represent symlinks.
+ *
+ * @param path - Path whose real path will be returned.
+ */
+export async function fileRealPath(path) {
+    return fsRealPath(path);
+}
+/**
+ * Copies a file.
+ *
+ * @param from - Path to the directory or file to be copied.
+ * @param to - Destination path.
+ */
+export async function copyFile(from, to) {
+    debug(outputContent `Copying file from ${token.path(from)} to ${token.path(to)}...`);
+    await fsCopy(from, to);
+}
+/**
+ * Creates a file at the given path.
+ *
+ * @param path - Path to the file to be created.
+ */
+export async function touchFile(path) {
+    debug(outputContent `Creating an empty file at ${token.path(path)}...`);
+    await fsEnsureFile(path);
+}
+/**
+ * Synchronously creates a file at the given path.
+ *
+ * @param path - Path to the file to be created.
+ */
+export function touchFileSync(path) {
+    debug(outputContent `Creating an empty file at ${token.path(path)}...`);
+    fsEnsureFileSync(path);
+}
+/**
+ * Appnds content to file at path.
+ *
+ * @param path - Path to the file to be appended.
+ * @param content - Content to be appended.
+ */
+export async function appendFile(path, content) {
+    debug(outputContent `Appending the following content to ${token.path(path)}:
+    ${content
+        .split('\n')
+        .map((line) => `  ${line}`)
+        .join('\n')}
+  `);
+    await fsAppendFile(path, content);
+}
+/**
+ * Synchronously appends content to file at path.
+ *
+ * @param path - Path to the file to be appended.
+ * @param data - Content to be appended.
+ */
+export function appendFileSync(path, data) {
+    fsAppendFileSync(path, data);
+}
+/**
+ * Writes content to file at path.
+ *
+ * @param path - Path to the file to be written.
+ * @param data - Content to be written.
+ */
+export async function writeFile(path, data) {
+    debug(outputContent `Writing some content to file at ${token.path(path)}...`);
+    await fsWriteFile(path, data, { encoding: 'utf8' });
+}
+/**
+ * Synchronously writes content to file at path.
+ *
+ * @param path - Path to the file to be written.
+ * @param data - Content to be written.
+ */
+export function writeFileSync(path, data) {
+    debug(outputContent `File-writing some content to file at ${token.path(path)}...`);
+    fsWriteFileSync(path, data);
+}
+/**
+ * Creates a directory at the given path.
+ *
+ * @param path - Path to the directory to be created.
+ */
+export async function mkdir(path) {
+    debug(outputContent `Creating directory at ${token.path(path)}...`);
+    await fsMkdir(path, { recursive: true });
+}
+/**
+ * Synchronously creates a directory at the given path.
+ *
+ * @param path - Path to the directory to be created.
+ */
+export function mkdirSync(path) {
+    debug(outputContent `Sync-creating directory at ${token.path(path)}...`);
+    fsMkdirSync(path, { recursive: true });
+}
+/**
+ * Removes a file at the given path.
+ *
+ * @param path - Path to the file to be removed.
+ */
+export async function removeFile(path) {
+    debug(outputContent `Removing file at ${token.path(path)}...`);
+    await fsRemove(path);
+}
+/**
+ * Synchronously removes a file at the given path.
+ *
+ * @param path - Path to the file to be removed.
+ */
+export function removeFileSync(path) {
+    debug(outputContent `Sync-removing file at ${token.path(path)}...`);
+    fsRemoveSync(path);
+}
+/**
+ * Removes a directory at the given path.
+ *
+ * @param path - Path to the directory to be removed.
+ * @param options - Options to remove the directory with.
+ */
+export async function rmdir(path, options = {}) {
+    const { default: del } = await import('del');
+    debug(outputContent `Removing directory at ${token.path(path)}...`);
+    await del(path, { force: options.force });
+}
+/**
+ * Create a temporary directory.
+ *
+ * @returns Path to the temporary directory.
+ */
+export async function mkTmpDir() {
+    debug(outputContent `Creating a temporary directory...`);
+    const directory = await fsMkdtemp('tmp-');
+    return directory;
+}
+/**
+ * Check whether a path is a directory.
+ *
+ * @param path - Path to check.
+ * @returns True if the path is a directory, false otherwise.
+ */
+export async function isDirectory(path) {
+    debug(outputContent `Checking if ${token.path(path)} is a directory...`);
+    return (await fsLstat(path)).isDirectory();
+}
+/**
+ * Get the size of a file.
+ *
+ * @param path - Path to the file.
+ * @returns The size of the file in bytes.
+ */
+export async function fileSize(path) {
+    debug(outputContent `Getting the size of file file at ${token.path(path)}...`);
+    return (await fsStat(path)).size;
+}
+/**
+ * Synchronously get the size of a file.
+ *
+ * @param path - Path to the file.
+ * @returns The size of the file in bytes.
+ */
+export function fileSizeSync(path) {
+    debug(outputContent `Sync-getting the size of file file at ${token.path(path)}...`);
+    return fsStatSync(path).size;
+}
+/**
+ * Create a read stream for a file.
+ *
+ * @param path - Path to the file.
+ * @returns A read stream for the file.
+ */
+export function createFileReadStream(path) {
+    return fsCreateReadStream(path);
+}
+/**
+ * Returns the Date object for the last modification of a file.
+ *
+ * @param path - Path to the directory or file.
+ * @returns A unix timestamp.
+ */
+export async function fileLastUpdated(path) {
+    debug(outputContent `Getting last updated timestamp for file at ${token.path(path)}...`);
+    return (await fsStat(path)).ctime;
+}
+/**
+ * Returns the unix timestamp of the last modification of a file.
+ *
+ * @param path - Path to the directory or file.
+ * @returns A unix timestamp.
+ */
+export async function fileLastUpdatedTimestamp(path) {
+    try {
+        const lastUpdatedDateTime = await fileLastUpdated(path);
+        return lastUpdatedDateTime.getTime();
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Moves a file.
+ *
+ * @param src - File to be moved.
+ * @param dest - Path to be moved to.
+ * @param options - Moving options.
+ */
+export async function moveFile(src, dest, options = {}) {
+    await fsMove(src, dest, options);
+}
+/**
+ * Changes the permissions of a directory or file.
+ *
+ * @param path - Path to the file or directory whose permissions will be modified.
+ * @param mode - Permissions to set to the file or directory.
+ */
+export async function chmod(path, mode) {
+    await fsChmod(path, mode);
+}
+/**
+ * Checks if a file has executable permissions.
+ *
+ * @param path - Path to the file whose permissions will be checked.
+ */
+export async function fileHasExecutablePermissions(path) {
+    try {
+        await fsAccess(path, fsConstants.X_OK);
+        return true;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Returns true if a file or directory exists.
+ *
+ * @param path - Path to the directory or file.
+ * @returns True if it exists.
+ */
+export async function fileExists(path) {
+    try {
+        await fsAccess(path);
+        return true;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Format a string using prettier. Return the formatted content.
+ *
+ * @param content - Content to be formatted.
+ * @param options - Options to format the content with.
+ * @returns The formatted content.
+ */
+export async function fileContentPrettyFormat(content, options) {
+    const { default: prettier } = await import('prettier');
+    const ext = extname(options.path);
+    const prettierConfig = {
+        ...DEFAULT_PRETTIER_CONFIG,
+        parser: 'babel',
+    };
+    switch (ext) {
+        case '.html':
+        case '.css':
+            prettierConfig.parser = ext.slice(1);
+            break;
+    }
+    const formattedContent = await prettier.format(content, prettierConfig);
+    return formattedContent;
+}
 /**
  * It generates a random directory directory name for a sub-directory.
  * It ensures that the returned directory name doesn't exist.
  *
+ * @param options - Options to generate the random directory name.
  * @returns It returns the name of the directory.
  */
 export async function generateRandomNameForSubdirectory(options) {

package/dist/public/node/fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../src/public/node/fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,eAAe,CAAA;AAClD,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAA;AAcjD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAAuC;IAC7F,MAAM,SAAS,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAA;IACpF,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAClE,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,mBAAmB,CAAC,CAAA;IAEjE,IAAI,mBAAmB,EAAE;QACvB,OAAO,iCAAiC,CAAC,OAAO,CAAC,CAAA;KAClD;SAAM;QACL,OAAO,SAAS,CAAA;KACjB;AACH,CAAC","sourcesContent":["import {exists as fileExists} from '../../file.js'\nimport {join as joinPath} from '../../path.js'\nimport {getRandomName} from '../common/string.js'\nimport type {RandomNameFamily} from '../common/string.js'\n\ninterface GenerateRandomDirectoryOptions {\n  /** Suffix to include in the randomly generated directory name */\n  suffix: string\n\n  /** Absolute path to the directory where the random directory will be created. */\n  directory: string\n\n  /** Type of word to use for random name */\n  family?: RandomNameFamily\n}\n\n/**\n * It generates a random directory directory name for a sub-directory.\n * It ensures that the returned directory name doesn't exist.\n *\n * @returns It returns the name of the directory.\n */\nexport async function generateRandomNameForSubdirectory(options: GenerateRandomDirectoryOptions): Promise<string> {\n  const generated = `${getRandomName(options.family ?? 'business')}-${options.suffix}`\n  const randomDirectoryPath = joinPath(options.directory, generated)\n  const isAppDirectoryTaken = await fileExists(randomDirectoryPath)\n\n  if (isAppDirectoryTaken) {\n    return generateRandomNameForSubdirectory(options)\n  } else {\n    return generated\n  }\n}\n"]}
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../src/public/node/fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,aAAa,EAAE,KAAK,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACtE,OAAO,EAAC,aAAa,EAAmB,MAAM,qBAAqB,CAAA;AACnE,OAAO,EAAC,IAAI,IAAI,QAAQ,EAAC,MAAM,eAAe,CAAA;AAC9C,OAAO,EACL,IAAI,IAAI,MAAM,EACd,UAAU,IAAI,YAAY,EAC1B,cAAc,IAAI,gBAAgB,EAClC,MAAM,IAAI,QAAQ,EAClB,UAAU,IAAI,YAAY,EAC1B,IAAI,IAAI,MAAM;AACd,6DAA6D;AAC7D,aAAa;EACd,MAAM,cAAc,CAAA;AAErB,OAAO,EAAC,sBAAsB,EAAC,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,OAAO,CAAA;AACxC,OAAO,EACL,SAAS,IAAI,WAAW,EACxB,YAAY,IAAI,cAAc,EAC9B,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,QAAQ,IAAI,UAAU,EACtB,gBAAgB,IAAI,kBAAkB,EACtC,SAAS,IAAI,WAAW,GAEzB,MAAM,IAAI,CAAA;AACX,OAAO,EACL,KAAK,IAAI,OAAO,EAChB,SAAS,IAAI,WAAW,EACxB,QAAQ,IAAI,UAAU,EACtB,QAAQ,IAAI,UAAU,EACtB,UAAU,IAAI,YAAY,EAC1B,OAAO,IAAI,SAAS,EACpB,IAAI,IAAI,MAAM,EACd,KAAK,IAAI,OAAO,EAChB,KAAK,IAAI,OAAO,EAChB,MAAM,IAAI,QAAQ,GACnB,MAAM,aAAa,CAAA;AAGpB,MAAM,uBAAuB,GAAY;IACvC,WAAW,EAAE,QAAQ;IACrB,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,KAAK;IACrB,aAAa,EAAE,KAAK;CACrB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,KAAa;IACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC7B,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;AACpC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAI,QAA4C;IACxF,OAAO,sBAAsB,CAAC,QAAQ,CAAC,CAAA;AACzC,CAAC;AAoBD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY,EAAE,UAAuB,EAAC,QAAQ,EAAE,MAAM,EAAC;IACpF,KAAK,CAAC,aAAa,CAAA,kCAAkC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC3E,6DAA6D;IAC7D,aAAa;IACb,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,UAAkB,EAAC,QAAQ,EAAE,OAAO,EAAC;IAC1E,KAAK,CAAC,aAAa,CAAA,uCAAuC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAChF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC7C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAY;IAC7C,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY,EAAE,EAAU;IACrD,KAAK,CAAC,aAAa,CAAA,qBAAqB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;IACnF,MAAM,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY;IAC1C,KAAK,CAAC,aAAa,CAAA,6BAA6B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtE,MAAM,YAAY,CAAC,IAAI,CAAC,CAAA;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,KAAK,CAAC,aAAa,CAAA,6BAA6B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtE,gBAAgB,CAAC,IAAI,CAAC,CAAA;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,OAAe;IAC5D,KAAK,CAAC,aAAa,CAAA,sCAAsC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;MACrE,OAAO;SACN,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;SAC1B,IAAI,CAAC,IAAI,CAAC;GACd,CAAC,CAAA;IACF,MAAM,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,IAAY;IACvD,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY,EAAE,IAAY;IACxD,KAAK,CAAC,aAAa,CAAA,mCAAmC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC5E,MAAM,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,IAAY;IACtD,KAAK,CAAC,aAAa,CAAA,wCAAwC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjF,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,IAAY;IACtC,KAAK,CAAC,aAAa,CAAA,yBAAyB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClE,MAAM,OAAO,CAAC,IAAI,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;AACxC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,KAAK,CAAC,aAAa,CAAA,8BAA8B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvE,WAAW,CAAC,IAAI,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAY;IAC3C,KAAK,CAAC,aAAa,CAAA,oBAAoB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7D,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,KAAK,CAAC,aAAa,CAAA,yBAAyB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClE,YAAY,CAAC,IAAI,CAAC,CAAA;AACpB,CAAC;AAKD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,IAAY,EAAE,UAAwB,EAAE;IAClE,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,CAAA;IAC1C,KAAK,CAAC,aAAa,CAAA,yBAAyB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClE,MAAM,GAAG,CAAC,IAAI,EAAE,EAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAC,CAAC,CAAA;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,KAAK,CAAC,aAAa,CAAA,mCAAmC,CAAC,CAAA;IACvD,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAA;IACzC,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAY;IAC5C,KAAK,CAAC,aAAa,CAAA,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACvE,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,KAAK,CAAC,aAAa,CAAA,oCAAoC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7E,OAAO,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,KAAK,CAAC,aAAa,CAAA,yCAAyC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClF,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAA;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAA;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAY;IAChD,KAAK,CAAC,aAAa,CAAA,8CAA8C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvF,OAAO,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,IAAY;IACzD,IAAI;QACF,MAAM,mBAAmB,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAA;QACvD,OAAO,mBAAmB,CAAC,OAAO,EAAE,CAAA;QACpC,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,SAAS,CAAA;KACjB;AACH,CAAC;AAMD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAW,EAAE,IAAY,EAAE,UAA2B,EAAE;IACrF,MAAM,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,IAAY,EAAE,IAAqB;IAC7D,MAAM,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,IAAY;IAC7D,IAAI;QACF,MAAM,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CAAA;QACtC,OAAO,IAAI,CAAA;QACX,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAY;IAC3C,IAAI;QACF,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;QACpB,OAAO,IAAI,CAAA;QACX,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAMD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,OAAe,EAAE,OAAoB;IACjF,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAA;IAEpD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,cAAc,GAAY;QAC9B,GAAG,uBAAuB;QAC1B,MAAM,EAAE,OAAO;KAChB,CAAA;IAED,QAAQ,GAAG,EAAE;QACX,KAAK,OAAO,CAAC;QACb,KAAK,MAAM;YACT,cAAc,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACpC,MAAK;KACR;IAED,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;IAEvE,OAAO,gBAAgB,CAAA;AACzB,CAAC;AAaD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAAuC;IAC7F,MAAM,SAAS,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAA;IACpF,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAClE,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,mBAAmB,CAAC,CAAA;IAEjE,IAAI,mBAAmB,EAAE;QACvB,OAAO,iCAAiC,CAAC,OAAO,CAAC,CAAA;KAClD;SAAM;QACL,OAAO,SAAS,CAAA;KACjB;AACH,CAAC","sourcesContent":["import {content as outputContent, token, debug} from '../../output.js'\nimport {getRandomName, RandomNameFamily} from '../common/string.js'\nimport {join as joinPath} from '../../path.js'\nimport {\n  copy as fsCopy,\n  ensureFile as fsEnsureFile,\n  ensureFileSync as fsEnsureFileSync,\n  remove as fsRemove,\n  removeSync as fsRemoveSync,\n  move as fsMove,\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore\n} from 'fs-extra/esm'\n\nimport {temporaryDirectoryTask} from 'tempy'\nimport {sep, join, extname} from 'pathe'\nimport {\n  mkdirSync as fsMkdirSync,\n  readFileSync as fsReadFileSync,\n  writeFileSync as fsWriteFileSync,\n  appendFileSync as fsAppendFileSync,\n  statSync as fsStatSync,\n  createReadStream as fsCreateReadStream,\n  constants as fsConstants,\n  ReadStream,\n} from 'fs'\nimport {\n  mkdir as fsMkdir,\n  writeFile as fsWriteFile,\n  readFile as fsReadFile,\n  realpath as fsRealPath,\n  appendFile as fsAppendFile,\n  mkdtemp as fsMkdtemp,\n  stat as fsStat,\n  lstat as fsLstat,\n  chmod as fsChmod,\n  access as fsAccess,\n} from 'fs/promises'\nimport type {Options} from 'prettier'\n\nconst DEFAULT_PRETTIER_CONFIG: Options = {\n  arrowParens: 'always',\n  singleQuote: true,\n  bracketSpacing: false,\n  trailingComma: 'all',\n}\n\n/**\n * Strip the first `strip` parts of the path.\n *\n * @param path - Path to strip.\n * @param strip - Number of parts to strip.\n * @returns The stripped path.\n */\nexport function stripUpPath(path: string, strip: number): string {\n  const parts = path.split(sep)\n  return join(...parts.slice(strip))\n}\n\n/**\n * Creates a temporary directory and ties its lifecycle to the lifecycle of the callback.\n *\n * @param callback - The callback that receives the temporary directory.\n */\nexport async function inTemporaryDirectory<T>(callback: (tmpDir: string) => T | Promise<T>): Promise<T> {\n  return temporaryDirectoryTask(callback)\n}\n\n/**\n * It reads a file and returns its content as a string using the\n * utf-8 encoding.\n *\n * @param path - Path to the file to read.\n * @returns A promise that resolves with the content of the file.\n */\n\nexport type ReadOptions =\n  | undefined\n  | {flag?: string | undefined}\n  | {\n      encoding: BufferEncoding | string\n      flag?: string | undefined\n    }\nexport async function readFile(path: string, options?: ReadOptions): Promise<string>\nexport async function readFile(path: string, options?: ReadOptions): Promise<Buffer>\n\n/**\n * It reads a file and returns its content as a string.\n * Uses utf-8 encoding by default.\n *\n * @param path - Path to the file to read.\n * @param options - Options to read the file with (defaults to utf-8 encoding).\n * @returns A promise that resolves with the content of the file.\n */\nexport async function readFile(path: string, options: ReadOptions = {encoding: 'utf8'}): Promise<string | Buffer> {\n  debug(outputContent`Reading the content of file at ${token.path(path)}...`)\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore\n  return fsReadFile(path, options)\n}\n\n/**\n * Synchronously reads a file and returns its content as a string.\n *\n * @param path - Path to the file to read.\n * @param options - Options to read the file with (defaults to utf-8 encoding).\n * @returns The content of the file.\n */\nexport function readSync(path: string, options: object = {encoding: 'utf-8'}): string {\n  debug(outputContent`Sync-reading the content of file at ${token.path(path)}...`)\n  const content = fsReadFileSync(path, options)\n  return content.toString()\n}\n\n/**\n * Given a path, it determines the actual path. This is useful when working\n * with paths that represent symlinks.\n *\n * @param path - Path whose real path will be returned.\n */\nexport async function fileRealPath(path: string): Promise<string> {\n  return fsRealPath(path)\n}\n\n/**\n * Copies a file.\n *\n * @param from - Path to the directory or file to be copied.\n * @param to - Destination path.\n */\nexport async function copyFile(from: string, to: string): Promise<void> {\n  debug(outputContent`Copying file from ${token.path(from)} to ${token.path(to)}...`)\n  await fsCopy(from, to)\n}\n\n/**\n * Creates a file at the given path.\n *\n * @param path - Path to the file to be created.\n */\nexport async function touchFile(path: string): Promise<void> {\n  debug(outputContent`Creating an empty file at ${token.path(path)}...`)\n  await fsEnsureFile(path)\n}\n\n/**\n * Synchronously creates a file at the given path.\n *\n * @param path - Path to the file to be created.\n */\nexport function touchFileSync(path: string): void {\n  debug(outputContent`Creating an empty file at ${token.path(path)}...`)\n  fsEnsureFileSync(path)\n}\n\n/**\n * Appnds content to file at path.\n *\n * @param path - Path to the file to be appended.\n * @param content - Content to be appended.\n */\nexport async function appendFile(path: string, content: string): Promise<void> {\n  debug(outputContent`Appending the following content to ${token.path(path)}:\n    ${content\n      .split('\\n')\n      .map((line) => `  ${line}`)\n      .join('\\n')}\n  `)\n  await fsAppendFile(path, content)\n}\n\n/**\n * Synchronously appends content to file at path.\n *\n * @param path - Path to the file to be appended.\n * @param data - Content to be appended.\n */\nexport function appendFileSync(path: string, data: string): void {\n  fsAppendFileSync(path, data)\n}\n\n/**\n * Writes content to file at path.\n *\n * @param path - Path to the file to be written.\n * @param data - Content to be written.\n */\nexport async function writeFile(path: string, data: string): Promise<void> {\n  debug(outputContent`Writing some content to file at ${token.path(path)}...`)\n  await fsWriteFile(path, data, {encoding: 'utf8'})\n}\n\n/**\n * Synchronously writes content to file at path.\n *\n * @param path - Path to the file to be written.\n * @param data - Content to be written.\n */\nexport function writeFileSync(path: string, data: string): void {\n  debug(outputContent`File-writing some content to file at ${token.path(path)}...`)\n  fsWriteFileSync(path, data)\n}\n\n/**\n * Creates a directory at the given path.\n *\n * @param path - Path to the directory to be created.\n */\nexport async function mkdir(path: string): Promise<void> {\n  debug(outputContent`Creating directory at ${token.path(path)}...`)\n  await fsMkdir(path, {recursive: true})\n}\n\n/**\n * Synchronously creates a directory at the given path.\n *\n * @param path - Path to the directory to be created.\n */\nexport function mkdirSync(path: string): void {\n  debug(outputContent`Sync-creating directory at ${token.path(path)}...`)\n  fsMkdirSync(path, {recursive: true})\n}\n\n/**\n * Removes a file at the given path.\n *\n * @param path - Path to the file to be removed.\n */\nexport async function removeFile(path: string): Promise<void> {\n  debug(outputContent`Removing file at ${token.path(path)}...`)\n  await fsRemove(path)\n}\n\n/**\n * Synchronously removes a file at the given path.\n *\n * @param path - Path to the file to be removed.\n */\nexport function removeFileSync(path: string): void {\n  debug(outputContent`Sync-removing file at ${token.path(path)}...`)\n  fsRemoveSync(path)\n}\n\ninterface RmDirOptions {\n  force?: boolean\n}\n/**\n * Removes a directory at the given path.\n *\n * @param path - Path to the directory to be removed.\n * @param options - Options to remove the directory with.\n */\nexport async function rmdir(path: string, options: RmDirOptions = {}): Promise<void> {\n  const {default: del} = await import('del')\n  debug(outputContent`Removing directory at ${token.path(path)}...`)\n  await del(path, {force: options.force})\n}\n\n/**\n * Create a temporary directory.\n *\n * @returns Path to the temporary directory.\n */\nexport async function mkTmpDir(): Promise<string> {\n  debug(outputContent`Creating a temporary directory...`)\n  const directory = await fsMkdtemp('tmp-')\n  return directory\n}\n\n/**\n * Check whether a path is a directory.\n *\n * @param path - Path to check.\n * @returns True if the path is a directory, false otherwise.\n */\nexport async function isDirectory(path: string): Promise<boolean> {\n  debug(outputContent`Checking if ${token.path(path)} is a directory...`)\n  return (await fsLstat(path)).isDirectory()\n}\n\n/**\n * Get the size of a file.\n *\n * @param path - Path to the file.\n * @returns The size of the file in bytes.\n */\nexport async function fileSize(path: string): Promise<number> {\n  debug(outputContent`Getting the size of file file at ${token.path(path)}...`)\n  return (await fsStat(path)).size\n}\n\n/**\n * Synchronously get the size of a file.\n *\n * @param path - Path to the file.\n * @returns The size of the file in bytes.\n */\nexport function fileSizeSync(path: string): number {\n  debug(outputContent`Sync-getting the size of file file at ${token.path(path)}...`)\n  return fsStatSync(path).size\n}\n\n/**\n * Create a read stream for a file.\n *\n * @param path - Path to the file.\n * @returns A read stream for the file.\n */\nexport function createFileReadStream(path: string): ReadStream {\n  return fsCreateReadStream(path)\n}\n\n/**\n * Returns the Date object for the last modification of a file.\n *\n * @param path - Path to the directory or file.\n * @returns A unix timestamp.\n */\nexport async function fileLastUpdated(path: string): Promise<Date> {\n  debug(outputContent`Getting last updated timestamp for file at ${token.path(path)}...`)\n  return (await fsStat(path)).ctime\n}\n\n/**\n * Returns the unix timestamp of the last modification of a file.\n *\n * @param path - Path to the directory or file.\n * @returns A unix timestamp.\n */\nexport async function fileLastUpdatedTimestamp(path: string): Promise<number | undefined> {\n  try {\n    const lastUpdatedDateTime = await fileLastUpdated(path)\n    return lastUpdatedDateTime.getTime()\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return undefined\n  }\n}\n\ninterface MoveFileOptions {\n  overwrite?: boolean\n}\n\n/**\n * Moves a file.\n *\n * @param src - File to be moved.\n * @param dest - Path to be moved to.\n * @param options - Moving options.\n */\nexport async function moveFile(src: string, dest: string, options: MoveFileOptions = {}): Promise<void> {\n  await fsMove(src, dest, options)\n}\n\n/**\n * Changes the permissions of a directory or file.\n *\n * @param path - Path to the file or directory whose permissions will be modified.\n * @param mode - Permissions to set to the file or directory.\n */\nexport async function chmod(path: string, mode: number | string): Promise<void> {\n  await fsChmod(path, mode)\n}\n\n/**\n * Checks if a file has executable permissions.\n *\n * @param path - Path to the file whose permissions will be checked.\n */\nexport async function fileHasExecutablePermissions(path: string): Promise<boolean> {\n  try {\n    await fsAccess(path, fsConstants.X_OK)\n    return true\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return false\n  }\n}\n\n/**\n * Returns true if a file or directory exists.\n *\n * @param path - Path to the directory or file.\n * @returns True if it exists.\n */\nexport async function fileExists(path: string): Promise<boolean> {\n  try {\n    await fsAccess(path)\n    return true\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return false\n  }\n}\n\ninterface FileOptions {\n  path: string\n}\n\n/**\n * Format a string using prettier. Return the formatted content.\n *\n * @param content - Content to be formatted.\n * @param options - Options to format the content with.\n * @returns The formatted content.\n */\nexport async function fileContentPrettyFormat(content: string, options: FileOptions): Promise<string> {\n  const {default: prettier} = await import('prettier')\n\n  const ext = extname(options.path)\n  const prettierConfig: Options = {\n    ...DEFAULT_PRETTIER_CONFIG,\n    parser: 'babel',\n  }\n\n  switch (ext) {\n    case '.html':\n    case '.css':\n      prettierConfig.parser = ext.slice(1)\n      break\n  }\n\n  const formattedContent = await prettier.format(content, prettierConfig)\n\n  return formattedContent\n}\n\ninterface GenerateRandomDirectoryOptions {\n  /** Suffix to include in the randomly generated directory name. */\n  suffix: string\n\n  /** Absolute path to the directory where the random directory will be created. */\n  directory: string\n\n  /** Type of word to use for random name. */\n  family?: RandomNameFamily\n}\n\n/**\n * It generates a random directory directory name for a sub-directory.\n * It ensures that the returned directory name doesn't exist.\n *\n * @param options - Options to generate the random directory name.\n * @returns It returns the name of the directory.\n */\nexport async function generateRandomNameForSubdirectory(options: GenerateRandomDirectoryOptions): Promise<string> {\n  const generated = `${getRandomName(options.family ?? 'business')}-${options.suffix}`\n  const randomDirectoryPath = joinPath(options.directory, generated)\n  const isAppDirectoryTaken = await fileExists(randomDirectoryPath)\n\n  if (isAppDirectoryTaken) {\n    return generateRandomNameForSubdirectory(options)\n  } else {\n    return generated\n  }\n}\n"]}

package/dist/public/node/git.d.ts

@@ -0,0 +1,90 @@
+import { Abort } from '../../error.js';
+import { DefaultLogFields, ListLogLine } from 'simple-git';
+export declare const gitFactory: import("simple-git").SimpleGitFactory;
+/**
+ * Initialize a git repository at the given directory.
+ *
+ * @param directory - The directory where the git repository will be initialized.
+ * @param initialBranch - The name of the initial branch.
+ */
+export declare function initializeGitRepository(directory: string, initialBranch?: string): Promise<void>;
+export interface GitIgnoreTemplate {
+    [section: string]: string[];
+}
+/**
+ * Create a .gitignore file in the given directory.
+ *
+ * @param directory - The directory where the .gitignore file will be created.
+ * @param template - The template to use to create the .gitignore file.
+ */
+export declare function createGitIgnore(directory: string, template: GitIgnoreTemplate): void;
+/**
+ * Options to use when cloning a git repository.
+ *
+ * @param repoUrl - The URL of the repository to clone.
+ * @param destination - The directory where the repository will be cloned.
+ * @param progressUpdater - A function that will be called with the progress of the clone.
+ * @param shallow - Whether to clone the repository shallowly.
+ * @param latestTag - Whether to clone the latest tag instead of the default branch.
+ */
+export interface GitCloneOptions {
+    repoUrl: string;
+    destination: string;
+    progressUpdater?: (statusString: string) => void;
+    shallow?: boolean;
+    latestTag?: boolean;
+}
+/**
+ * Clone a git repository.
+ *
+ * @param cloneOptions - The options to use to clone the repository.
+ * @returns A promise that resolves when the clone is complete.
+ */
+export declare function downloadGitRepository(cloneOptions: GitCloneOptions): Promise<void>;
+/**
+ * Get the latest commit of a git repository.
+ *
+ * @param directory - The directory of the git repository.
+ * @returns The latest commit of the repository.
+ */
+export declare function getLatestGitCommit(directory?: string): Promise<DefaultLogFields & ListLogLine>;
+/**
+ * Add all files to the git index from the given directory.
+ *
+ * @param directory - The directory where the git repository is located.
+ * @returns A promise that resolves when the files are added to the index.
+ */
+export declare function addAllToGitFromDirectory(directory?: string): Promise<void>;
+export interface CreateGitCommitOptions {
+    directory?: string;
+    author?: string;
+}
+/**
+ * Create a git commit.
+ *
+ * @param message - The message of the commit.
+ * @param options - The options to use to create the commit.
+ * @returns The hash of the created commit.
+ */
+export declare function createGitCommit(message: string, options?: CreateGitCommitOptions): Promise<string>;
+/**
+ * Get the HEAD symbolic reference of a git repository.
+ *
+ * @param directory - The directory of the git repository.
+ * @returns The HEAD symbolic reference of the repository.
+ */
+export declare function getHeadSymbolicRef(directory?: string): Promise<string>;
+/**
+ * If "git" is not present in the environment it throws
+ * an abort error.
+ */
+export declare function ensureGitIsPresentOrAbort(): Promise<void>;
+export declare class OutsideGitDirectoryError extends Abort {
+}
+/**
+ * If command run from outside a .git directory tree
+ * it throws an abort error.
+ *
+ * @param directory - The directory to check.
+ */
+export declare function ensureInsideGitDirectory(directory?: string): Promise<void>;

package/dist/public/node/git.js

@@ -0,0 +1,174 @@
+import { hasGit, isTerminalInteractive } from './environment/local.js';
+import { appendFileSync } from './fs.js';
+import { Abort } from '../../error.js';
+import { content, token, debug } from '../../output.js';
+import git from 'simple-git';
+export const gitFactory = git;
+/**
+ * Initialize a git repository at the given directory.
+ *
+ * @param directory - The directory where the git repository will be initialized.
+ * @param initialBranch - The name of the initial branch.
+ */
+export async function initializeGitRepository(directory, initialBranch = 'main') {
+    debug(content `Initializing git repository at ${token.path(directory)}...`);
+    await ensureGitIsPresentOrAbort();
+    // We use init and checkout instead of `init --initial-branch` because the latter is only supported in git 2.28+
+    const repo = git(directory);
+    await repo.init();
+    await repo.checkoutLocalBranch(initialBranch);
+}
+/**
+ * Create a .gitignore file in the given directory.
+ *
+ * @param directory - The directory where the .gitignore file will be created.
+ * @param template - The template to use to create the .gitignore file.
+ */
+export function createGitIgnore(directory, template) {
+    debug(content `Creating .gitignore at ${token.path(directory)}...`);
+    const filePath = `${directory}/.gitignore`;
+    let fileContent = '';
+    for (const [section, lines] of Object.entries(template)) {
+        fileContent += `# ${section}\n`;
+        fileContent += `${lines.join('\n')}\n\n`;
+    }
+    appendFileSync(filePath, fileContent);
+}
+/**
+ * Clone a git repository.
+ *
+ * @param cloneOptions - The options to use to clone the repository.
+ * @returns A promise that resolves when the clone is complete.
+ */
+export async function downloadGitRepository(cloneOptions) {
+    const { repoUrl, destination, progressUpdater, shallow, latestTag } = cloneOptions;
+    debug(content `Git-cloning repository ${repoUrl} into ${token.path(destination)}...`);
+    await ensureGitIsPresentOrAbort();
+    const [repository, branch] = repoUrl.split('#');
+    const options = { '--recurse-submodules': null };
+    if (branch && latestTag) {
+        throw new Abort("Error cloning the repository. Git can't clone the latest release with a 'branch'.");
+    }
+    if (branch) {
+        options['--branch'] = branch;
+    }
+    if (shallow && latestTag) {
+        throw new Abort("Error cloning the repository. Git can't clone the latest release with the 'shallow' property.");
+    }
+    if (shallow) {
+        options['--depth'] = 1;
+    }
+    const progress = ({ stage, progress, processed, total }) => {
+        const updateString = `${stage}, ${processed}/${total} objects (${progress}% complete)`;
+        if (progressUpdater)
+            progressUpdater(updateString);
+    };
+    const simpleGitOptions = {
+        progress,
+        ...(!isTerminalInteractive() && { config: ['core.askpass=true'] }),
+    };
+    try {
+        await git(simpleGitOptions).clone(repository, destination, options);
+        if (latestTag) {
+            const localGitRepository = git(destination);
+            const latestTag = await getLocalLatestTag(localGitRepository, repoUrl);
+            await localGitRepository.checkout(latestTag);
+        }
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            const abortError = new Abort(err.message);
+            abortError.stack = err.stack;
+            throw abortError;
+        }
+        throw err;
+    }
+}
+/**
+ * Get the most recent tag of a local git repository.
+ *
+ * @param repository - The local git repository.
+ * @param repoUrl - The URL of the repository.
+ * @returns The most recent tag of the repository.
+ */
+async function getLocalLatestTag(repository, repoUrl) {
+    const latest = (await repository.tags()).latest;
+    if (!latest) {
+        throw new Abort(`Couldn't obtain the most recent tag of the repository ${repoUrl}`);
+    }
+    return latest;
+}
+/**
+ * Get the latest commit of a git repository.
+ *
+ * @param directory - The directory of the git repository.
+ * @returns The latest commit of the repository.
+ */
+export async function getLatestGitCommit(directory) {
+    const logs = await git({ baseDir: directory }).log({
+        maxCount: 1,
+    });
+    if (!logs.latest) {
+        throw new Abort('Must have at least one commit to run command', content `Run ${token.genericShellCommand("git commit -m 'Initial commit'")} to create your first commit.`);
+    }
+    return logs.latest;
+}
+/**
+ * Add all files to the git index from the given directory.
+ *
+ * @param directory - The directory where the git repository is located.
+ * @returns A promise that resolves when the files are added to the index.
+ */
+export async function addAllToGitFromDirectory(directory) {
+    const simpleGit = git({ baseDir: directory });
+    await simpleGit.raw('add', '--all');
+}
+/**
+ * Create a git commit.
+ *
+ * @param message - The message of the commit.
+ * @param options - The options to use to create the commit.
+ * @returns The hash of the created commit.
+ */
+export async function createGitCommit(message, options) {
+    const simpleGit = git({ baseDir: options?.directory });
+    const commitOptions = options?.author ? { '--author': options.author } : undefined;
+    const result = await simpleGit.commit(message, commitOptions);
+    return result.commit;
+}
+/**
+ * Get the HEAD symbolic reference of a git repository.
+ *
+ * @param directory - The directory of the git repository.
+ * @returns The HEAD symbolic reference of the repository.
+ */
+export async function getHeadSymbolicRef(directory) {
+    const ref = await git({ baseDir: directory }).raw('symbolic-ref', '-q', 'HEAD');
+    if (!ref) {
+        throw new Abort("Git HEAD can't be detached to run command", content `Run ${token.genericShellCommand('git checkout [branchName]')} to reattach HEAD or see git ${token.link('documentation', 'https://git-scm.com/book/en/v2/Git-Internals-Git-References')} for more details`);
+    }
+    return ref.trim();
+}
+/**
+ * If "git" is not present in the environment it throws
+ * an abort error.
+ */
+export async function ensureGitIsPresentOrAbort() {
+    if (!(await hasGit())) {
+        throw new Abort(`Git is necessary in the environment to continue`, content `Install ${token.link('git', 'https://git-scm.com/book/en/v2/Getting-Started-Installing-Git')}`);
+    }
+}
+export class OutsideGitDirectoryError extends Abort {
+}
+/**
+ * If command run from outside a .git directory tree
+ * it throws an abort error.
+ *
+ * @param directory - The directory to check.
+ */
+export async function ensureInsideGitDirectory(directory) {
+    if (!(await git({ baseDir: directory }).checkIsRepo())) {
+        throw new OutsideGitDirectoryError(`${token.path(directory || process.cwd())} is not a Git directory`);
+    }
+}
+//# sourceMappingURL=git.js.map