Add the new snippet injector in grunt task

NickIliev · NickIliev · commit 5ceeb7fddd0a · 2016-04-13T14:32:56.000+03:00
diff --git a/RunTests.md b/RunTests.md
diff --git a/apps/tests/console-tests.ts b/apps/tests/console-tests.ts
@@ -1,70 +1,43 @@
 ﻿export var test_DummyTestForSnippetOnly0 = function () {
-    // <snippet module="console" title="console">
-    // # Console
-    // ### Logging
-    // Logging to the console does not require the "console" module since the console variable is global. It can be used anywhere within your code.
-    // You can log your message in several different categories.
-    // ``` JavaScript
-    //// Verbously logs a message.
+    // >> console-log
     console.log("Hello, world!");
     console.info("I am NativeScript");
     console.warn("Low memory");
     console.error("Uncaught Application Exception");
-    // ```
-    // </snippet>
+    // << console-log
 }
 
 export var test_DummyTestForSnippetOnly1 = function () {
-    // <snippet module="console" title="console">
-    // ### Time
-    // ``` JavaScript
-    //// Begins counting a time span for a given name (key).
+    // >> console-time
     console.time("LoadTime");
-    //// Do something...
-    //// Ends a previously started time span through the time method.
+    // << console-time
+    // >> console-timeEnd
     console.timeEnd("LoadTime");
-    // ```
-    // </snippet>
+    // << console-timeEnd
 }
 
 export var test_DummyTestForSnippetOnly2 = function () {
-    // <snippet module="console" title="console">
-    // ### Assert
-    // ``` JavaScript
-    //// Asserts a boolean condition and prints a message in case the assert fails.
+    // >> console-assert
     console.assert(2 === 2, "2 equals 2");
-    // ```
-    // </snippet>
+    // << console-assert
 }
 
 export var test_DummyTestForSnippetOnly3 = function () {
-    // <snippet module="console" title="console">
-    // ### Dir
-    // ``` JavaScript
-    //// Prints the state of the specified object to the console.
+    // >> console-dir
     var obj = {name: "John", age: 34};
     console.dir(obj);
-    // ```
-    // </snippet>
+    // << console-dir
 }
 
 export var test_DummyTestForSnippetOnly4 = function () {
-    // <snippet module="console" title="console">
-    // ### Dump
-    // ``` JavaScript
-    //// Prints the state of the specified object to the console.
+    // >> console-dump
     var obj = { name: "John", age: 34 };
     console.dump(obj);
-    // ```
-    // </snippet>
+    // << console-dump
 }
 
 export var test_DummyTestForSnippetOnly5 = function () {
-    // <snippet module="console" title="console">
-    // ### Trace
-    // ``` JavaScript
-    //// Prints the current stack trace in the console.
+    // >> console-trace
     console.trace();
-    // ```
-    // </snippet>
+    // << console-traceß
 }
diff --git a/apps/tests/console.md b/apps/tests/console.md
@@ -0,0 +1,33 @@
+---
+nav-title: "console How-To"
+title: "How-To"
+description: "Examples for using console"
+---
+# Console
+### Logging
+Logging to the console does not require the "console" module since the console variable is global. It can be used anywhere within your code.
+You can log your message in several different categories.
+<snippet id='console-log'/>
+
+### Time
+Begins counting a time span for a given name (key).
+<snippet id='console-time'/>
+
+Ends a previously started time span through the time method.
+<snippet id='console-timeEnd'/>
+
+### Assert
+Asserts a boolean condition and prints a message in case the assert fails.
+<snippet id='console-assert'/>
+
+### Dir
+Prints the state of the specified object to the console.
+<snippet id='console-dir'/>
+
+### Dump
+Prints the state of the specified object to the console.
+<snippet id='console-dump'/>
+
+### Trace
+Prints the current stack trace in the console.
+<snippet id='console-trace'/>
diff --git a/gruntfile.js b/gruntfile.js
@@ -139,12 +139,14 @@ module.exports = function(grunt) {
     var localCfg = {
         srcDir: ".",
         srcAppsDir: "./apps",
+        srcAppsTests: "./apps/tests",
         packageJsonFilePath: "./package.json",
         outDir: "./bin/dist",
+        outArticlesDir: "./bin/dist/articles",
         outModulesDir: tsconfig.compilerOptions.outDir || "./bin/dist/modules",
         outAppsDir: "./bin/dist/apps",
         outTsAppsDir: "./bin/dist/ts-apps",
-        outApiRefDir: "./bin/dist/api-ref"
+        outApiRefDir: "./bin/dist/apiref"
     };
 
     var nodeTestEnv = JSON.parse(JSON.stringify(process.env));
@@ -214,6 +216,12 @@ module.exports = function(grunt) {
             },
             readyAppFiles: {
                 src: [localCfg.outModulesDir + "/apps/**"]
+            },
+            articles: {
+                src: [ localCfg.outArticlesDir ]
+            },
+            "apiref": {
+                src: [ localCfg.outApiRefDir ]
             }
         },
         copy: {
@@ -228,6 +236,12 @@ module.exports = function(grunt) {
                 dest: localCfg.outModulesDir,
                 cwd: localCfg.srcDir
             },
+            articleMDs: {
+                expand: true,
+                src: [ "**/*.md" ],
+                dest: localCfg.outArticlesDir,
+                cwd: localCfg.srcAppsTests
+            },
             license: {
                 expand: true,
                 src: [
@@ -413,6 +427,9 @@ module.exports = function(grunt) {
             },
             mochaNode: {
                 cmd: "grunt simplemocha:node"
+            },
+            injectArticles: {
+                cmd: "./node_modules/.bin/mdinject --root=<%= localCfg.srcAppsTests %> --docsroot=<%= localCfg.outArticlesDir %>"
             }
         },
         multidest: {
@@ -707,4 +724,20 @@ module.exports = function(grunt) {
         "ts:build-inplace",
         "generate-tns-core-modules-dev-dts"
     ]);
+    
+    grunt.registerTask("apiref", [
+        "clean:apiref",
+        "typedoc:build"
+    ]);
+    
+    grunt.registerTask("articles", [
+        "clean:articles",
+        "copy:articleMDs",
+        "exec:injectArticles"
+    ]);
+    
+    grunt.registerTask("docs", [
+        "apiref",
+        "articles"
+    ]);
 };
diff --git a/package.json b/package.json
@@ -36,6 +36,7 @@
     "grunt-ts": "5.3.2",
     "grunt-typedoc": "0.2.3",
     "grunt-untar": "0.0.1",
+    "markdown-snippet-injector": "^0.1.1",
     "mocha": "2.2.5",
     "shelljs": "0.5.3",
     "grunt-tslint": "3.0.3",
