mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
Add the new snippet injector in grunt task
This commit is contained in:
@@ -1,70 +1,43 @@
|
|||||||
export var test_DummyTestForSnippetOnly0 = function () {
|
export var test_DummyTestForSnippetOnly0 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-log
|
||||||
// # 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("Hello, world!");
|
console.log("Hello, world!");
|
||||||
console.info("I am NativeScript");
|
console.info("I am NativeScript");
|
||||||
console.warn("Low memory");
|
console.warn("Low memory");
|
||||||
console.error("Uncaught Application Exception");
|
console.error("Uncaught Application Exception");
|
||||||
// ```
|
// << console-log
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export var test_DummyTestForSnippetOnly1 = function () {
|
export var test_DummyTestForSnippetOnly1 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-time
|
||||||
// ### Time
|
|
||||||
// ``` JavaScript
|
|
||||||
//// Begins counting a time span for a given name (key).
|
|
||||||
console.time("LoadTime");
|
console.time("LoadTime");
|
||||||
//// Do something...
|
// << console-time
|
||||||
//// Ends a previously started time span through the time method.
|
// >> console-timeEnd
|
||||||
console.timeEnd("LoadTime");
|
console.timeEnd("LoadTime");
|
||||||
// ```
|
// << console-timeEnd
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export var test_DummyTestForSnippetOnly2 = function () {
|
export var test_DummyTestForSnippetOnly2 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-assert
|
||||||
// ### Assert
|
|
||||||
// ``` JavaScript
|
|
||||||
//// Asserts a boolean condition and prints a message in case the assert fails.
|
|
||||||
console.assert(2 === 2, "2 equals 2");
|
console.assert(2 === 2, "2 equals 2");
|
||||||
// ```
|
// << console-assert
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export var test_DummyTestForSnippetOnly3 = function () {
|
export var test_DummyTestForSnippetOnly3 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-dir
|
||||||
// ### Dir
|
|
||||||
// ``` JavaScript
|
|
||||||
//// Prints the state of the specified object to the console.
|
|
||||||
var obj = {name: "John", age: 34};
|
var obj = {name: "John", age: 34};
|
||||||
console.dir(obj);
|
console.dir(obj);
|
||||||
// ```
|
// << console-dir
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export var test_DummyTestForSnippetOnly4 = function () {
|
export var test_DummyTestForSnippetOnly4 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-dump
|
||||||
// ### Dump
|
|
||||||
// ``` JavaScript
|
|
||||||
//// Prints the state of the specified object to the console.
|
|
||||||
var obj = { name: "John", age: 34 };
|
var obj = { name: "John", age: 34 };
|
||||||
console.dump(obj);
|
console.dump(obj);
|
||||||
// ```
|
// << console-dump
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export var test_DummyTestForSnippetOnly5 = function () {
|
export var test_DummyTestForSnippetOnly5 = function () {
|
||||||
// <snippet module="console" title="console">
|
// >> console-trace
|
||||||
// ### Trace
|
|
||||||
// ``` JavaScript
|
|
||||||
//// Prints the current stack trace in the console.
|
|
||||||
console.trace();
|
console.trace();
|
||||||
// ```
|
// << console-traceß
|
||||||
// </snippet>
|
|
||||||
}
|
}
|
||||||
33
apps/tests/console.md
Normal file
33
apps/tests/console.md
Normal file
@@ -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'/>
|
||||||
35
gruntfile.js
35
gruntfile.js
@@ -139,12 +139,14 @@ module.exports = function(grunt) {
|
|||||||
var localCfg = {
|
var localCfg = {
|
||||||
srcDir: ".",
|
srcDir: ".",
|
||||||
srcAppsDir: "./apps",
|
srcAppsDir: "./apps",
|
||||||
|
srcAppsTests: "./apps/tests",
|
||||||
packageJsonFilePath: "./package.json",
|
packageJsonFilePath: "./package.json",
|
||||||
outDir: "./bin/dist",
|
outDir: "./bin/dist",
|
||||||
|
outArticlesDir: "./bin/dist/articles",
|
||||||
outModulesDir: tsconfig.compilerOptions.outDir || "./bin/dist/modules",
|
outModulesDir: tsconfig.compilerOptions.outDir || "./bin/dist/modules",
|
||||||
outAppsDir: "./bin/dist/apps",
|
outAppsDir: "./bin/dist/apps",
|
||||||
outTsAppsDir: "./bin/dist/ts-apps",
|
outTsAppsDir: "./bin/dist/ts-apps",
|
||||||
outApiRefDir: "./bin/dist/api-ref"
|
outApiRefDir: "./bin/dist/apiref"
|
||||||
};
|
};
|
||||||
|
|
||||||
var nodeTestEnv = JSON.parse(JSON.stringify(process.env));
|
var nodeTestEnv = JSON.parse(JSON.stringify(process.env));
|
||||||
@@ -214,6 +216,12 @@ module.exports = function(grunt) {
|
|||||||
},
|
},
|
||||||
readyAppFiles: {
|
readyAppFiles: {
|
||||||
src: [localCfg.outModulesDir + "/apps/**"]
|
src: [localCfg.outModulesDir + "/apps/**"]
|
||||||
|
},
|
||||||
|
articles: {
|
||||||
|
src: [ localCfg.outArticlesDir ]
|
||||||
|
},
|
||||||
|
"apiref": {
|
||||||
|
src: [ localCfg.outApiRefDir ]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
copy: {
|
copy: {
|
||||||
@@ -228,6 +236,12 @@ module.exports = function(grunt) {
|
|||||||
dest: localCfg.outModulesDir,
|
dest: localCfg.outModulesDir,
|
||||||
cwd: localCfg.srcDir
|
cwd: localCfg.srcDir
|
||||||
},
|
},
|
||||||
|
articleMDs: {
|
||||||
|
expand: true,
|
||||||
|
src: [ "**/*.md" ],
|
||||||
|
dest: localCfg.outArticlesDir,
|
||||||
|
cwd: localCfg.srcAppsTests
|
||||||
|
},
|
||||||
license: {
|
license: {
|
||||||
expand: true,
|
expand: true,
|
||||||
src: [
|
src: [
|
||||||
@@ -413,6 +427,9 @@ module.exports = function(grunt) {
|
|||||||
},
|
},
|
||||||
mochaNode: {
|
mochaNode: {
|
||||||
cmd: "grunt simplemocha:node"
|
cmd: "grunt simplemocha:node"
|
||||||
|
},
|
||||||
|
injectArticles: {
|
||||||
|
cmd: "./node_modules/.bin/mdinject --root=<%= localCfg.srcAppsTests %> --docsroot=<%= localCfg.outArticlesDir %>"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
multidest: {
|
multidest: {
|
||||||
@@ -707,4 +724,20 @@ module.exports = function(grunt) {
|
|||||||
"ts:build-inplace",
|
"ts:build-inplace",
|
||||||
"generate-tns-core-modules-dev-dts"
|
"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"
|
||||||
|
]);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -36,6 +36,7 @@
|
|||||||
"grunt-ts": "5.3.2",
|
"grunt-ts": "5.3.2",
|
||||||
"grunt-typedoc": "0.2.3",
|
"grunt-typedoc": "0.2.3",
|
||||||
"grunt-untar": "0.0.1",
|
"grunt-untar": "0.0.1",
|
||||||
|
"markdown-snippet-injector": "^0.1.1",
|
||||||
"mocha": "2.2.5",
|
"mocha": "2.2.5",
|
||||||
"shelljs": "0.5.3",
|
"shelljs": "0.5.3",
|
||||||
"grunt-tslint": "3.0.3",
|
"grunt-tslint": "3.0.3",
|
||||||
|
|||||||
Reference in New Issue
Block a user