gulp-dotnet-cli
Version:
A dotnet command line interface for gulp
464 lines • 22.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IPublishModel | gulp-dotnet-cli</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">gulp-dotnet-cli</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="ipublishmodel.html">IPublishModel</a>
</li>
</ul>
<h1>Interface IPublishModel</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>interface</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IPublishModel</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#configuration" class="tsd-kind-icon">configuration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#echo" class="tsd-kind-icon">echo</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#framework" class="tsd-kind-icon">framework</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#msbuildargs" class="tsd-kind-icon">msbuild<wbr>Args</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#output" class="tsd-kind-icon">output</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#runtime" class="tsd-kind-icon">runtime</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#verbosity" class="tsd-kind-icon">verbosity</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#version" class="tsd-kind-icon">version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipublishmodel.html#versionsuffix" class="tsd-kind-icon">version<wbr>Suffix</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="configuration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> configuration</h3>
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L20">schema/interfaces/IPublishModel.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configuration to use for building the project. Default for most projects is "Debug"</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="echo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> echo</h3>
<div class="tsd-signature tsd-kind-icon">echo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L69">schema/interfaces/IPublishModel.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p> Log the command to the console</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="framework" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> framework</h3>
<div class="tsd-signature tsd-kind-icon">framework<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L55">schema/interfaces/IPublishModel.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Target framework to build for. The target framework has to be specified in the project file.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="msbuildargs" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> msbuild<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">msbuild<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L41">schema/interfaces/IPublishModel.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Any extra options that should be passed to MSBuild. See dotnet msbuild -h for available options</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{Array<string>}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="output" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> output</h3>
<div class="tsd-signature tsd-kind-icon">output<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L13">schema/interfaces/IPublishModel.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Output directory in which to place built artifacts</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="runtime" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> runtime</h3>
<div class="tsd-signature tsd-kind-icon">runtime<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L62">schema/interfaces/IPublishModel.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Target runtime to build for. The default is to build a portable application.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="verbosity" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> verbosity</h3>
<div class="tsd-signature tsd-kind-icon">verbosity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L34">schema/interfaces/IPublishModel.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>sets the console verbosity. valid values?: 'quiet', 'minimal', 'normal', 'detailed', 'diagnostic'</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L48">schema/interfaces/IPublishModel.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the $(Version) property in msbuild</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="versionsuffix" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> version<wbr>Suffix</h3>
<div class="tsd-signature tsd-kind-icon">version<wbr>Suffix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Janus-vistaprint/gulp-dotnet-cli/blob/175312e/src/schema/interfaces/IPublishModel.ts#L27">schema/interfaces/IPublishModel.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Defines the value for the $(VersionSuffix) property in the project</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{string}</p>
</dd>
<dt>memberof</dt>
<dd><p>IPublishModel</p>
</dd>
</dl>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface">
<a href="ibuildmodel.html" class="tsd-kind-icon">IBuild<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="icleanmodel.html" class="tsd-kind-icon">IClean<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="inugetpushmodel.html" class="tsd-kind-icon">INuget<wbr>Push<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="ipackmodel.html" class="tsd-kind-icon">IPack<wbr>Model</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ipublishmodel.html" class="tsd-kind-icon">IPublish<wbr>Model</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#configuration" class="tsd-kind-icon">configuration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#echo" class="tsd-kind-icon">echo</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#framework" class="tsd-kind-icon">framework</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#msbuildargs" class="tsd-kind-icon">msbuild<wbr>Args</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#output" class="tsd-kind-icon">output</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#runtime" class="tsd-kind-icon">runtime</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#verbosity" class="tsd-kind-icon">verbosity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#version" class="tsd-kind-icon">version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipublishmodel.html#versionsuffix" class="tsd-kind-icon">version<wbr>Suffix</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="irestoremodel.html" class="tsd-kind-icon">IRestore<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="irunmodel.html" class="tsd-kind-icon">IRun<wbr>Model</a>
</li>
<li class=" tsd-kind-interface">
<a href="itestmodel.html" class="tsd-kind-icon">ITest<wbr>Model</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#plugin_name" class="tsd-kind-icon">PLUGIN_<wbr>NAME</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#shelly" class="tsd-kind-icon">shelly</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>