Move githubREST constants and update cache generation

Signed-off-by: paulober <[email protected]>

Author: paulober

src/commands/switchSDK.mts

@@ -9,7 +9,6 @@ import {
 import type UI from "../ui.mjs";
 import { updateVSCodeStaticConfigs } from "../utils/vscodeConfigUtil.mjs";
 import {
-  SDK_REPOSITORY_URL,
   getCmakeReleases,
   getNinjaReleases,
   getSDKReleases,
@@ -39,6 +38,7 @@ import { NINJA_AUTO_INSTALL_DISABLED } from "../webview/newProjectPanel.mjs";
 import Logger from "../logger.mjs";
 import type { Progress as GotProgress } from "got";
 import { SWITCH_SDK } from "./cmdIds.mjs";
+import { SDK_REPOSITORY_URL } from "../utils/sharedConstants.mjs";
 
 const DEFAULT_PICOTOOL_VERSION = "2.2.0-a4";
 

src/extension.mts

@@ -64,7 +64,6 @@ import {
   downloadAndInstallPicotool,
   downloadAndInstallOpenOCD,
 } from "./utils/download.mjs";
-import { SDK_REPOSITORY_URL } from "./utils/githubREST.mjs";
 import { getSupportedToolchains } from "./utils/toolchainUtil.mjs";
 import {
   NewProjectPanel,
@@ -103,6 +102,7 @@ import { NewRustProjectPanel } from "./webview/newRustProjectPanel.mjs";
 import {
   CMAKELISTS_ZEPHYR_HEADER,
   OPENOCD_VERSION,
+  SDK_REPOSITORY_URL,
 } from "./utils/sharedConstants.mjs";
 import VersionBundlesLoader from "./utils/versionBundles.mjs";
 import { unknownErrorToString } from "./utils/errorHelper.mjs";

src/utils/download.mts

@@ -23,7 +23,6 @@ import which from "which";
 import { Uri, window, workspace } from "vscode";
 import {
   type GithubReleaseAssetData,
-  GithubRepository,
   getGithubReleaseByTag,
   getAuthorizationHeaders,
   ownerOfRepository,
@@ -40,6 +39,7 @@ import {
   EXT_USER_AGENT,
   GITHUB_API_BASE_URL,
   GITHUB_API_VERSION,
+  GithubRepository,
   HTTP_STATUS_FORBIDDEN,
   HTTP_STATUS_OK,
   HTTP_STATUS_UNAUTHORIZED,

src/utils/githubApiCache.mts

@@ -1,14 +1,17 @@
 // TODO: put defaults into json file, to prevent need for these disables
 import type { ExtensionContext, Memento, Uri } from "vscode";
-import type { GithubReleaseResponse, GithubRepository } from "./githubREST.mjs";
+import type { GithubReleaseResponse } from "./githubREST.mjs";
 import Logger, { LoggerSource } from "../logger.mjs";
 import { getDataRoot } from "./downloadHelpers.mjs";
 import { get } from "https";
 import { isInternetConnected } from "./downloadHelpers.mjs";
 import { join as joinPosix } from "path/posix";
 import { readFileSync } from "fs";
 import { unknownErrorToString } from "./errorHelper.mjs";
-import { CURRENT_DATA_VERSION } from "./sharedConstants.mjs";
+import {
+  CURRENT_DATA_VERSION,
+  type GithubRepository,
+} from "./sharedConstants.mjs";
 
 /**
  * Tells if the stored data is a GithubReleaseResponse (data of a specific release)

src/utils/githubREST.mts

@@ -10,23 +10,13 @@ import {
   EXT_USER_AGENT,
   GITHUB_API_BASE_URL,
   GITHUB_API_VERSION,
+  GithubRepository,
   HTTP_STATUS_FORBIDDEN,
   HTTP_STATUS_NOT_MODIFIED,
   HTTP_STATUS_OK,
   HTTP_STATUS_UNAUTHORIZED,
 } from "./sharedConstants.mjs";
 
-/**
- * Enum containing supported repositories on GitHub.
- */
-export enum GithubRepository {
-  picoSDK = 0,
-  cmake = 1,
-  ninja = 2,
-  tools = 3,
-  picotool = 4,
-}
-
 /**
  * Interface for a response from the GitHub REST API
  * release endpoint.
@@ -46,12 +36,6 @@ export type GithubReleaseAssetData = {
   id: number;
 };
 
-// NOTE: The primary rate limit for unauthenticated requests is 60 requests per hour.
-export const SDK_REPOSITORY_URL = "https://github.com/raspberrypi/pico-sdk.git";
-export const NINJA_REPOSITORY_URL = "https://github.com/ninja-build/ninja.git";
-export const CMAKE_REPOSITORY_URL = "https://github.com/Kitware/CMake.git";
-export const PYENV_REPOSITORY_URL = "https://github.com/pyenv/pyenv.git";
-
 /**
  * Get the url friendly owner of a repository on GitHub.
  *

src/utils/pyenvUtil.mts

@@ -1,12 +1,14 @@
 import { homedir } from "os";
 import { cloneRepository } from "./gitUtil.mjs";
-import { PYENV_REPOSITORY_URL } from "./githubREST.mjs";
 import { join as joinPosix } from "path/posix";
 import { exec } from "child_process";
 import { buildPython3Path } from "./download.mjs";
 import { HOME_VAR } from "../settings.mjs";
 import { existsSync, mkdirSync, symlinkSync } from "fs";
-import { CURRENT_PYTHON_VERSION } from "./sharedConstants.mjs";
+import {
+  CURRENT_PYTHON_VERSION,
+  PYENV_REPOSITORY_URL,
+} from "./sharedConstants.mjs";
 
 export function buildPyenvPath(): string {
   // TODO: maybe replace . with _

src/utils/rustUtil.mts

@@ -12,13 +12,12 @@ import {
   downloadAndInstallToolchain,
 } from "./download.mjs";
 import { getSupportedToolchains } from "./toolchainUtil.mjs";
-import { SDK_REPOSITORY_URL } from "./githubREST.mjs";
 import findPython, { showPythonNotFoundError } from "./pythonHelper.mjs";
 import VersionBundlesLoader from "./versionBundles.mjs";
 import { HOME_VAR } from "../settings.mjs";
 import { homedir } from "os";
 import type { Progress } from "got";
-import { OPENOCD_VERSION } from "./sharedConstants.mjs";
+import { OPENOCD_VERSION, SDK_REPOSITORY_URL } from "./sharedConstants.mjs";
 
 /*const STABLE_INDEX_DOWNLOAD_URL =
   "https://static.rust-lang.org/dist/channel-rust-stable.toml";*/

src/utils/setupZephyr.mts

@@ -29,12 +29,12 @@ import {
   CURRENT_WGET_VERSION,
   LICENSE_URL_7ZIP,
   OPENOCD_VERSION,
+  SDK_REPOSITORY_URL,
   WINDOWS_X86_7ZIP_DOWNLOAD_URL,
   WINDOWS_X86_DTC_DOWNLOAD_URL,
   WINDOWS_X86_GPERF_DOWNLOAD_URL,
   WINDOWS_X86_WGET_DOWNLOAD_URL,
 } from "./sharedConstants.mjs";
-import { SDK_REPOSITORY_URL } from "./githubREST.mjs";
 import { vsExists } from "./vsHelpers.mjs";
 import which from "which";
 import { stdoutToString, unknownErrorToString } from "./errorHelper.mjs";

src/utils/sharedConstants.mts

@@ -48,3 +48,20 @@ export const HTTP_STATUS_FORBIDDEN = 403;
 export const EXT_USER_AGENT = "Raspberry Pi Pico VS Code Extension";
 export const GITHUB_API_BASE_URL = "https://api.github.com";
 export const GITHUB_API_VERSION = "2022-11-28";
+
+/**
+ * Enum containing supported repositories on GitHub.
+ */
+export enum GithubRepository {
+  picoSDK = 0,
+  cmake = 1,
+  ninja = 2,
+  tools = 3,
+  picotool = 4,
+}
+
+// NOTE: The primary rate limit for unauthenticated requests is 60 requests per hour.
+export const SDK_REPOSITORY_URL = "https://github.com/raspberrypi/pico-sdk.git";
+export const NINJA_REPOSITORY_URL = "https://github.com/ninja-build/ninja.git";
+export const CMAKE_REPOSITORY_URL = "https://github.com/Kitware/CMake.git";
+export const PYENV_REPOSITORY_URL = "https://github.com/pyenv/pyenv.git";

src/webview/newProjectPanel.mts

@@ -25,7 +25,6 @@ import {
   getSupportedToolchains,
 } from "../utils/toolchainUtil.mjs";
 import {
-  SDK_REPOSITORY_URL,
   getCmakeReleases,
   getNinjaReleases,
   getPicotoolReleases,
@@ -60,7 +59,10 @@ import {
 import { stdoutToString, unknownErrorToString } from "../utils/errorHelper.mjs";
 import type { Progress as GotProgress } from "got";
 import findPython, { showPythonNotFoundError } from "../utils/pythonHelper.mjs";
-import { OPENOCD_VERSION } from "../utils/sharedConstants.mjs";
+import {
+  OPENOCD_VERSION,
+  SDK_REPOSITORY_URL,
+} from "../utils/sharedConstants.mjs";
 import { BoardType } from "./sharedEnums.mjs";
 import { getSystemNinjaVersion } from "../utils/ninjaUtil.mjs";
 import { getSystemCmakeVersion } from "../utils/cmakeUtil.mjs";