git-sync-js 0.4.6 → 1.0.0

package/README.md

@@ -74,6 +74,7 @@ try {
         logger.notice(this.translateMessage(message), { handler: WikiChannel.syncProgress, callerFunction: 'commitAndSync', ...context });
       },
     },
+    filesToIgnore,
   });
 } catch (error) {
   this.translateErrorMessage(error);
@@ -110,7 +111,7 @@ try {
 Get modified files and modify type in a folder
 
 ```ts
-await getModifiedFileList(wikiFolderPath)
+await getModifiedFileList(wikiFolderPath);
 ```
 
 ### getRemoteUrl
@@ -119,7 +120,7 @@ Inspect git's remote url from folder's .git config
 
 ```ts
 export async function credentialOff(directory: string, remoteUrl?: string): Promise<void> {
-  const githubRepoUrl = remoteUrl ?? await getRemoteUrl(directory);
+  const githubRepoUrl = remoteUrl ?? (await getRemoteUrl(directory));
   const gitUrlWithOutCredential = getGitUrlWithOutCredential(githubRepoUrl);
   await GitProcess.exec(['remote', 'set-url', 'origin', gitUrlWithOutCredential], directory);
 }

package/dist/src/clone.d.ts

@@ -0,0 +1,13 @@
+import { IGitUserInfos, ILogger } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+export declare function clone(options: {
+    /** wiki folder path, can be relative, should exist before function call */
+    dir: string;
+    /** the storage service url we are sync to, for example your github repo url */
+    remoteUrl?: string;
+    /** user info used in the commit message */
+    userInfo?: IGitUserInfos;
+    logger?: ILogger;
+    defaultGitInfo?: typeof defaultDefaultGitInfo;
+}): Promise<void>;
+//# sourceMappingURL=clone.d.ts.map

package/dist/src/clone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../../src/clone.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAW,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAG3E,wBAAsB,KAAK,CAAC,OAAO,EAAE;IACnC,2EAA2E;IAC3E,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,qBAAqB,CAAC;CAC/C,GAAG,OAAO,CAAC,IAAI,CAAC,CAqDhB"}

package/dist/src/clone.js

@@ -0,0 +1,55 @@
+import { GitProcess } from 'dugite';
+import { truncate } from 'lodash';
+import { credentialOn, credentialOff } from './credential';
+import { SyncParameterMissingError, GitPullPushError } from './errors';
+import { getRemoteName } from './inspect';
+import { GitStep } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+import { initGitWithBranch } from './init';
+export async function clone(options) {
+    const { dir, remoteUrl, userInfo, logger, defaultGitInfo = defaultDefaultGitInfo } = options;
+    const { gitUserName, branch } = userInfo ?? defaultGitInfo;
+    const { accessToken } = userInfo ?? {};
+    if (accessToken === '' || accessToken === undefined) {
+        throw new SyncParameterMissingError('accessToken');
+    }
+    if (remoteUrl === '' || remoteUrl === undefined) {
+        throw new SyncParameterMissingError('remoteUrl');
+    }
+    const logProgress = (step) => logger?.info(step, {
+        functionName: 'clone',
+        step,
+        dir,
+        remoteUrl,
+    });
+    const logDebug = (message, step) => logger?.debug(message, {
+        functionName: 'clone',
+        step,
+        dir,
+        remoteUrl,
+    });
+    logProgress(GitStep.PrepareCloneOnlineWiki);
+    logDebug(JSON.stringify({
+        remoteUrl,
+        gitUserName,
+        accessToken: truncate(accessToken, {
+            length: 24,
+        }),
+    }), GitStep.PrepareCloneOnlineWiki);
+    logDebug(`Running git init for clone in dir ${dir}`, GitStep.PrepareCloneOnlineWiki);
+    await initGitWithBranch(dir, branch, { initialCommit: false });
+    const remoteName = await getRemoteName(dir, branch);
+    logDebug(`Successfully Running git init for clone in dir ${dir}`, GitStep.PrepareCloneOnlineWiki);
+    logProgress(GitStep.StartConfiguringGithubRemoteRepository);
+    await credentialOn(dir, remoteUrl, gitUserName, accessToken, remoteName);
+    logProgress(GitStep.StartFetchingFromGithubRemote);
+    const { stderr: pullStdError, exitCode } = await GitProcess.exec(['pull', remoteName, `${branch}:${branch}`], dir);
+    await credentialOff(dir, remoteName, remoteUrl);
+    if (exitCode !== 0) {
+        throw new GitPullPushError(options, pullStdError);
+    }
+    else {
+        logProgress(GitStep.SynchronizationFinish);
+    }
+}
+//# sourceMappingURL=clone.js.map

package/dist/src/clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.js","sourceRoot":"","sources":["../../src/clone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAA0B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAS3B;IACC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAG,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAC7F,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,QAAQ,IAAI,cAAc,CAAC;IAC3D,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;IAEvC,IAAI,WAAW,KAAK,EAAE,IAAI,WAAW,KAAK,SAAS,EAAE;QACnD,MAAM,IAAI,yBAAyB,CAAC,aAAa,CAAC,CAAC;KACpD;IACD,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC/C,MAAM,IAAI,yBAAyB,CAAC,WAAW,CAAC,CAAC;KAClD;IAED,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;QACjB,YAAY,EAAE,OAAO;QACrB,IAAI;QACJ,GAAG;QACH,SAAS;KACV,CAAC,CAAC;IACL,MAAM,QAAQ,GAAG,CAAC,OAAe,EAAE,IAAa,EAAW,EAAE,CAC3D,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE;QACrB,YAAY,EAAE,OAAO;QACrB,IAAI;QACJ,GAAG;QACH,SAAS;KACV,CAAC,CAAC;IAEL,WAAW,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE5C,QAAQ,CACN,IAAI,CAAC,SAAS,CAAC;QACb,SAAS;QACT,WAAW;QACX,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE;YACjC,MAAM,EAAE,EAAE;SACX,CAAC;KACH,CAAC,EACF,OAAO,CAAC,sBAAsB,CAC/B,CAAC;IACF,QAAQ,CAAC,qCAAqC,GAAG,EAAE,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACrF,MAAM,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/D,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpD,QAAQ,CAAC,kDAAkD,GAAG,EAAE,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAClG,WAAW,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;IAC5D,MAAM,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACzE,WAAW,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;IACnH,MAAM,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;KACnD;SAAM;QACL,WAAW,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;KAC5C;AACH,CAAC"}

package/dist/src/commitAndSync.d.ts

@@ -0,0 +1,21 @@
+import { IGitUserInfos, ILogger } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+export interface ICommitAndSyncOptions {
+    /** wiki folder path, can be relative */
+    dir: string;
+    /** the storage service url we are sync to, for example your github repo url */
+    remoteUrl: string;
+    /** user info used in the commit message */
+    userInfo: IGitUserInfos;
+    /** the commit message */
+    commitMessage?: string;
+    logger?: ILogger;
+    defaultGitInfo?: typeof defaultDefaultGitInfo;
+    /** if you want to use a dynamic .gitignore, you can passing an array contains filepaths that want to ignore */
+    filesToIgnore?: string[];
+}
+/**
+ * `git add .` + `git commit` + `git rebase` or something that can sync bi-directional
+ */
+export declare function commitAndSync(options: ICommitAndSyncOptions): Promise<void>;
+//# sourceMappingURL=commitAndSync.d.ts.map

package/dist/src/commitAndSync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commitAndSync.d.ts","sourceRoot":"","sources":["../../src/commitAndSync.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAW,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAG3E,MAAM,WAAW,qBAAqB;IACpC,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,QAAQ,EAAE,aAAa,CAAC;IACxB,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,qBAAqB,CAAC;IAC9C,+GAA+G;IAC/G,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AACD;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA+IjF"}

package/dist/src/commitAndSync.js

@@ -0,0 +1,143 @@
+import { GitProcess } from 'dugite';
+import { credentialOn, credentialOff } from './credential';
+import { SyncParameterMissingError, GitPullPushError, CantSyncGitNotInitializedError } from './errors';
+import { assumeSync, getDefaultBranchName, getGitRepositoryState, getRemoteName, getSyncState, haveLocalChanges } from './inspect';
+import { GitStep } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+import { commitFiles, continueRebase, mergeUpstream, pushUpstream } from './sync';
+/**
+ * `git add .` + `git commit` + `git rebase` or something that can sync bi-directional
+ */
+export async function commitAndSync(options) {
+    const { dir, remoteUrl, commitMessage = 'Updated with Git-Sync', userInfo, logger, defaultGitInfo = defaultDefaultGitInfo, filesToIgnore } = options;
+    const { gitUserName, email, branch } = userInfo ?? defaultGitInfo;
+    const { accessToken } = userInfo ?? {};
+    if (accessToken === '' || accessToken === undefined) {
+        throw new SyncParameterMissingError('accessToken');
+    }
+    if (remoteUrl === '' || remoteUrl === undefined) {
+        throw new SyncParameterMissingError('remoteUrl');
+    }
+    const defaultBranchName = (await getDefaultBranchName(dir)) ?? branch;
+    const remoteName = await getRemoteName(dir, defaultBranchName);
+    const logProgress = (step) => logger?.info?.(step, {
+        functionName: 'commitAndSync',
+        step,
+        dir,
+        remoteUrl,
+        branch: defaultBranchName,
+    });
+    const logDebug = (message, step) => logger?.debug?.(message, {
+        functionName: 'commitAndSync',
+        step,
+        dir,
+        remoteUrl,
+        branch: defaultBranchName,
+    });
+    const logWarn = (message, step) => logger?.warn?.(message, {
+        functionName: 'commitAndSync',
+        step,
+        dir,
+        remoteUrl,
+        branch: defaultBranchName,
+    });
+    // preflight check
+    const repoStartingState = await getGitRepositoryState(dir, logger);
+    if (repoStartingState.length === 0 || repoStartingState === '|DIRTY') {
+        logProgress(GitStep.PrepareSync);
+        logDebug(`${dir} repoStartingState: ${repoStartingState}, ${gitUserName} <${email ?? defaultGitInfo.email}>`, GitStep.PrepareSync);
+    }
+    else if (repoStartingState === 'NOGIT') {
+        throw new CantSyncGitNotInitializedError(dir);
+    }
+    else {
+        // we may be in middle of a rebase, try fix that
+        await continueRebase(dir, gitUserName, email ?? defaultGitInfo.email, logger, repoStartingState);
+    }
+    if (await haveLocalChanges(dir)) {
+        logProgress(GitStep.HaveThingsToCommit);
+        logDebug(commitMessage, GitStep.HaveThingsToCommit);
+        const { exitCode: commitExitCode, stderr: commitStdError } = await commitFiles(dir, gitUserName, email ?? defaultGitInfo.email, commitMessage, filesToIgnore);
+        if (commitExitCode !== 0) {
+            logWarn(`commit failed ${commitStdError}`, GitStep.CommitComplete);
+        }
+        logProgress(GitStep.CommitComplete);
+    }
+    logProgress(GitStep.PreparingUserInfo);
+    await credentialOn(dir, remoteUrl, gitUserName, accessToken, remoteName);
+    logProgress(GitStep.FetchingData);
+    await GitProcess.exec(['fetch', remoteName, defaultBranchName], dir);
+    let exitCode = 0;
+    let stderr;
+    const syncStateAfterCommit = await getSyncState(dir, defaultBranchName, remoteName, logger);
+    switch (syncStateAfterCommit) {
+        case 'equal': {
+            logProgress(GitStep.NoNeedToSync);
+            await credentialOff(dir, remoteUrl);
+            return;
+        }
+        case 'noUpstreamOrBareUpstream': {
+            logProgress(GitStep.NoUpstreamCantPush);
+            // try push, if success, means it is bare, otherwise, it is no upstream
+            try {
+                await pushUpstream(dir, defaultBranchName, remoteName, logger);
+                break;
+            }
+            catch (error) {
+                logWarn(`${JSON.stringify({ dir, remoteUrl, userInfo })}, remoteUrl may be not valid, noUpstreamOrBareUpstream after credentialOn`, GitStep.NoUpstreamCantPush);
+                throw error;
+            }
+        }
+        case 'ahead': {
+            logProgress(GitStep.LocalAheadStartUpload);
+            await pushUpstream(dir, defaultBranchName, remoteName, logger);
+            break;
+        }
+        case 'behind': {
+            logProgress(GitStep.LocalStateBehindSync);
+            await mergeUpstream(dir, defaultBranchName, remoteName, logger);
+            break;
+        }
+        case 'diverged': {
+            logProgress(GitStep.LocalStateDivergeRebase);
+            ({ exitCode, stderr } = await GitProcess.exec(['rebase', `${remoteName}/${defaultBranchName}`], dir));
+            logProgress(GitStep.RebaseResultChecking);
+            if (exitCode !== 0) {
+                logWarn(`exitCode: ${exitCode}, stderr of git rebase: ${stderr}`, GitStep.RebaseResultChecking);
+            }
+            if (exitCode === 0 &&
+                (await getGitRepositoryState(dir, logger)).length === 0 &&
+                (await getSyncState(dir, defaultBranchName, remoteName, logger)) === 'ahead') {
+                logProgress(GitStep.RebaseSucceed);
+            }
+            else {
+                await continueRebase(dir, gitUserName, email ?? defaultGitInfo.email, logger);
+                logProgress(GitStep.RebaseConflictNeedsResolve);
+            }
+            await pushUpstream(dir, defaultBranchName, remoteName, logger);
+            break;
+        }
+        default: {
+            logProgress(GitStep.SyncFailedAlgorithmWrong);
+        }
+    }
+    await credentialOff(dir, remoteUrl);
+    if (exitCode === 0) {
+        logProgress(GitStep.PerformLastCheckBeforeSynchronizationFinish);
+        await assumeSync(dir, defaultBranchName, remoteName, logger);
+        logProgress(GitStep.SynchronizationFinish);
+    }
+    else {
+        switch (exitCode) {
+            // "message":"exitCode: 128, stderr of git push: fatal: unable to access 'https://github.com/tiddly-gittly/TiddlyWiki-Chinese-Tutorial.git/': LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection to github.com:443 \n"
+            case 128: {
+                throw new GitPullPushError(options, stderr ?? '');
+            }
+            // TODO: handle auth expire and throw here
+            default: {
+                throw new GitPullPushError(options, stderr ?? '');
+            }
+        }
+    }
+}
+//# sourceMappingURL=commitAndSync.js.map

package/dist/src/commitAndSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commitAndSync.js","sourceRoot":"","sources":["../../src/commitAndSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AACvG,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACnI,OAAO,EAA0B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAgBlF;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAA8B;IAChE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,GAAG,uBAAuB,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAG,qBAAqB,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IACrJ,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,IAAI,cAAc,CAAC;IAClE,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;IAEvC,IAAI,WAAW,KAAK,EAAE,IAAI,WAAW,KAAK,SAAS,EAAE;QACnD,MAAM,IAAI,yBAAyB,CAAC,aAAa,CAAC,CAAC;KACpD;IACD,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC/C,MAAM,IAAI,yBAAyB,CAAC,WAAW,CAAC,CAAC;KAClD;IACD,MAAM,iBAAiB,GAAG,CAAC,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC;IACtE,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IAE/D,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE;QACnB,YAAY,EAAE,eAAe;QAC7B,IAAI;QACJ,GAAG;QACH,SAAS;QACT,MAAM,EAAE,iBAAiB;KAC1B,CAAC,CAAC;IACL,MAAM,QAAQ,GAAG,CAAC,OAAe,EAAE,IAAa,EAAW,EAAE,CAC3D,MAAM,EAAE,KAAK,EAAE,CAAC,OAAO,EAAE;QACvB,YAAY,EAAE,eAAe;QAC7B,IAAI;QACJ,GAAG;QACH,SAAS;QACT,MAAM,EAAE,iBAAiB;KAC1B,CAAC,CAAC;IACL,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,IAAa,EAAW,EAAE,CAC1D,MAAM,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE;QACtB,YAAY,EAAE,eAAe;QAC7B,IAAI;QACJ,GAAG;QACH,SAAS;QACT,MAAM,EAAE,iBAAiB;KAC1B,CAAC,CAAC;IAEL,kBAAkB;IAClB,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACnE,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,KAAK,QAAQ,EAAE;QACpE,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjC,QAAQ,CAAC,GAAG,GAAG,uBAAuB,iBAAiB,KAAK,WAAW,KAAK,KAAK,IAAI,cAAc,CAAC,KAAK,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;KACpI;SAAM,IAAI,iBAAiB,KAAK,OAAO,EAAE;QACxC,MAAM,IAAI,8BAA8B,CAAC,GAAG,CAAC,CAAC;KAC/C;SAAM;QACL,gDAAgD;QAChD,MAAM,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC;KAClG;IACD,IAAI,MAAM,gBAAgB,CAAC,GAAG,CAAC,EAAE;QAC/B,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACpD,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,WAAW,CAC5E,GAAG,EACH,WAAW,EACX,KAAK,IAAI,cAAc,CAAC,KAAK,EAC7B,aAAa,EACb,aAAa,CACd,CAAC;QACF,IAAI,cAAc,KAAK,CAAC,EAAE;YACxB,OAAO,CAAC,iBAAiB,cAAc,EAAE,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;SACpE;QACD,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;KACrC;IACD,WAAW,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACvC,MAAM,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACzE,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAClC,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,CAAC;IACrE,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,MAA0B,CAAC;IAC/B,MAAM,oBAAoB,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5F,QAAQ,oBAAoB,EAAE;QAC5B,KAAK,OAAO,CAAC,CAAC;YACZ,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAClC,MAAM,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACpC,OAAO;SACR;QACD,KAAK,0BAA0B,CAAC,CAAC;YAC/B,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YACxC,uEAAuE;YACvE,IAAI;gBACF,MAAM,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;gBAC/D,MAAM;aACP;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CACL,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,2EAA2E,EAC1H,OAAO,CAAC,kBAAkB,CAC3B,CAAC;gBACF,MAAM,KAAK,CAAC;aACb;SACF;QACD,KAAK,OAAO,CAAC,CAAC;YACZ,WAAW,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;YAC3C,MAAM,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;YAC/D,MAAM;SACP;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,WAAW,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YAC1C,MAAM,aAAa,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;YAChE,MAAM;SACP;QACD,KAAK,UAAU,CAAC,CAAC;YACf,WAAW,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAC7C,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,GAAG,UAAU,IAAI,iBAAiB,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YACtG,WAAW,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YAC1C,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,CAAC,aAAa,QAAQ,2BAA2B,MAAM,EAAE,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;aACjG;YACD,IACE,QAAQ,KAAK,CAAC;gBACd,CAAC,MAAM,qBAAqB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC;gBACvD,CAAC,MAAM,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,KAAK,OAAO,EAC5E;gBACA,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;aACpC;iBAAM;gBACL,MAAM,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBAC9E,WAAW,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;aACjD;YACD,MAAM,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;YAC/D,MAAM;SACP;QACD,OAAO,CAAC,CAAC;YACP,WAAW,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;SAC/C;KACF;IACD,MAAM,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACpC,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,WAAW,CAAC,OAAO,CAAC,2CAA2C,CAAC,CAAC;QACjE,MAAM,UAAU,CAAC,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAC7D,WAAW,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;KAC5C;SAAM;QACL,QAAQ,QAAQ,EAAE;YAChB,yNAAyN;YACzN,KAAK,GAAG,CAAC,CAAC;gBACR,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;aACnD;YACD,0CAA0C;YAC1C,OAAO,CAAC,CAAC;gBACP,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;aACnD;SACF;KACF;AACH,CAAC"}

package/dist/{credential.d.ts → src/credential.d.ts}

@@ -1,15 +1,16 @@
+export declare const getGitUrlWithCredential: (rawUrl: string, username: string, accessToken: string) => string;
 /**
  *  Add remote with credential
  * @param {string} directory
  * @param {string} remoteUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export declare function credentialOn(directory: string, remoteUrl: string, userName: string, accessToken: string): Promise<void>;
+export declare function credentialOn(directory: string, remoteUrl: string, userName: string, accessToken: string, remoteName: string): Promise<void>;
 /**
  *  Add remote without credential
  * @param {string} directory
  * @param {string} githubRepoUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export declare function credentialOff(directory: string, remoteUrl?: string): Promise<void>;
+export declare function credentialOff(directory: string, remoteName: string, remoteUrl?: string): Promise<void>;
 //# sourceMappingURL=credential.d.ts.map

package/dist/src/credential.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credential.d.ts","sourceRoot":"","sources":["../../src/credential.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,uBAAuB,WAAY,MAAM,YAAY,MAAM,eAAe,MAAM,KAAG,MACkB,CAAC;AAGnH;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjJ;AACD;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI5G"}

package/dist/{credential.js → src/credential.js}

@@ -1,7 +1,7 @@
 import { trim } from 'lodash';
 import { GitProcess } from 'dugite';
 import { getRemoteUrl } from './inspect';
-const getGitUrlWithCredential = (rawUrl, username, accessToken) => trim(`${rawUrl}.git`.replace(/\n/g, '').replace('https://github.com/', `https://${username}:${accessToken}@github.com/`));
+export const getGitUrlWithCredential = (rawUrl, username, accessToken) => trim(rawUrl.replace(/\n/g, '').replace('https://github.com/', `https://${username}:${accessToken}@github.com/`));
 const getGitUrlWithOutCredential = (urlWithCredential) => trim(urlWithCredential.replace(/.+@/, 'https://'));
 /**
  *  Add remote with credential
@@ -9,10 +9,10 @@ const getGitUrlWithOutCredential = (urlWithCredential) => trim(urlWithCredential
  * @param {string} remoteUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export async function credentialOn(directory, remoteUrl, userName, accessToken) {
+export async function credentialOn(directory, remoteUrl, userName, accessToken, remoteName) {
     const gitUrlWithCredential = getGitUrlWithCredential(remoteUrl, userName, accessToken);
-    await GitProcess.exec(['remote', 'add', 'origin', gitUrlWithCredential], directory);
-    await GitProcess.exec(['remote', 'set-url', 'origin', gitUrlWithCredential], directory);
+    await GitProcess.exec(['remote', 'add', remoteName, gitUrlWithCredential], directory);
+    await GitProcess.exec(['remote', 'set-url', remoteName, gitUrlWithCredential], directory);
 }
 /**
  *  Add remote without credential
@@ -20,9 +20,9 @@ export async function credentialOn(directory, remoteUrl, userName, accessToken)
  * @param {string} githubRepoUrl
  * @param {{ login: string, email: string, accessToken: string }} userInfo
  */
-export async function credentialOff(directory, remoteUrl) {
-    const githubRepoUrl = remoteUrl ?? (await getRemoteUrl(directory));
+export async function credentialOff(directory, remoteName, remoteUrl) {
+    const githubRepoUrl = remoteUrl ?? (await getRemoteUrl(directory, remoteName));
     const gitUrlWithOutCredential = getGitUrlWithOutCredential(githubRepoUrl);
-    await GitProcess.exec(['remote', 'set-url', 'origin', gitUrlWithOutCredential], directory);
+    await GitProcess.exec(['remote', 'set-url', remoteName, gitUrlWithOutCredential], directory);
 }
 //# sourceMappingURL=credential.js.map

package/dist/src/credential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credential.js","sourceRoot":"","sources":["../../src/credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAc,EAAE,QAAgB,EAAE,WAAmB,EAAU,EAAE,CACvG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,WAAW,QAAQ,IAAI,WAAW,cAAc,CAAC,CAAC,CAAC;AACnH,MAAM,0BAA0B,GAAG,CAAC,iBAAyB,EAAU,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;AAE7H;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB,EAAE,SAAiB,EAAE,QAAgB,EAAE,WAAmB,EAAE,UAAkB;IAChI,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvF,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,oBAAoB,CAAC,EAAE,SAAS,CAAC,CAAC;IACtF,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,oBAAoB,CAAC,EAAE,SAAS,CAAC,CAAC;AAC5F,CAAC;AACD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAkB;IAC3F,MAAM,aAAa,GAAG,SAAS,IAAI,CAAC,MAAM,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IAC/E,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAC1E,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,SAAS,CAAC,CAAC;AAC/F,CAAC"}

package/dist/{defaultGitInfo.d.ts → src/defaultGitInfo.d.ts}

@@ -1,5 +1,7 @@
 export declare const defaultGitInfo: {
     email: string;
     gitUserName: string;
+    branch: string;
+    remote: string;
 };
 //# sourceMappingURL=defaultGitInfo.d.ts.map

package/dist/src/defaultGitInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultGitInfo.d.ts","sourceRoot":"","sources":["../../src/defaultGitInfo.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC"}

package/dist/{defaultGitInfo.js → src/defaultGitInfo.js}

@@ -1,5 +1,7 @@
 export const defaultGitInfo = {
     email: 'gitsync@gmail.com',
     gitUserName: 'gitsync',
+    branch: 'main',
+    remote: 'origin',
 };
 //# sourceMappingURL=defaultGitInfo.js.map

package/dist/src/defaultGitInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultGitInfo.js","sourceRoot":"","sources":["../../src/defaultGitInfo.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,SAAS;IACtB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,QAAQ;CACjB,CAAC"}

package/dist/{errors.d.ts → src/errors.d.ts}

@@ -1,6 +1,7 @@
+import { SyncState } from './inspect';
 import { IGitUserInfos, IGitUserInfosWithoutToken } from './interface';
 export declare class AssumeSyncError extends Error {
-    constructor(extraMessage?: string);
+    constructor(state: SyncState, extraMessage?: string);
 }
 export declare class SyncParameterMissingError extends Error {
     /** the missing parameterName */
@@ -13,8 +14,11 @@ export declare class GitPullPushError extends Error {
         dir: string;
         /** the storage service url we are sync to, for example your github repo url */
         remoteUrl?: string;
+        /** for example, origin */
+        remote?: string;
         /** user info used in the commit message */
         userInfo?: IGitUserInfos | IGitUserInfosWithoutToken;
+        branch?: string;
     }, extraMessages: string);
 }
 export declare class CantSyncGitNotInitializedError extends Error {

package/dist/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAEvE,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,KAAK,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,MAAM;CAQpD;AACD,qBAAa,yBAA0B,SAAQ,KAAK;IAClD,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;gBACV,aAAa,SAAgB;CAO1C;AAED,qBAAa,gBAAiB,SAAQ,KAAK;gBAEvC,aAAa,EAAE;QACb,wCAAwC;QACxC,GAAG,EAAE,MAAM,CAAC;QACZ,+EAA+E;QAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,0BAA0B;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,2CAA2C;QAC3C,QAAQ,CAAC,EAAE,aAAa,GAAG,yBAAyB,CAAC;QACrD,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,EACD,aAAa,EAAE,MAAM;CAexB;AAED,qBAAa,8BAA+B,SAAQ,KAAK;IACvD,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;gBACN,SAAS,EAAE,MAAM;CAO9B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;;CAOrD;AAED,qBAAa,sCAAuC,SAAQ,KAAK;IAC/D,YAAY,EAAE,MAAM,CAAC;gBACT,YAAY,EAAE,MAAM;CAOjC"}

package/dist/{errors.js → src/errors.js}

@@ -4,11 +4,11 @@
  */
 import { truncate } from 'lodash';
 export class AssumeSyncError extends Error {
-    constructor(extraMessage) {
+    constructor(state, extraMessage) {
         super(extraMessage);
         Object.setPrototypeOf(this, AssumeSyncError.prototype);
         this.name = 'AssumeSyncError';
-        this.message = `E-1 In this state, git should have been sync with the remote, but it is not, this is caused by procedural bug in the git-sync-js. ${extraMessage ?? ''}`;
+        this.message = `E-1 In this state, git should have been sync with the remote, but it is "${state}", this is caused by procedural bug in the git-sync-js. ${extraMessage ?? ''}`;
     }
 }
 export class SyncParameterMissingError extends Error {
@@ -19,7 +19,7 @@ export class SyncParameterMissingError extends Error {
         Object.setPrototypeOf(this, SyncParameterMissingError.prototype);
         this.name = 'SyncParameterMissingError';
         this.parameterName = parameterName;
-        this.message = `E-2 We need ${parameterName} to sync to the cloud, you should pass ${parameterName} as parameters in userInfo.`;
+        this.message = `E-2 We need ${parameterName} to sync to the cloud, you should pass ${parameterName} as parameters in options.`;
     }
 }
 export class GitPullPushError extends Error {
@@ -30,12 +30,12 @@ export class GitPullPushError extends Error {
         this.message = `E-3 failed to config git to successfully pull from or push to remote with configuration ${JSON.stringify({
             ...configuration,
             userInfo: {
-                ...(configuration.userInfo ?? {}),
+                ...configuration.userInfo,
                 accessToken: truncate(configuration?.userInfo?.accessToken, {
                     length: 24,
                 }),
             },
-        })}.\n${extraMessages}`;
+        })}.\nerrorMessages: ${extraMessages}`;
     }
 }
 export class CantSyncGitNotInitializedError extends Error {

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAIlC,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,KAAgB,EAAE,YAAqB;QACjD,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,4EAA4E,KAAK,2DAC9F,YAAY,IAAI,EAClB,EAAE,CAAC;IACL,CAAC;CACF;AACD,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,gCAAgC;IAChC,aAAa,CAAS;IACtB,YAAY,aAAa,GAAG,aAAa;QACvC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,eAAe,aAAa,0CAA0C,aAAa,4BAA4B,CAAC;IACjI,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YACE,aAUC,EACD,aAAqB;QAErB,KAAK,CAAC,aAAa,CAAC,CAAC;QACrB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,2FAA2F,IAAI,CAAC,SAAS,CAAC;YACvH,GAAG,aAAa;YAChB,QAAQ,EAAE;gBACR,GAAG,aAAa,CAAC,QAAQ;gBACzB,WAAW,EAAE,QAAQ,CAAE,aAAa,EAAE,QAA0B,EAAE,WAAW,EAAE;oBAC7E,MAAM,EAAE,EAAE;iBACX,CAAC;aACH;SACF,CAAC,qBAAqB,aAAa,EAAE,CAAC;IACzC,CAAC;CACF;AAED,MAAM,OAAO,8BAA+B,SAAQ,KAAK;IACvD,gDAAgD;IAChD,SAAS,CAAS;IAClB,YAAY,SAAiB;QAC3B,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,8BAA8B,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,6GAA6G,SAAS,EAAE,CAAC;IAC1I,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IACpD;QACE,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,6GAA6G,CAAC;IAC/H,CAAC;CACF;AAED,MAAM,OAAO,sCAAuC,SAAQ,KAAK;IAC/D,YAAY,CAAS;IACrB,YAAY,YAAoB;QAC9B,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAC9E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,wCAAwC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,qYAAqY,YAAY,EAAE,CAAC;IACra,CAAC;CACF"}

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+/** primary functions */
+export * from './initGit';
+export * from './commitAndSync';
+export * from './clone';
+/** utils */
+export * from './interface';
+export * from './defaultGitInfo';
+export * from './errors';
+export * from './credential';
+export * from './inspect';
+export * from './sync';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,YAAY;AACZ,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,12 @@
+/** primary functions */
+export * from './initGit';
+export * from './commitAndSync';
+export * from './clone';
+/** utils */
+export * from './interface';
+export * from './defaultGitInfo';
+export * from './errors';
+export * from './credential';
+export * from './inspect';
+export * from './sync';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,YAAY;AACZ,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC"}

package/dist/src/init.d.ts

@@ -0,0 +1,25 @@
+export interface IGitInitOptions {
+    /**
+     * Whether create a bare repo, useful as an upstream repo
+     */
+    bare?: boolean;
+    /**
+     * Default to true, to try to fix https://stackoverflow.com/questions/12267912/git-error-fatal-ambiguous-argument-head-unknown-revision-or-path-not-in-the
+     *
+     * Following techniques are not working:
+     *
+     * ```js
+     * await GitProcess.exec(['symbolic-ref', 'HEAD', `refs/heads/${branch}`], dir);
+     * await GitProcess.exec(['checkout', `-b`, branch], dir);
+     * ```
+     *
+     * This works:
+     * https://stackoverflow.com/a/51527691/4617295
+     */
+    initialCommit?: boolean;
+}
+/**
+ * Init and immediately checkout the branch, other wise the branch will be HEAD, which is annoying in the later steps
+ */
+export declare function initGitWithBranch(dir: string, branch?: string, options?: IGitInitOptions): Promise<void>;
+//# sourceMappingURL=init.d.ts.map

package/dist/src/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/init.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAwB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAY7H"}

package/dist/src/init.js

@@ -0,0 +1,22 @@
+import fs from 'fs-extra';
+import path from 'path';
+/* eslint-disable unicorn/prevent-abbreviations */
+import { GitProcess } from 'dugite';
+import { defaultGitInfo } from './defaultGitInfo';
+/**
+ * Init and immediately checkout the branch, other wise the branch will be HEAD, which is annoying in the later steps
+ */
+export async function initGitWithBranch(dir, branch = defaultGitInfo.branch, options) {
+    if (options?.bare === true) {
+        const bareGitPath = path.join(dir, '.git');
+        await fs.mkdirp(bareGitPath);
+        await GitProcess.exec(['init', `--initial-branch=${branch}`, '--bare'], bareGitPath);
+    }
+    else {
+        await GitProcess.exec(['init', `--initial-branch=${branch}`], dir);
+    }
+    if (options?.initialCommit !== false) {
+        await GitProcess.exec(['commit', `--allow-empty`, '-n', '-m', 'Initial commit when init a new git.'], dir);
+    }
+}
+//# sourceMappingURL=init.js.map

package/dist/src/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,kDAAkD;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAwBlD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,OAAyB;IAC5G,IAAI,OAAO,EAAE,IAAI,KAAK,IAAI,EAAE;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC3C,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7B,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,oBAAoB,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC;KACtF;SAAM;QACL,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,oBAAoB,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;KACpE;IAED,IAAI,OAAO,EAAE,aAAa,KAAK,KAAK,EAAE;QACpC,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,qCAAqC,CAAC,EAAE,GAAG,CAAC,CAAC;KAC5G;AACH,CAAC"}

package/dist/src/initGit.d.ts

@@ -0,0 +1,26 @@
+import { IGitUserInfosWithoutToken, IGitUserInfos, ILogger } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+export declare type IInitGitOptions = IInitGitOptionsSyncImmediately | IInitGitOptionsNotSync;
+export interface IInitGitOptionsSyncImmediately {
+    /** wiki folder path, can be relative */
+    dir: string;
+    /** should we sync after git init? */
+    syncImmediately: true;
+    /** only required if syncImmediately is true, the storage service url we are sync to, for example your github repo url */
+    remoteUrl: string;
+    /** user info used in the commit message */
+    userInfo: IGitUserInfos;
+    logger?: ILogger;
+    defaultGitInfo?: typeof defaultDefaultGitInfo;
+}
+export interface IInitGitOptionsNotSync {
+    /** wiki folder path, can be relative */
+    dir: string;
+    /** should we sync after git init? */
+    syncImmediately?: false;
+    userInfo?: IGitUserInfosWithoutToken | IGitUserInfos;
+    logger?: ILogger;
+    defaultGitInfo?: typeof defaultDefaultGitInfo;
+}
+export declare function initGit(options: IInitGitOptions): Promise<void>;
+//# sourceMappingURL=initGit.d.ts.map

package/dist/src/initGit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"initGit.d.ts","sourceRoot":"","sources":["../../src/initGit.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAE,OAAO,EAAW,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAI3E,oBAAY,eAAe,GAAG,8BAA8B,GAAG,sBAAsB,CAAC;AACtF,MAAM,WAAW,8BAA8B;IAC7C,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,eAAe,EAAE,IAAI,CAAC;IACtB,yHAAyH;IACzH,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,QAAQ,EAAE,aAAa,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,qBAAqB,CAAC;CAC/C;AACD,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,eAAe,CAAC,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,EAAE,yBAAyB,GAAG,aAAa,CAAC;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,qBAAqB,CAAC;CAC/C;AAED,wBAAsB,OAAO,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAsCrE"}

package/dist/src/initGit.js

@@ -0,0 +1,40 @@
+import { truncate } from 'lodash';
+import { SyncParameterMissingError } from './errors';
+import { initGitWithBranch } from './init';
+import { GitStep } from './interface';
+import { defaultGitInfo as defaultDefaultGitInfo } from './defaultGitInfo';
+import { commitFiles } from './sync';
+import { commitAndSync } from './commitAndSync';
+export async function initGit(options) {
+    const { dir, userInfo, syncImmediately, logger, defaultGitInfo = defaultDefaultGitInfo } = options;
+    const logProgress = (step) => logger?.info(step, {
+        functionName: 'initGit',
+        step,
+    });
+    const logDebug = (message, step) => logger?.debug(message, { functionName: 'initGit', step });
+    logProgress(GitStep.StartGitInitialization);
+    const { gitUserName, email, branch } = userInfo ?? defaultGitInfo;
+    logDebug(`Running git init in dir ${dir}`, GitStep.StartGitInitialization);
+    await initGitWithBranch(dir, branch);
+    logDebug(`Succefully Running git init in dir ${dir}`, GitStep.StartGitInitialization);
+    await commitFiles(dir, gitUserName, email ?? defaultGitInfo.email);
+    // if we are config local note git, we are done here
+    if (syncImmediately !== true) {
+        logProgress(GitStep.GitRepositoryConfigurationFinished);
+        return;
+    }
+    // sync to remote, start config synced note
+    if (userInfo === undefined || !('accessToken' in userInfo) || userInfo?.accessToken?.length === 0) {
+        throw new SyncParameterMissingError('accessToken');
+    }
+    const { remoteUrl } = options;
+    if (remoteUrl === undefined || remoteUrl.length === 0) {
+        throw new SyncParameterMissingError('remoteUrl');
+    }
+    logDebug(`Calling commitAndSync() from initGit() Using gitUrl ${remoteUrl} with gitUserName ${gitUserName} and accessToken ${truncate(userInfo?.accessToken, {
+        length: 24,
+    })}`, GitStep.StartConfiguringGithubRemoteRepository);
+    logProgress(GitStep.StartConfiguringGithubRemoteRepository);
+    await commitAndSync(options);
+}
+//# sourceMappingURL=initGit.js.map

package/dist/src/initGit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initGit.js","sourceRoot":"","sources":["../../src/initGit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAqD,OAAO,EAAE,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAyBhD,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAwB;IACpD,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,GAAG,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAEnG,MAAM,WAAW,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE;QACjB,YAAY,EAAE,SAAS;QACvB,IAAI;KACL,CAAC,CAAC;IACL,MAAM,QAAQ,GAAG,CAAC,OAAe,EAAE,IAAa,EAAW,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAExH,WAAW,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC5C,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,IAAI,cAAc,CAAC;IAClE,QAAQ,CAAC,2BAA2B,GAAG,EAAE,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC3E,MAAM,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACrC,QAAQ,CAAC,sCAAsC,GAAG,EAAE,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACtF,MAAM,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;IAEnE,oDAAoD;IACpD,IAAI,eAAe,KAAK,IAAI,EAAE;QAC5B,WAAW,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QACxD,OAAO;KACR;IACD,2CAA2C;IAC3C,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,aAAa,IAAI,QAAQ,CAAC,IAAI,QAAQ,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC,EAAE;QACjG,MAAM,IAAI,yBAAyB,CAAC,aAAa,CAAC,CAAC;KACpD;IACD,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAC9B,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QACrD,MAAM,IAAI,yBAAyB,CAAC,WAAW,CAAC,CAAC;KAClD;IACD,QAAQ,CACN,uDAAuD,SAAS,qBAAqB,WAAW,oBAAoB,QAAQ,CAAC,QAAQ,EAAE,WAAW,EAAE;QAClJ,MAAM,EAAE,EAAE;KACX,CAAC,EAAE,EACJ,OAAO,CAAC,sCAAsC,CAC/C,CAAC;IACF,WAAW,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;IAC5D,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC"}