feat: platform=local

lib/config/presets/local/index.ts

@@ -24,6 +24,7 @@ const resolvers = {
   gitea,
   github,
   gitlab,
+  local: null,
 } satisfies Record<PlatformId, Resolver | null>;
 
 export function getPreset({

lib/constants/platforms.ts

@@ -5,7 +5,8 @@ export type PlatformId =
   | 'bitbucket-server'
   | 'gitea'
   | 'github'
-  | 'gitlab';
+  | 'gitlab'
+  | 'local';
 
 export const GITHUB_API_USING_HOST_TYPES = [
   'github',

lib/modules/platform/api.ts

@@ -6,6 +6,7 @@ import * as codecommit from './codecommit';
 import * as gitea from './gitea';
 import * as github from './github';
 import * as gitlab from './gitlab';
+import * as local from './local';
 import type { Platform } from './types';
 
 const api = new Map<PlatformId, Platform>();
@@ -18,3 +19,4 @@ api.set(codecommit.id, codecommit);
 api.set(gitea.id, gitea);
 api.set(github.id, github);
 api.set(gitlab.id, gitlab);
+api.set(local.id, local);

lib/modules/platform/local/index.ts

@@ -0,0 +1,124 @@
+/* istanbul ignore file */
+import type { BranchStatus } from '../../../types';
+import type {
+  Issue,
+  PlatformParams,
+  PlatformResult,
+  Pr,
+  RepoResult,
+} from '../types';
+
+export const id = 'local';
+
+export function initPlatform(params: PlatformParams): Promise<PlatformResult> {
+  return Promise.resolve({
+    dryRun: 'lookup',
+    endpoint: 'local',
+    persistRepoData: true,
+    requireConfig: 'optional',
+  });
+}
+
+export function getRepos(): Promise<string[]> {
+  return Promise.resolve([]);
+}
+
+export function initRepo(): Promise<RepoResult> {
+  return Promise.resolve({
+    defaultBranch: '',
+    isFork: false,
+    repoFingerprint: '',
+  });
+}
+
+export function getRepoForceRebase(): Promise<boolean> {
+  return Promise.resolve(false);
+}
+
+export function findIssue(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function getIssueList(): Promise<Issue[]> {
+  return Promise.resolve([]);
+}
+
+export function getRawFile(): Promise<string | null> {
+  return Promise.resolve(null);
+}
+
+export function getJsonFile(): Promise<Record<string, unknown> | null> {
+  return Promise.resolve(null);
+}
+
+export function getPrList(): Promise<Pr[]> {
+  return Promise.resolve([]);
+}
+
+export function ensureIssueClosing(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function ensureIssue(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function massageMarkdown(input: string): string {
+  return input;
+}
+
+export function updatePr(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function mergePr(): Promise<boolean> {
+  return Promise.resolve(false);
+}
+
+export function addReviewers(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function addAssignees(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function createPr(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function deleteLabel(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function setBranchStatus(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function getBranchStatus(): Promise<BranchStatus> {
+  return Promise.resolve('red');
+}
+
+export function getBranchStatusCheck(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function ensureCommentRemoval(): Promise<void> {
+  return Promise.resolve();
+}
+
+export function ensureComment(): Promise<boolean> {
+  return Promise.resolve(false);
+}
+
+export function getPr(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function findPr(): Promise<null> {
+  return Promise.resolve(null);
+}
+
+export function getBranchPr(): Promise<null> {
+  return Promise.resolve(null);
+}

lib/modules/platform/local/scm.ts

@@ -0,0 +1,46 @@
+/* istanbul ignore file */
+import { glob } from 'glob';
+import type { CommitFilesConfig, CommitSha } from '../../../util/git/types';
+import type { PlatformScm } from '../types';
+
+let fileList: string[] | undefined;
+export class LocalFs implements PlatformScm {
+  fileList: string[] | undefined;
+
+  isBranchBehindBase(branchName: string, baseBranch: string): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+  isBranchModified(branchName: string): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+  isBranchConflicted(baseBranch: string, branch: string): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+  branchExists(branchName: string): Promise<boolean> {
+    return Promise.resolve(true);
+  }
+  getBranchCommit(branchName: string): Promise<string | null> {
+    return Promise.resolve(null);
+  }
+  deleteBranch(branchName: string): Promise<void> {
+    return Promise.resolve();
+  }
+  commitAndPush(commitConfig: CommitFilesConfig): Promise<string | null> {
+    return Promise.resolve(null);
+  }
+
+  async getFileList(): Promise<string[]> {
+    fileList ??= await glob('**', {
+      dot: true,
+      nodir: true,
+      ignore: {
+        childrenIgnored: (p) => p.isNamed('.git') || p.isNamed('node_modules'),
+      },
+    });
+    return fileList;
+  }
+
+  checkoutBranch(branchName: string): Promise<CommitSha> {
+    return Promise.resolve('');
+  }
+}

lib/modules/platform/scm.ts

@@ -3,6 +3,7 @@ import type { PlatformId } from '../../constants';
 import { PLATFORM_NOT_FOUND } from '../../constants/error-messages';
 import { DefaultGitScm } from './default-scm';
 import { GithubScm } from './github/scm';
+import { LocalFs } from './local/scm';
 import type { PlatformScm } from './types';
 
 export const platformScmImpls = new Map<PlatformId, Constructor<PlatformScm>>();
@@ -13,6 +14,7 @@ platformScmImpls.set('bitbucket-server', DefaultGitScm);
 platformScmImpls.set('gitea', DefaultGitScm);
 platformScmImpls.set('github', GithubScm);
 platformScmImpls.set('gitlab', DefaultGitScm);
+platformScmImpls.set('local', LocalFs);
 
 let _scm: PlatformScm | undefined;
 

lib/util/fs/index.spec.ts

@@ -134,6 +134,11 @@ describe('util/fs/index', () => {
   });
 
   describe('deleteLocalFile', () => {
+    it('throws if platform is local', async () => {
+      GlobalConfig.set({ platform: 'local' });
+      await expect(deleteLocalFile('foo/bar/file.txt')).rejects.toThrow();
+    });
+
     it('deletes file', async () => {
       const filePath = `${localDir}/foo/bar/file.txt`;
       await fs.outputFile(filePath, 'foobar');

lib/util/fs/index.ts

@@ -65,6 +65,10 @@ export async function writeLocalFile(
 }
 
 export async function deleteLocalFile(fileName: string): Promise<void> {
+  // This a failsafe and hopefully will never be triggered
+  if (GlobalConfig.get('platform') === 'local') {
+    throw new Error('Cannot delete file when platform=local');
+  }
   const localDir = GlobalConfig.get('localDir');
   if (localDir) {
     const localFileName = ensureLocalPath(fileName);

lib/util/git/index.ts

@@ -379,6 +379,10 @@ export async function syncGit(): Promise<void> {
   if (gitInitialized) {
     return;
   }
+  // istanbul ignore if: failsafe
+  if (GlobalConfig.get('platform') === 'local') {
+    throw new Error('Cannot sync git when platform=local');
+  }
   gitInitialized = true;
   const localDir = GlobalConfig.get('localDir')!;
   logger.debug(`Initializing git repository into ${localDir}`);

lib/workers/global/autodiscover.spec.ts

@@ -25,6 +25,12 @@ describe('workers/global/autodiscover', () => {
     });
   });
 
+  it('throws if local and repositories defined', async () => {
+    config.platform = 'local';
+    config.repositories = ['a'];
+    await expect(autodiscoverRepositories(config)).rejects.toThrow();
+  });
+
   it('returns if not autodiscovering', async () => {
     expect(await autodiscoverRepositories(config)).toEqual(config);
   });

lib/workers/global/autodiscover.ts

@@ -13,6 +13,18 @@ function repoName(value: string | { repository: string }): string {
 export async function autodiscoverRepositories(
   config: AllConfig
 ): Promise<AllConfig> {
+  if (config.platform === 'local') {
+    if (config.repositories?.length) {
+      logger.debug(
+        { repositories: config.repositories },
+        'Found repositories when in local mode'
+      );
+      throw new Error(
+        'Invalid configuration: repositories list not supported when platform=local'
+      );
+    }
+    config.repositories = ['local'];
+  }
   if (!config.autodiscover) {
     if (!config.repositories?.length) {
       logger.warn(

lib/workers/global/index.ts

@@ -37,10 +37,13 @@ export async function getRepositoryConfig(
   );
   // TODO: types (#7154)
   const platform = GlobalConfig.get('platform')!;
-  repoConfig.localDir = upath.join(
-    repoConfig.baseDir,
-    `./repos/${platform}/${repoConfig.repository}`
-  );
+  repoConfig.localDir =
+    platform === 'local'
+      ? process.cwd()
+      : upath.join(
+          repoConfig.baseDir,
+          `./repos/${platform}/${repoConfig.repository}`
+        );
   await fs.ensureDir(repoConfig.localDir);
   delete repoConfig.baseDir;
   return configParser.filterConfig(repoConfig, 'repository');

lib/workers/repository/process/index.ts

@@ -108,7 +108,7 @@ export async function extractDependencies(
     branchList: [],
     packageFiles: null!,
   };
-  if (config.baseBranches?.length) {
+  if (GlobalConfig.get('platform') !== 'local' && config.baseBranches?.length) {
     config.baseBranches = unfoldBaseBranches(config.baseBranches);
     logger.debug({ baseBranches: config.baseBranches }, 'baseBranches');
     const extracted: Record<string, Record<string, PackageFile[]>> = {};

package.json

@@ -196,6 +196,7 @@
     "global-agent": "3.0.0",
     "good-enough-parser": "1.1.22",
     "got": "11.8.6",
+    "glob": "10.2.2",
     "graph-data-structure": "3.3.0",
     "handlebars": "4.7.7",
     "hasha": "5.2.2",
@@ -307,7 +308,6 @@
     "eslint-plugin-promise": "6.1.1",
     "eslint-plugin-typescript-enum": "2.1.0",
     "expect-more-jest": "5.5.0",
-    "glob": "10.2.2",
     "graphql": "16.6.0",
     "husky": "8.0.3",
     "jest": "29.5.0",