Merge remote-tracking branch 'upstream/develop' into feature/typescript

# Conflicts: # packages/titanium-docgen/generators/typescript_generator.js
tidev · Feb 21, 2020 · 36a0cb6 · 36a0cb6
2 parents 1ab5719 + e00f175
commit 36a0cb6
Show file tree

Hide file tree

Showing 62 changed files with 108 additions and 1,145 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/appcelerator/docs-devkit/compare/v4.1.0...v4.2.0) (2020-02-05)
+
+
+### Features
+
+* **docgen:** accept whitelist of constants references to skip ([#26](https://github.com/appcelerator/docs-devkit/issues/26)) ([3b1c537](https://github.com/appcelerator/docs-devkit/commit/3b1c537))
+
+
+
+
+
 # [4.1.0](https://github.com/appcelerator/docs-devkit/compare/v4.0.1...v4.1.0) (2019-12-12)
 
 

diff --git a/lerna.json b/lerna.json
@@ -1,6 +1,6 @@
 {
   "lerna": "3.13.0",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

diff --git a/packages/docs/CHANGELOG.md b/packages/docs/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/appcelerator/docs-devkit/compare/v4.1.0...v4.2.0) (2020-02-05)
+
+**Note:** Version bump only for package docs
+
+
+
+
+
 # [4.1.0](https://github.com/appcelerator/docs-devkit/compare/v4.0.1...v4.1.0) (2019-12-12)
 
 **Note:** Version bump only for package docs

diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Docs for the Titanium docs-devkit",
   "repository": "https://github.com/appcelerator/docs-devkit.git",
   "author": "Axway Appcelerator",
@@ -16,7 +16,7 @@
     "@vuepress/plugin-back-to-top": "1.0.2",
     "fs-extra": "^8.1.0",
     "vuepress": "^1.0.2",
-    "vuepress-plugin-apidocs": "^4.1.0",
+    "vuepress-plugin-apidocs": "^4.2.0",
     "vuepress-plugin-versioning": "^4.0.1",
     "vuepress-theme-titanium": "^4.0.1",
     "vuex": "^3.1.1",

diff --git a/packages/titanium-docgen/CHANGELOG.md b/packages/titanium-docgen/CHANGELOG.md
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/appcelerator/docs-devkit/compare/v4.1.0...v4.2.0) (2020-02-05)
+
+
+### Features
+
+* **docgen:** accept whitelist of constants references to skip ([#26](https://github.com/appcelerator/docs-devkit/issues/26)) ([3b1c537](https://github.com/appcelerator/docs-devkit/commit/3b1c537))
+
+
+
+
+
 # [4.1.0](https://github.com/appcelerator/docs-devkit/compare/v4.0.1...v4.1.0) (2019-12-12)
 
 

diff --git a/packages/titanium-docgen/generators/modulehtml_generator.js b/packages/titanium-docgen/generators/modulehtml_generator.js
@@ -3,7 +3,7 @@
  */
 'use strict';
 
-const exporter = require('../lib/html_generator.js');
+const exporter = require('./html_generator.js');
 
 /**
  * Returns a JSON object formatted for HTML EJS templates

diff --git a/packages/titanium-docgen/lib/common.js b/packages/titanium-docgen/lib/common.js
@@ -10,6 +10,7 @@ const yaml = require('js-yaml'),
 	fs = require('fs'),
 	colors = require('colors'), // eslint-disable-line no-unused-vars
 	nodeappc = require('node-appc'),
+	path = require('path'),
 	MarkdownIt = require('markdown-it'),
 	ignoreList = [ 'node_modules', '.travis.yml' ],
 	LOG_INFO = 0,
@@ -153,19 +154,19 @@ function errorMessage() {
 
 /**
  * Recursively find, load and parse YAML files
- * @param {Object} path Root path to start search
+ * @param {Object} rootPath Root path to start search
  * @returns {Object} Dictionary containing the parsed data and any YAML errors
  */
-exports.parseYAML = function parseYAML(path) {
+exports.parseYAML = function parseYAML(rootPath) {
 	const rv = {
 		data: {},
 		errors: []
 	};
-	let currentFile = path;
+	let currentFile = rootPath;
 	try {
-		const fsArray = fs.readdirSync(path);
+		const fsArray = fs.readdirSync(rootPath);
 		fsArray.forEach(function (fsElement) {
-			const elem = path + '/' + fsElement,
+			const elem = path.join(rootPath, fsElement),
 				stat = fs.statSync(elem);
 			currentFile = elem;
 

diff --git a/packages/titanium-docgen/package.json b/packages/titanium-docgen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "titanium-docgen",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Generates Titanium API documentation in different formats",
   "main": "index.js",
   "scripts": {

diff --git a/packages/titanium-docgen/templates/html/description.html b/packages/titanium-docgen/templates/html/description.html
diff --git a/packages/titanium-docgen/templates/html/event.html b/packages/titanium-docgen/templates/html/event.html
diff --git a/packages/titanium-docgen/templates/html/event_list.html b/packages/titanium-docgen/templates/html/event_list.html
diff --git a/packages/titanium-docgen/templates/html/event_property_list.html b/packages/titanium-docgen/templates/html/event_property_list.html
diff --git a/packages/titanium-docgen/templates/html/examples.html b/packages/titanium-docgen/templates/html/examples.html
diff --git a/packages/titanium-docgen/templates/html/footer.html b/packages/titanium-docgen/templates/html/footer.html
diff --git a/packages/titanium-docgen/templates/html/header.html b/packages/titanium-docgen/templates/html/header.html
diff --git a/packages/titanium-docgen/templates/html/index.html b/packages/titanium-docgen/templates/html/index.html
diff --git a/packages/titanium-docgen/templates/html/member_list.html b/packages/titanium-docgen/templates/html/member_list.html
diff --git a/packages/titanium-docgen/templates/html/method.html b/packages/titanium-docgen/templates/html/method.html