From 3a06a4526b650d1d263c8d8b42e1b04459f4b84c Mon Sep 17 00:00:00 2001
From: gproulx <gproulx@ghislainproulx.net>
Date: Thu, 28 Aug 2014 23:28:53 -0400
Subject: [PATCH] Add .weignore documentation

---
 Website/Views/changelog.cshtml        |  2 +-
 Website/Views/features/general.cshtml | 92 +++++++++++++++++++++++----
 2 files changed, 80 insertions(+), 14 deletions(-)

diff --git a/Website/Views/changelog.cshtml b/Website/Views/changelog.cshtml
index d732db6..de464e3 100644
--- a/Website/Views/changelog.cshtml
+++ b/Website/Views/changelog.cshtml
@@ -31,7 +31,7 @@
 							<p><strong>Important!</strong> This version requires Visual Studio Update 3 RTM</p>
 							<ul>
 								<li>Node.js server for compiling/linting/etc.</li>
-								<li><a href="https://github.com/madskristensen/WebEssentials2013/pull/1250">.weignore</a> file support</li>
+								<li><a href="features/general#weignore">.weignore</a> file support</li>
 								<li>Dictionary support in d.ts generation</li>
 								<li>Image preview works in &lt;source&gt; elements</li>
 								<li>.svg files now opens in the HTML editor</li>
diff --git a/Website/Views/features/general.cshtml b/Website/Views/features/general.cshtml
index 300a036..163726f 100644
--- a/Website/Views/features/general.cshtml
+++ b/Website/Views/features/general.cshtml
@@ -37,31 +37,97 @@
             </article>
         </div>
         <div class="col-md-6">
-            <article id="bundling" class="panel panel-default">
+            <article id="commands" class="panel panel-default">
                 <h3 class="panel-heading">
-                    <a href="#bundling">
+                    <a href="#commands">
                         <span class="fa fa-link"></span>
                     </a>
-                    Bundling
+                    Solution wide commands
                 </h3>
                 <div class="panel-body">
-                    <p>Any text based file can be bundled using Web Essentials.</p>
-                    <p>Out of the box, Web Essentials provides shortcuts to produce bundle files for CSS and JavaScript.</p>
-                    <p>These bundle files are automatically updated whenever one of the source files change.</p>
-                    <p>Just right-click 2 or more CSS/JS files and click "Create CSS/JS bundle file".</p>
+                    <p>These menu items are shortcuts to solution wide commands.</p>
+                    <p>They can be found under Build -> Web Essentials.</p>
+                    <img src="/images/general/build.png" alt="Build menu" width="361" height="130" />
                 </div>
             </article>
-            <article id="commands" class="panel panel-default">
+            <article id="weignore" class="panel panel-default">
                 <h3 class="panel-heading">
-                    <a href="#commands">
+                    <a href="#weignore">
                         <span class="fa fa-link"></span>
                     </a>
-                    Solution wide commands
+                    WEIgnore
                 </h3>
                 <div class="panel-body">
-                    <p>These menu items are shortcuts to solution wide commands.</p>
-                    <p>They can be found under Build -> Web Essentials.</p>
-                    <img src="/images/general/build.png" alt="Build menu" width="361" height="130" />
+                    <p><code>.weignore</code> document is a file containing the list of linefeed-separated file-path patterns to prevent compilers and linters used in Web Essentials. It accepts all styles supported by .jshintignore and both Unix-like and Windows-like file paths.</p>
+                    <h4>Discoverability</h4>
+                    <p>It works just like <code>.jscs</code>,<code>.jshintrc</code>, <code>coffee.json</code>, <code>coffeelint.js</code> and <code>tslint.json</code>. For each request, it looks for <code>.weignore</code> file in the current directory, then its parent until the drive's root. After that, it will look into user's HOME directory (<code>C:\Users\&lt;your-name&gt;</code>). The first config file that is found in the chain takes effect. All the file-path patterns inside the .weignore file are relative to the source file being processed, not the .weignore file itself.</p>
+                    <h4>How it works</h4>
+                    <p>Each line must respect this pattern : <code>exclusion-pattern [compiler/linter-to-exclude]</code></p>
+                    <p>Here is the list of all the (node-based) compilers and linters currently supported by WebEssentials:</p>
+                    <ul>
+                        <li>
+                            compiler
+                            <ul>
+                                <li>autoprefixer</li>
+                                <li>coffeescript</li>
+                                <li>icedcoffeescript</li>
+                                <li>less</li>
+                                <li>livescript</li>
+                                <li>scss</li>
+                                <li>sweetjs</li>
+                            </ul>
+                        </li>
+                        <li>
+                            linter
+                            <ul>
+                                <li>jscs</li>
+                                <li>jshint</li>
+                                <li>tslint</li>
+                            </ul>
+                        </li>
+                    </ul>
+                    <h4>Basic Usage</h4>
+<pre>
+<code># To ignore file path including the word &quot;style&quot;:<br />**/**style**
+                    <br /><br /># To ignore path with .min.js at the end:
+                    <br />**/**.min.js
+                    <br /><br /># To ignore file path including the folder name &quot;slug&quot;:
+                    <br />**\slug\**
+                    <br /><br /># or
+                    <br />**/slug/**
+                    <br /><br /># To ignore the absolute path:
+                    <br />C:\temp\foo.ts
+                    <br /># or
+                    <br />C:/temp/foo.ts
+</code></pre>
+
+                    <h4>Intermediate Complexity:</h4>
+<pre><code># To negate the ignore, use ! before the path:
+                    <br />!**/**Content
+                    <br /><br /># To ignore the file from any kind of compilation (only), 
+                    <br /># specify the term &quot;compiler&quot; after the pattern, separated by TAB:
+                    <br />**/doodle.less  compiler
+                    <br /><br /># To ignore the file from being processed by LESS compiler, 
+                    <br /># use the word less:
+                    <br />**/doodle.less  less
+                    <br /><br /># To ignore the file from being processed by Autoprefixer, 
+                    <br /># use the word autoprefixer:
+                    <br />**/bug.scss autoprefixer
+                    <br /><br /># To ignore the file from being processed by a linter, 
+                    <br /># use the word linter:
+                    <br />**/*.js linter
+                    <br /><br /># You can also specify a linter's name:
+                    <br />**/random.js    jscs
+                    <br /><br /># If there a case which requires specifying multiple service names,
+                    <br /># use comma-separated list:
+                    <br />**/doodle.less  less, autoprefixer
+</code></pre>
+
+                    <h4>Limitations</h4>
+                    <p>Currently it only targets node.js pipeline services, meaning TypeScript compilation and Markdown are out.</p>
+
+                    <br/>
+                    <p>More information about .weignore can be find <a href="https://github.com/madskristensen/WebEssentials2013/pull/1250">here</a>.</p>
                 </div>
             </article>
         </div>