Fix command line flags for cache

Author: Your Name

.github/workflows/ci.yml

@@ -87,7 +87,7 @@ jobs:
       - name: Download tools
         run: |
           yarn --frozen-lockfile --ignore-scripts --prefer-offline
-          yarn download-tools --target ${{ matrix.target }}
+          yarn download-tools --target ${{ matrix.target }} --no-cache
 
       - name: Create vsix package
         run: |

DEVELOPMENT.md

@@ -13,7 +13,8 @@
 
 ## Building
 
-Major parts are platform independent but due to the inclusion of binary tools the resulting packages become platform-specific, i.e. for on `<target>`.
+Major parts are platform independent but due to the inclusion of binary tools the resulting
+packages become platform-specific, i.e. for on `<target>`.
 
 Supported `<target>`s are:
 
@@ -24,7 +25,8 @@ Supported `<target>`s are:
 - darwin-x64 (MacOS, Intel, x86-64)
 - darwin-arm64 (MacOS, Arm, aarch64)
 
-1. Open a terminal and execute the following command to download NPM dependencies and tools, and to build the Typescript code:
+1. Open a terminal and execute the following command to download NPM dependencies and tools, and
+   to build the Typescript code:
 
     ```sh
     > yarn
@@ -33,10 +35,12 @@ Supported `<target>`s are:
 2. Download binary tools
 
     ```sh
-    > yarn download-tools [--target <target>]
+    > yarn download-tools [--target <target>] [--no-cache]
     ```
 
     If no `<target>` is specified the local system's architecture is used by default.
+    By default, tool downloads are cached in the yarn cache (see `yarn cache dir`) to prevent
+    recurring downloads of exact same archives on clean builds.
 
 3. Package the extension as a locally installable VSIX file:
 
@@ -46,13 +50,16 @@ Supported `<target>`s are:
 
 ## Developing
 
-1. If you are developing and debugging this extension, we recommend you run the following command after an initial build:
+1. If you are developing and debugging this extension, we recommend you run the following command
+   after an initial build:
 
     ```sh
     > yarn watch
     ```
 
-    While just calling `yarn` creates a production build of the extension, running the above creates a build dedicated for debug. Additionally, it sets up a watch which detects code changes and rebuilds them incrementally.
+    While just calling `yarn` creates a production build of the extension, running the above
+    creates a build dedicated for debug. Additionally, it sets up a watch which detects code
+    changes and rebuilds them incrementally.
 
 2. Switch to the VS Code `Run and Debug` view.
 

scripts/download-tools.ts

@@ -101,7 +101,7 @@ async function retrieveSha256(url?: string, token?: string) {
 }
 
 async function download(url: string, options?: ToolOptions & { cache_key?: string }) {
-    const cachePath = (options?.cache && options?.cache_key) ? path.join(options.cache, options.cache_key): undefined;
+    const cachePath = (options?.cache && options?.cache_key) ? path.join(options.cache, options.cache_key) : undefined;
     if (cachePath && existsSync(cachePath)) {
         console.debug(`Found asset in cache ${cachePath} ...`);
         return { mode: 'cache', path: cachePath};
@@ -170,7 +170,12 @@ async function downloadPyOCD(target: VsceTarget, dest: string, options?: ToolOpt
         }
     }
 
-    const { mode, path: extractPath } = await download(asset.url, { token: githubToken, cache: options?.cache, cache_key: `cmsis-pyocd-${version}-${sha256sum}` });
+    const dloptions = { 
+        token: githubToken, 
+        cache: options?.cache, 
+        cache_key: sha256sum ? `cmsis-pyocd-${version}-${sha256sum}` : undefined
+    };
+    const { mode, path: extractPath } = await download(asset.url, dloptions);
 
     if (existsSync(destPath)) {
         console.debug(`Removing existing ${destPath} ...`);
@@ -197,7 +202,7 @@ async function main() {
     const yarnCacheDir = execSync('yarn cache dir').toString().trim();
     console.debug(`Yarn cache directory: ${yarnCacheDir}`);
 
-    const { target, dest, cache, cache_disable, tools } = yargs
+    const { target, dest, cache, tools } = yargs
         .option('t', {
             alias: 'target',
             description: 'VS Code extension target, defaults to system',
@@ -214,11 +219,6 @@ async function main() {
             description: 'Directory for caching tool downloads',
             default: yarnCacheDir
         })
-        .option('no-cache', {
-            description: 'Disable caching of tool downloads',
-            type: 'boolean',
-            default: false
-        })
         .version(false)
         .strict()
         .command('$0 [<tools> ...]', 'Downloads the tool(s) for the given architecture and OS', y => {
@@ -229,14 +229,23 @@ async function main() {
                 default: Object.keys(TOOLS)
             });
         })
-        .argv as unknown as { target: VsceTarget, dest: string, cache: string, cache_disable: boolean, tools: (keyof typeof TOOLS)[] };
+        .argv as unknown as { target: VsceTarget, dest: string, cache: string | boolean, tools: (keyof typeof TOOLS)[] };
 
     if (!existsSync(dest)) {
         mkdirSync(dest, { recursive: true });
     }
 
+    const cacheFolder = (cache: string | boolean) => {
+        if (typeof cache === 'string') {
+            return cache;
+        } else if(cache === true) {
+            return yarnCacheDir;
+        }
+        return undefined;
+    }
+
     for (const tool of new Set(tools)) {
-        TOOLS[tool](target, dest, { cache: cache_disable ? undefined : cache });
+        TOOLS[tool](target, dest, { cache: cacheFolder(cache) });
     }
 }