@halospv3/hce.shared-config 3.0.0-develop.4 → 3.0.0-develop.6

package/mjs/dotnet/MSBuildProject.d.ts

@@ -0,0 +1,263 @@
+import { NugetProjectProperties } from './NugetProjectProperties.js';
+declare const msbuildEvaluationOutput: import("arktype/internal/methods/object.ts").ObjectType<{
+    Properties?: {
+        [x: string]: string;
+    } | undefined;
+    Items?: {
+        [x: string]: {
+            [x: string]: string;
+            Identity: string;
+            FullPath: string;
+            RootDir: string;
+            Filename: string;
+            Extension: string;
+            RelativeDir: string;
+            Directory: string;
+            RecursiveDir: string;
+            ModifiedTime: string;
+            CreatedTime: string;
+            AccessedTime: string;
+            DefiningProjectFullPath: string;
+            DefiningProjectDirectory: string;
+            DefiningProjectName: string;
+            DefiningProjectExtension: string;
+            SubType?: string | undefined;
+            TargetFrameworkIdentifier?: string | undefined;
+            TargetPlatformMoniker?: string | undefined;
+            CopyUpToDateMarker?: string | undefined;
+            TargetPlatformIdentifier?: string | undefined;
+            TargetFrameworkVersion?: string | undefined;
+            ReferenceAssembly?: string | undefined;
+        }[];
+    } | undefined;
+    TargetResults?: {
+        [x: string]: {
+            Result: "Success";
+            Items: {
+                [x: string]: string;
+                Identity: string;
+                FullPath: string;
+                RootDir: string;
+                Filename: string;
+                Extension: string;
+                RelativeDir: string;
+                Directory: string;
+                RecursiveDir: string;
+                ModifiedTime: string;
+                CreatedTime: string;
+                AccessedTime: string;
+                DefiningProjectFullPath: string;
+                DefiningProjectDirectory: string;
+                DefiningProjectName: string;
+                DefiningProjectExtension: string;
+                SubType?: string | undefined;
+                TargetFrameworkIdentifier?: string | undefined;
+                TargetPlatformMoniker?: string | undefined;
+                CopyUpToDateMarker?: string | undefined;
+                TargetPlatformIdentifier?: string | undefined;
+                TargetFrameworkVersion?: string | undefined;
+                ReferenceAssembly?: string | undefined;
+            }[];
+        } | {
+            Result: "Failure";
+            Items: never[];
+        };
+    } | undefined;
+}, {}>;
+export declare class MSBuildEvaluationOutput {
+    /**
+     * @param rawMSBuildEvaluation The output of a CLI MSBuild project evaluation.
+     * May be the UTF-8 string-encoded JSON or the object decoded from that JSON.
+     */
+    constructor(rawMSBuildEvaluation: Parameters<typeof JSON.parse>[0] | Parameters<typeof msbuildEvaluationOutput.from>[0]);
+    /**
+     * The specified properties and their values as evaluated by MSBuild Core.
+     * `-getProperty:{propertyName,...}`
+     */
+    Properties?: typeof msbuildEvaluationOutput.infer.Properties;
+    /**
+     * The specified items and their values and associated metadata as evaluated
+     * by MSBuild Core.
+     * `-getItem:{itemName,...}`
+     */
+    Items?: typeof msbuildEvaluationOutput.infer.Items;
+    /**
+     * The specified Targets and their output values as evaluated by MSBuild
+     * Core.
+     * `-getTargetResult:{targetName,...}`
+     */
+    TargetResults?: typeof msbuildEvaluationOutput.infer.TargetResults;
+}
+export declare const EvaluationOptions: import("arktype/internal/methods/object.ts").ObjectType<{
+    FullName: string;
+    Property: {
+        MSBuildProjectFullPath?: string | undefined;
+        AssemblyName?: string | undefined;
+        BaseIntermediateOutputPath?: string | undefined;
+        BaseOutputPath?: string | undefined;
+        Description?: string | undefined;
+        IntermediateOutput?: string | undefined;
+        OutDir?: string | undefined;
+        OutputPath?: string | undefined;
+        Version?: string | undefined;
+        VersionPrefix?: string | undefined;
+        VersionSuffix?: string | undefined;
+        TargetFramework?: string | undefined;
+        TargetFrameworks?: string | undefined;
+        RuntimeIdentifier?: string | undefined;
+        RuntimeIdentifiers?: string | undefined;
+    };
+    Targets: readonly string[] | string[];
+    GetItem: readonly string[] | string[];
+    GetProperty: readonly string[] | string[];
+    GetTargetResult: readonly string[] | string[];
+}, {}>;
+export declare class MSBuildProject {
+    /**
+     * Properties for multi-targeting `dotnet publish` outputs.
+     * These are included in {@link NPPGetterNames.InstanceGettersRecursive}.
+     */
+    static readonly MatrixProperties: readonly string[];
+    /**
+     * Creates an instance of MSBuildProject.
+     * @param opts The order-independent arguments for this constructor.
+     * Properties may be added or moved around in this definition without
+     * breaking compatibility.
+     * @param opts.fullPath The full path of the MSBuild project's file. This
+     * should have a '.csproj', '.fsproj', or '.vbproj' file extension.
+     * @param opts.projTargets A list of MSBuild Targets supported by the project.
+     * @param opts.evaluation The output of an MSBuild project evaluation. This
+     * comprises MSBuild Properties, Items, and Target results.
+     */
+    constructor(opts: {
+        fullPath: string;
+        projTargets: string[];
+        evaluation: MSBuildEvaluationOutput;
+    });
+    readonly Items: Readonly<Required<MSBuildEvaluationOutput>['Items']>;
+    readonly Properties: Readonly<NugetProjectProperties>;
+    readonly Targets: readonly string[];
+    /**
+     * Allows appending subsequent target results.
+     */
+    readonly TargetResults: Required<MSBuildEvaluationOutput>['TargetResults'][];
+    /**
+     * @param projectPath The full path of the project file or its directory. A
+     * relative path may be passed, but will resolve relative to the current
+     * working directory.
+     * @param includeNonPublic Include conventionally internal/private MSBuild
+     * targets in the result.
+     * @returns A string array of the project's MSBuild targets.
+     * @todo consider 'file' of -targets[:file]
+     *  Prints a list of available targets without executing the
+     *  actual build process. By default the output is written to
+     *  the console window. If the path to an output file
+     *  is provided that will be used instead.
+     *  (Short form: -ts)
+     *  Example:
+     *    -ts:out.txt
+     */
+    static GetTargets(projectPath: string, includeNonPublic?: boolean): Promise<string[]>;
+    /**
+     * Evaluate {@link Items}, {@link Properties}, and {@link TargetResults},
+     * returning them as an instance of {@link MSBuildProject}.\
+     * Note: MSBuild will probably fail if Restore is skipped and another
+     * target is specified. If you choose Pack, you must do ['Restore', 'Pack'].
+     * @param options The result of {@link EvaluationOptions.from}.
+     * @returns A promised {@link MSBuildProject} instance.
+     * @throws if the exec command fails -OR- the JSON parse fails -OR-
+     * MSBuildProject's constructor fails.
+     * @see {@link PackableProjectsToMSBuildProjects} for most use-cases.
+     */
+    static Evaluate(options: typeof EvaluationOptions.inferOut): Promise<MSBuildProject>;
+    /**
+     * Evaluate multiple project paths with some default Evaluate options.
+     * @async
+     * @param projectsToPackAndPush An array of MSBuild projects' full file
+     * paths. If a path is a directory, files in that directory are filtered for
+     * `.csproj`, `.fsproj`, and `.vbproj` project files.
+     * See https://github.com/dotnet/sdk/blob/497f334b2862bdf98b30c00ede2fd259ea5f624d/src/Cli/dotnet/Commands/New/MSBuildEvaluation/MSBuildEvaluationResult.cs#L19-L32.\
+     * @returns A promised array of {@link MSBuildProject} instances.
+     * All known MSBuild and NuGet properties are evaluated.
+     * If applicable, a project's "Pack" target is evaluated.
+     */
+    static PackableProjectsToMSBuildProjects(projectsToPackAndPush: string[]): Promise<Promise<MSBuildProject>[]>;
+    static fromJSON(json: string): MSBuildProject;
+}
+/** ArkType type definitions for internal usage, but may be re-used elsewhere */
+export declare const _InternalMSBuildEvaluationTypes: import("arktype").Scope<{
+    msbuildEvaluationOutput: {
+        Properties?: {
+            [x: string]: string;
+        } | undefined;
+        Items?: {
+            [x: string]: {
+                [x: string]: string;
+                Identity: string;
+                FullPath: string;
+                RootDir: string;
+                Filename: string;
+                Extension: string;
+                RelativeDir: string;
+                Directory: string;
+                RecursiveDir: string;
+                ModifiedTime: string;
+                CreatedTime: string;
+                AccessedTime: string;
+                DefiningProjectFullPath: string;
+                DefiningProjectDirectory: string;
+                DefiningProjectName: string;
+                DefiningProjectExtension: string;
+                SubType?: string | undefined;
+                TargetFrameworkIdentifier?: string | undefined;
+                TargetPlatformMoniker?: string | undefined;
+                CopyUpToDateMarker?: string | undefined;
+                TargetPlatformIdentifier?: string | undefined;
+                TargetFrameworkVersion?: string | undefined;
+                ReferenceAssembly?: string | undefined;
+            }[];
+        } | undefined;
+        TargetResults?: {
+            [x: string]: {
+                Result: "Success";
+                Items: {
+                    [x: string]: string;
+                    Identity: string;
+                    FullPath: string;
+                    RootDir: string;
+                    Filename: string;
+                    Extension: string;
+                    RelativeDir: string;
+                    Directory: string;
+                    RecursiveDir: string;
+                    ModifiedTime: string;
+                    CreatedTime: string;
+                    AccessedTime: string;
+                    DefiningProjectFullPath: string;
+                    DefiningProjectDirectory: string;
+                    DefiningProjectName: string;
+                    DefiningProjectExtension: string;
+                    SubType?: string | undefined;
+                    TargetFrameworkIdentifier?: string | undefined;
+                    TargetPlatformMoniker?: string | undefined;
+                    CopyUpToDateMarker?: string | undefined;
+                    TargetPlatformIdentifier?: string | undefined;
+                    TargetFrameworkVersion?: string | undefined;
+                    ReferenceAssembly?: string | undefined;
+                }[];
+            } | {
+                Result: "Failure";
+                Items: never[];
+            };
+        } | undefined;
+    };
+}>;
+/**
+ * Use this in your catch statement or .catch call to return `undefined` when
+ * MSBuild error CSC2012 (e.g. "file in use by another process") is reported.
+ * @param error Probably an Error object
+ * @returns `undefined` if CSC2012 (file in use by another process) occurs
+ */
+export declare function catchCsc2012(error: unknown): undefined;
+export {};
+//# sourceMappingURL=MSBuildProject.d.ts.map

package/mjs/dotnet/MSBuildProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSBuildProject.d.ts","sourceRoot":"","sources":["../../src/dotnet/MSBuildProject.ts"],"names":[],"mappings":"AAUA,OAAO,EAEL,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AA6DrC,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAI3B,CAAC;AAEH,qBAAa,uBAAuB;IAClC;;;OAGG;gBACS,oBAAoB,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IASvH;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,uBAAuB,CAAC,KAAK,CAAC,UAAU,CAAC;IAC7D;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,uBAAuB,CAAC,KAAK,CAAC,KAAK,CAAC;IACnD;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,uBAAuB,CAAC,KAAK,CAAC,aAAa,CAAC;CACpE;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;MA8C7B,CAAC;AAEF,qBAAa,cAAc;IACzB;;;OAGG;IACH,gBAAuB,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAKvD;IAEH;;;;;;;;;;OAUG;gBACgB,IAAI,EAAE;QACvB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,UAAU,EAAE,uBAAuB,CAAC;KACrC;IAeD,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC;IAE7E;;;;;;;;;;;;;;;OAeG;WACU,UAAU,CACrB,WAAW,EAAE,MAAM,EACnB,gBAAgB,UAAQ,GACvB,OAAO,CAAC,MAAM,EAAE,CAAC;IAcpB;;;;;;;;;;OAUG;WACiB,QAAQ,CAC1B,OAAO,EAAE,OAAO,iBAAiB,CAAC,QAAQ,GACzC,OAAO,CAAC,cAAc,CAAC;IAsG1B;;;;;;;;;;OAUG;WACiB,iCAAiC,CACnD,qBAAqB,EAAE,MAAM,EAAE,GAC9B,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;WAwFvB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc;CAYrD;AAsCD,gFAAgF;AAChF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE1C,CAAC;AAWH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAiCtD"}