Function sanitizeStorageKey

src/node/services/workspaceProjectRepos.ts:43–70

(projectName: string, projectPath: string)

}

function sanitizeStorageKey(projectName: string, projectPath: string): string {
  const sanitize = (value: string) =>
    value
      .split("")
      .map((char) => {
        const isForbiddenPathChar = '<>:"/\\|?*'.includes(char);
        return isForbiddenPathChar || char.charCodeAt(0) < 32 ? "-" : char;
      })
      .join("")
      .trim();

  const sanitizedProjectName = sanitize(projectName);
  const fallbackProjectName =
    sanitize(PlatformPaths.getProjectName(projectPath).trim()) || "project";
  const storageKey =
    sanitizedProjectName.length > 0 && sanitizedProjectName !== "." && sanitizedProjectName !== ".."
      ? sanitizedProjectName
      : fallbackProjectName;

  assert(!path.isAbsolute(storageKey), "getWorkspaceProjectRepos: storageKey must stay relative");
  assert(
    !storageKey.includes(path.sep) && !storageKey.includes(path.posix.sep),
    "getWorkspaceProjectRepos: storageKey must not contain path separators"
  );
  assert(storageKey !== "." && storageKey !== "..", "getWorkspaceProjectRepos: invalid storageKey");

  return storageKey;
}

function appendStorageKeySuffix(storageKey: string, suffix: number): string {
  assert(Number.isInteger(suffix) && suffix >= 2, "appendStorageKeySuffix: suffix must be >= 2");