Skip to content

Commit 3fb3a66

Browse files
web-flowweb-flow
authored
Continuous Integration Publish: a3fa13f
Merge pull request #101 from cake-contrib/feature/GH-91 (GH-91) added the possibility to check for addin
1 parent d0b37c0 commit 3fb3a66

27 files changed

+2381
-19
lines changed

‎feed.atom‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
<title>CakeContrib.Guidelines</title>
55
<link rel="self" href="https://cake-contrib.github.io/CakeContrib.Guidelines" />
66
<rights>2021</rights>
7-
<updated>2021-02-27T22:46:24Z</updated>
7+
<updated>2021-03-01T21:27:51Z</updated>
88
</feed>

‎feed.rss‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<link>https://cake-contrib.github.io/CakeContrib.Guidelines</link>
66
<description />
77
<copyright>2021</copyright>
8-
<pubDate>Sat, 27 Feb 2021 22:46:24 GMT</pubDate>
9-
<lastBuildDate>Sat, 27 Feb 2021 22:46:24 GMT</lastBuildDate>
8+
<pubDate>Mon, 01 Mar 2021 21:27:51 GMT</pubDate>
9+
<lastBuildDate>Mon, 01 Mar 2021 21:27:51 GMT</lastBuildDate>
1010
</channel>
1111
</rss>

‎guidelines/CakeContribIcon.html‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>
@@ -124,9 +125,9 @@ <h2 id="table-of-contents">Table of Contents</h2>
124125
<ul>
125126
<li><a href="#icon-location">Icon-Location</a></li>
126127
<li><a href="#icon-include-in-project">Icon include in project</a></li>
127-
<li><a href="#migrating-from-an-existing-project">migrating from an existing project</a></li>
128128
</ul>
129129
</li>
130+
<li><a href="#migrating-from-an-existing-project">Migrating from an existing project</a></li>
130131
</ul>
131132
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
132133
<h2 id="goals">Goals</h2>
@@ -150,15 +151,21 @@ <h2 id="usage">Usage</h2>
150151
</ul>
151152
<h2 id="settings">Settings</h2>
152153
<h3 id="icon-location">Icon-Location</h3>
153-
<p>The default location of the icon is <code>icon.png</code>, next to the csproj (i.e. <code>$(MSBuildProjectDirectory)/icon.png</code>).</p>
154+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
155+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
156+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
157+
<p>The default location of the cake-contrib icon is <code>icon.png</code>, next to the csproj (i.e. <code>$(MSBuildProjectDirectory)/icon.png</code>).</p>
154158
<p>Setting <code>CakeContribGuidelinesIconDestinationLocation</code> makes it possible to override the default location of the Icon. For example setting</p>
155159
<pre><code class="language-xml">&lt;PropertyGroup&gt;
156-
&lt;IconDestinationLocation&gt;../logo.png&lt;/IconDestinationLocation&gt;
160+
&lt;CakeContribGuidelinesIconDestinationLocation&gt;../logo.png&lt;/CakeContribGuidelinesIconDestinationLocation&gt;
157161
&lt;/PropertyGroup&gt;
158162
</code></pre>
159163
<p>in the csproj will place the icon as <code>logo.png</code> one folder up (relative to the current project).</p>
160164
<h3 id="icon-include-in-project">Icon include in project</h3>
161-
<p>The icon will be automatically included in the project, unless <code>CakeContribGuidelinesIconOmitImport</code> was defined.</p>
165+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
166+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
167+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
168+
<p>The cake-contrib icon will be automatically included in the project, unless <code>CakeContribGuidelinesIconOmitImport</code> was defined.</p>
162169
<p>To to use a &quot;custom&quot; import the following could be used:</p>
163170
<pre><code class="language-xml">&lt;PropertyGroup&gt;
164171
&lt;CakeContribGuidelinesIconOmitImport&gt;1&lt;/CakeContribGuidelinesIconOmitImport&gt;
@@ -170,7 +177,7 @@ <h3 id="icon-include-in-project">Icon include in project</h3>
170177
&lt;/None&gt;
171178
&lt;/ItemGroup&gt;
172179
</code></pre>
173-
<h3 id="migrating-from-an-existing-project">migrating from an existing project</h3>
180+
<h2 id="migrating-from-an-existing-project">Migrating from an existing project</h2>
174181
<ul>
175182
<li>remove the existing icon</li>
176183
<li>remove the <code>Include</code> of the icon from the project-file</li>

‎guidelines/PrivateAssets.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>
@@ -138,7 +139,10 @@ <h2 id="usage">Usage</h2>
138139
<p>Using this package automatically enables this guideline.</p>
139140
<h2 id="settings">Settings</h2>
140141
<h3 id="opt-out">Opt-Out</h3>
141-
<p>It it possible to opt-out of the check for <code>PrivateAssets</code> using the following setting:</p>
142+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
143+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
144+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
145+
<p>It it possible to opt-out of the check for <code>PrivateAssets</code> using the <code>CakeContribGuidelinesCakeReferenceOmitPrivateCheck</code> setting:</p>
142146
<p>(<em>Keep in mind, though that it is not recommended to opt-out of this feature</em>)</p>
143147
<pre><code class="language-xml">&lt;PropertyGroup&gt;
144148
&lt;CakeContribGuidelinesCakeReferenceOmitPrivateCheck&gt;1&lt;/CakeContribGuidelinesCakeReferenceOmitPrivateCheck&gt;

‎guidelines/RecommendedReferences.html‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>
@@ -143,14 +144,21 @@ <h2 id="usage">Usage</h2>
143144
<p>Using this package automatically enables this guideline.</p>
144145
<h2 id="settings">Settings</h2>
145146
<h3 id="opt-out">Opt-Out</h3>
146-
<p>It it possible to opt-out of the check for StyleCop using the following setting:</p>
147+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
148+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
149+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
150+
<p>It it possible to opt-out of the check for recommended references by using the <code>CakeContribGuidelinesOmitRecommendedReference</code> setting
151+
and setting it's <code>Include</code> to the reference that should not be checked.</p>
147152
<p>(<em>Keep in mind, though that it is not recommended to opt-out of this feature</em>)</p>
148153
<pre><code class="language-xml">&lt;ItemGroup&gt;
149154
&lt;CakeContribGuidelinesOmitRecommendedReference Include=&quot;StyleCop.Analyzers&quot; /&gt;
150155
&lt;/ItemGroup&gt;
151156
</code></pre>
152-
<p>It is also possible to opt-out of the check for configuration-files (<code>stylecop.json</code> as well as <code>.editorconfig</code>)
153-
using the following settings:</p>
157+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
158+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
159+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
160+
<p>It is possible to opt-out of the check for configuration-files by using the <code>CakeContribGuidelinesOmitRecommendedConfigFile</code> setting
161+
and setting it's <code>Include</code> to the file name that should not be checked:</p>
154162
<pre><code class="language-xml">&lt;ItemGroup&gt;
155163
&lt;CakeContribGuidelinesOmitRecommendedConfigFile Include=&quot;stylecop.json&quot; /&gt;
156164
&lt;CakeContribGuidelinesOmitRecommendedConfigFile Include=&quot;.editorconfig&quot; /&gt;

‎guidelines/TargetFramework.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>
@@ -169,7 +170,11 @@ <h2 id="usage">Usage</h2>
169170
<p>Using this package automatically enables this guideline.</p>
170171
<h2 id="settings">Settings</h2>
171172
<h3 id="opt-out">Opt-Out</h3>
172-
<p>It it possible to opt-out of the check for target framework using the following setting:</p>
173+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
174+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
175+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
176+
<p>It it possible to opt-out of the check for target framework(s) by using the <code>CakeContribGuidelinesOmitTargetFramework</code> setting
177+
and setting it's <code>Include</code> to the target framework that should not be checked.</p>
173178
<p>(<em>Keep in mind, though that it is not recommended to opt-out of this feature</em>)</p>
174179
<pre><code class="language-xml">&lt;ItemGroup&gt;
175180
&lt;CakeContribGuidelinesOmitTargetFramework Include=&quot;netstandard2.0&quot; /&gt;

‎guidelines/examples/Editorconfig.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>

‎guidelines/examples/StyleCopJson.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>

‎guidelines/examples/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>

‎guidelines/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<ul class="nav navbar-nav">
6161
<li class="active"><a href="/CakeContrib.Guidelines/guidelines">Guidelines</a></li>
6262
<li><a href="/CakeContrib.Guidelines/rules">Rules</a></li>
63+
<li><a href="/CakeContrib.Guidelines/settings">Settings</a></li>
6364

6465
</ul>
6566
</div>

0 commit comments

Comments
 (0)