From 00a0497f3bef8f42ab729e914376df7c675510db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20S=C3=A1nchez=20Ortega?= Date: Tue, 8 Sep 2020 18:31:22 +0200 Subject: [PATCH] Add e2e tests for _ and $ JS identifiers --- .../e2e/javascript-identifiers/identifiers.js | 8 +++ .../javascript-identifiers.expected.html | 54 +++++++++++++++++++ .../javascript-identifiers.expected.json | 53 ++++++++++++++++++ .../leafdoc-options.json | 4 ++ 4 files changed, 119 insertions(+) create mode 100644 spec/e2e/javascript-identifiers/identifiers.js create mode 100644 spec/e2e/javascript-identifiers/javascript-identifiers.expected.html create mode 100644 spec/e2e/javascript-identifiers/javascript-identifiers.expected.json create mode 100644 spec/e2e/javascript-identifiers/leafdoc-options.json diff --git a/spec/e2e/javascript-identifiers/identifiers.js b/spec/e2e/javascript-identifiers/identifiers.js new file mode 100644 index 0000000..842fbf0 --- /dev/null +++ b/spec/e2e/javascript-identifiers/identifiers.js @@ -0,0 +1,8 @@ +// 🍂class $ +// jQuery stuff. +// 🍂function _each(arr: Array, fn: Function): undefined +// Returns a random number between 0.0 and 1.0 +export function _each(foo, bar) { + // Do something here. +} + diff --git a/spec/e2e/javascript-identifiers/javascript-identifiers.expected.html b/spec/e2e/javascript-identifiers/javascript-identifiers.expected.html new file mode 100644 index 0000000..f86dac9 --- /dev/null +++ b/spec/e2e/javascript-identifiers/javascript-identifiers.expected.html @@ -0,0 +1,54 @@ + + + + + + + + +

Leafdoc generated API reference

+ +

$

+

jQuery stuff.

+ +

Functions

+ +
+ + + + + + + + + + + + + + +
FunctionReturnsDescription
_each(<Array> arr, <Function> fn)undefinedReturns a random number between 0.0 and 1.0
+
+ + + + + \ No newline at end of file diff --git a/spec/e2e/javascript-identifiers/javascript-identifiers.expected.json b/spec/e2e/javascript-identifiers/javascript-identifiers.expected.json new file mode 100644 index 0000000..c855a18 --- /dev/null +++ b/spec/e2e/javascript-identifiers/javascript-identifiers.expected.json @@ -0,0 +1,53 @@ +{ + "$": { + "name": "$", + "aka": [], + "comments": [ + "jQuery stuff." + ], + "supersections": { + "function": { + "name": "function", + "aka": [], + "comments": [], + "sections": { + "__default": { + "name": "__default", + "aka": [], + "comments": [], + "uninheritable": false, + "documentables": { + "_each": { + "name": "_each", + "aka": [], + "comments": [ + "Returns a random number between 0.0 and 1.0" + ], + "params": { + "arr": { + "name": "arr", + "type": "Array" + }, + "fn": { + "name": "fn", + "type": "Function" + } + }, + "type": "undefined", + "optional": false, + "defaultValue": null, + "id": "$-_each" + } + }, + "type": "function", + "id": "$-function" + } + }, + "id": "$-function" + } + }, + "inherits": [], + "relationships": [], + "id": "$" + } +} \ No newline at end of file diff --git a/spec/e2e/javascript-identifiers/leafdoc-options.json b/spec/e2e/javascript-identifiers/leafdoc-options.json new file mode 100644 index 0000000..0d9074b --- /dev/null +++ b/spec/e2e/javascript-identifiers/leafdoc-options.json @@ -0,0 +1,4 @@ +{ + "templateDir": "./templates/basic", + "leadingCharacter": "🍂" +}