PsXdtConfigTransform

0.1.0

PsXdtConfigTransform.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Invoke-XdtConfigTransform -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Invoke-XdtConfigTransform</command:name>
      <command:verb>Invoke</command:verb>
      <command:noun>XdtConfigTransform</command:noun>
      <maml:description>
        <maml:para>Applies xdt transform to config file</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Does the same things as Visual Studio does to web.config, but can be used with app.config as well</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Invoke-XdtConfigTransform</maml:name>
        <!-- Parameter: Path -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>Path to source xml config</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: XdtTranformPath -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1">
          <maml:name>XdtTranformPath</maml:name>
          <maml:description>
            <maml:para>Path to xdt transform file</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: OutputPath -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
          <maml:name>OutputPath</maml:name>
          <maml:description>
            <maml:para>Path to save resulting config file to</maml:para>
            <maml:para>If not set, result is written to output channel</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: Path -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>Path to source xml config</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: XdtTranformPath -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1">
        <maml:name>XdtTranformPath</maml:name>
        <maml:description>
          <maml:para>Path to xdt transform file</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: OutputPath -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
        <maml:name>OutputPath</maml:name>
        <maml:description>
          <maml:para>Path to save resulting config file to</maml:para>
          <maml:para>If not set, result is written to output channel</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>Path to xdt transform file</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: XmlTransformableDocument -->
      <command:returnValue>
        <dev:type>
          <maml:name>DotNet.Xdt.XmlTransformableDocument</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>Invoke-XdtConfigTransform -Path 'App.config' -XdtTranformPath 'App.Debug.config' -OutputPath 'App.out.config' -Verbose</maml:para>
          <maml:para>Applies xdt transform defined in App.Debug.config to App.config, result is saved to App.out.config</maml:para>
        </maml:introduction>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 2 ----------</maml:title>
        <maml:introduction>
          <maml:para>ls -File C:\Config\Xdt|select -ExpandProperty FullName|Invoke-XdtConfigTransform -Path C:\Config\App.config -Verbose</maml:para>
          <maml:para>Applies all xdt transforms from C:\Config\Xdt to C:\Config\App.config, writes resulting config to output channel</maml:para>
        </maml:introduction>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>