feat: allow running tool in offline mode by setting --fetch-remote=false

Author: legobeat

src/command-line-arguments.ts

@@ -7,6 +7,7 @@ export type CommandLineArguments = {
   reset: boolean;
   backport: boolean;
   defaultBranch: string;
+  fetchRemote: boolean;
 };
 
 /**
@@ -51,6 +52,12 @@ export async function readCommandLineArguments(
       default: 'main',
       type: 'string',
     })
+    .option('fetch-remote', {
+      alias: 'f',
+      describe: 'Syncronizes local git references with remote',
+      default: true,
+      type: 'boolean',
+    })
     .help()
     .strict()
     .parse();

src/initial-parameters.ts

@@ -45,7 +45,10 @@ export async function determineInitialParameters({
   const args = await readCommandLineArguments(argv);
 
   const projectDirectoryPath = path.resolve(cwd, args.projectDirectory);
-  const project = await readProject(projectDirectoryPath, { stderr });
+  const project = await readProject(projectDirectoryPath, {
+    stderr,
+    fetchRemote: args.fetchRemote,
+  });
   const tempDirectoryPath =
     args.tempDirectory === undefined
       ? path.join(

src/project.ts

@@ -74,17 +74,18 @@ function examineReleaseVersion(packageVersion: SemVer): ReleaseVersion {
  * @param projectDirectoryPath - The path to the project.
  * @param args - Additional arguments.
  * @param args.stderr - A stream that can be used to write to standard error.
+ * @param args.fetchRemote - Whether to synchronize local tags with remote.
  * @returns An object that represents information about the project.
  * @throws if the project does not contain a root `package.json` (polyrepo and
  * monorepo) or if any of the workspaces specified in the root `package.json` do
  * not have `package.json`s (monorepo only).
  */
 export async function readProject(
   projectDirectoryPath: string,
-  { stderr }: { stderr: WriteStreamLike },
+  { fetchRemote, stderr }: { fetchRemote?: boolean; stderr: WriteStreamLike },
 ): Promise<Project> {
   const repositoryUrl = await getRepositoryHttpsUrl(projectDirectoryPath);
-  const tagNames = await getTagNames(projectDirectoryPath);
+  const tagNames = await getTagNames(projectDirectoryPath, fetchRemote);
   const rootPackage = await readMonorepoRootPackage({
     packageDirectoryPath: projectDirectoryPath,
     projectDirectoryPath,

src/repo.ts

@@ -256,13 +256,17 @@ export async function branchExists(
  * advised to only run this once.
  *
  * @param repositoryDirectoryPath - The path to the repository directory.
+ * @param fetchRemote - Whether to synchronize local tags with remote.
  * @returns The names of the tags.
  * @throws If no tags are found and the local git history is incomplete.
  */
 export async function getTagNames(
   repositoryDirectoryPath: string,
+  fetchRemote?: boolean,
 ): Promise<string[]> {
-  await runGitCommandWithin(repositoryDirectoryPath, 'fetch', ['--tags']);
+  if (typeof fetchRemote !== 'boolean' || fetchRemote) {
+    await runGitCommandWithin(repositoryDirectoryPath, 'fetch', ['--tags']);
+  }
 
   const tagNames = await getLinesFromGitCommandWithin(
     repositoryDirectoryPath,