zarro 1.170.12 → 1.170.16

package/gulp-tasks/modules/dotnet-cli.js

@@ -16,6 +16,7 @@
     const readNuspecVersion = requireModule("read-nuspec-version");
     const log = requireModule("log");
     const env = requireModule("env");
+    const Version = requireModule("version");
     const emojiLabels = {
         testing: `🧪 Testing`,
         packing: `📦 Packing`,
@@ -669,14 +670,13 @@ WARNING: 'dotnet pack' ignores --version-suffix when a nuspec file is provided.
     }
     async function runDotNetWith(args, opts) {
         try {
-            const result = await system("dotnet", args, {
+            return await system("dotnet", args, {
                 stdout: opts.stdout,
                 stderr: opts.stderr,
                 suppressOutput: opts.suppressOutput,
                 suppressStdIoInErrors: opts.suppressStdIoInErrors,
                 env: opts.env
             });
-            return result;
         }
         catch (e) {
             if (opts.suppressErrors) {
@@ -754,6 +754,76 @@ WARNING: 'dotnet pack' ignores --version-suffix when a nuspec file is provided.
             usingFallback
         });
     }
+    async function searchPackages(options) {
+        if (!options) {
+            throw new Error(`No options or search string provided`);
+        }
+        const opts = typeof options === "string"
+            ? { search: options }
+            : options;
+        const args = ["package", "search"];
+        pushIfSet(args, opts.source, "--source");
+        pushFlag(args, opts.exactMatch, "--exact-match");
+        pushFlag(args, opts.preRelease, "--prerelease");
+        pushIfSet(args, opts.configFile, "--configfile");
+        args.push("--format", "json");
+        if (opts.search) {
+            args.push(opts.search);
+        }
+        const stdout = [];
+        opts.stdout = (s) => stdout.push(s);
+        opts.suppressOutput = true;
+        const rawResult = await runDotNetWith(args, opts);
+        if (system.isError(rawResult)) {
+            throw rawResult;
+        }
+        const allText = stdout.join(" "), parsed = JSON.parse(allText);
+        const finalResult = [];
+        const limit = opts.take || Number.MAX_VALUE;
+        for (const sourceResult of parsed.searchResult) {
+            for (const pkg of sourceResult.packages) {
+                finalResult.push({
+                    id: pkg.id,
+                    version: new Version(pkg.latestVersion),
+                    source: sourceResult.sourceName
+                });
+            }
+        }
+        // dotnet package search takes in skip and take parameters,
+        // but there are some potential issues:
+        // 1. when searching for an exact match, it dotnet doesn't apply skip/take
+        //    - so we'd have to do it ourselves anyway
+        // 2. dotnet returns results in ascending version order
+        //    - where the most useful, especially for paging, is reverse-ordered
+        finalResult.sort((a, b) => a.version.compareWith(b.version)).reverse();
+        const skip = opts.skip || 0;
+        if (skip > 0) {
+            finalResult.splice(0, skip);
+        }
+        if (finalResult.length > limit) {
+            finalResult.splice(limit);
+        }
+        return finalResult;
+    }
+    async function installPackage(opts) {
+        if (!opts) {
+            throw new Error(`no options passed to 'installPackage' - target project and package name not specified`);
+        }
+        if (!`${opts.projectFile}`.trim()) {
+            throw new Error(`projectFile not specified`);
+        }
+        if (!`${opts.id}`.trim()) {
+            throw new Error(`package id not specified`);
+        }
+        const args = ["add", "package", opts.projectFile, opts.id];
+        pushIfSet(args, opts.version, "--version");
+        pushIfSet(args, opts.framework, "--framework");
+        pushFlag(args, opts.noRestore, "--no-restore");
+        pushIfSet(args, opts.source, "--source");
+        pushIfSet(args, opts.packageDirectory, "--package-directory");
+        pushFlag(args, opts.preRelease, "--prerelease");
+        await runDotNetWith(args, opts);
+    }
     module.exports = {
         test,
         build,
@@ -769,6 +839,8 @@ WARNING: 'dotnet pack' ignores --version-suffix when a nuspec file is provided.
         disableNugetSource,
         enableNugetSource,
         tryFindConfiguredNugetSource,
-        incrementTempDbPortHintIfFound
+        incrementTempDbPortHintIfFound,
+        searchPackages,
+        installPackage
     };
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zarro",
-  "version": "1.170.12",
+  "version": "1.170.16",
   "description": "Some glue to make gulp easier, perhaps even zero- or close-to-zero-conf",
   "bin": {
     "zarro": "./index.js"

package/types.d.ts

@@ -1,4 +1,4 @@
-// noinspection JSUnusedGlobalSymbols
+// noinspection JSUnusedGlobalSymbols,JSUnusedLocalSymbols
 
 import * as fs from "fs";
 import { StatsBase } from "fs";
@@ -802,6 +802,7 @@ declare global {
   interface PackageInfo {
     id: string;
     version: Version;
+    source?: string;
   }
 
   interface PathUtils {
@@ -827,16 +828,16 @@ declare global {
   // @ts-ignore
   export interface ExecOpts
     extends ExecFileOptionsWithBufferEncoding {
-    // force usage of execfile
+    // force usage of execFile
     _useExecFile?: boolean;
     // exec normally mirrors output (and returns it)
     // -> set this to true to only return the output
-    suppressOutput?: boolean;
+    encoding?: string | null;
 
     // merge stdout & stderr into one output
     mergeIo?: boolean;
 
-    encoding?: string | null;
+    suppressOutput?: boolean;
   }
 
   export interface NugetPushOpts {
@@ -1063,7 +1064,7 @@ declare global {
 
     /**
      * when set true, output will not be echoed back on the
-     * console but you will be able to get it from a custom
+     * console, but you will be able to get it from a custom
      * io writer or the result from after spawn completes
      */
     suppressOutput?: boolean;
@@ -1095,7 +1096,7 @@ declare global {
 
     /**
      * when set true, output will not be echoed back on the
-     * console but you will be able to get it from a custom
+     * console, but you will be able to get it from a custom
      * io writer or the result from after spawn completes
      */
     suppressOutput?: boolean;
@@ -1501,6 +1502,27 @@ declare global {
     timeout?: number;
   }
 
+  interface DotNetSearchPackagesOptions extends DotNetBaseOptions {
+    source?: string;
+    search?: string;
+    take?: number;
+    skip?: number;
+    exactMatch?: boolean;
+    preRelease?: boolean;
+    configFile?: string;
+  }
+
+  interface DotNetInstallNugetPackageOption extends DotNetBaseOptions {
+    id: string;
+    projectFile: string;
+    version?: string;
+    framework?: string;
+    noRestore?: boolean;
+    source?: string;
+    packageDirectory?: string;
+    preRelease?: boolean;
+  }
+
   interface IoConsumers {
     stdout?: IoConsumer;
     stderr?: IoConsumer;
@@ -1561,6 +1583,8 @@ declare global {
   type DotNetEnableNugetSourceFunction = (source: string | NugetSource) => Promise<void>;
   type DotNetDisableNugetSourceFunction = (source: string | NugetSource) => Promise<void>;
   type DotNetTryMatchNugetSourceFunction = (nameOrUrlOrHostOrSpec: string | Partial<NugetSource> | RegExp) => Promise<Optional<NugetSource>>;
+  type DotNetSearchNugetPackagesFunction = (opts: DotNetSearchPackagesOptions | string) => Promise<PackageInfo[]>;
+  type DotNetInstallNugetPackageFunction = (opts: DotNetInstallNugetPackageOption | string) => Promise<void>;
 
   interface DotNetCli {
     clean: DotNetCleanFunction;
@@ -1578,6 +1602,8 @@ declare global {
     disableNugetSource: DotNetDisableNugetSourceFunction;
     tryFindConfiguredNugetSource: DotNetTryMatchNugetSourceFunction;
     incrementTempDbPortHintIfFound: (env: Dictionary<string>) => void;
+    searchPackages: DotNetSearchNugetPackagesFunction;
+    installPackage: DotNetInstallNugetPackageFunction;
   }
 
   type ReadCsProjNode = (csproj: string) => Promise<string>;
@@ -1715,7 +1741,7 @@ declare global {
     "bzip2-1.0.5" |
     "bzip2-1.0.6" |
     "Caldera" |
-    "CATOSL-1.1" |
+    "CATO-1.1" |
     "CC-BY-1.0" |
     "CC-BY-2.0" |
     "CC-BY-2.5" |