Merge pull request #42 from highcharts/v0.6.0

v0.6.0

Author: bre1470

.gitignore

@@ -1,3 +1,4 @@
+*.tsbuildinfo
 ._*
 .DS_Store
 /npm-debug.log

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

README.md

@@ -53,11 +53,23 @@ gulp.src(sourceFiles, { read: false })
 ```
 
 
+
+Parser
+======
+
+This new parser creates an AST of source files. The AST containes classes and
+options. Every source file ending on `Options` is treated as part of the option
+tree. Every source file ending on `Defaults` is treated as a complementary to
+options.
+
+
+
 TypeDoc
 =======
 
-The generator is not ready yet. It contains a handlebars template system and
-library scripts to generate future documentation out of TypeScript source code.
+The generator is used for internal documentation of Highcharts. It contains a
+handlebars template system and library scripts to generate documentation out of
+TypeScript source code.
 See the included [readme](https://github.com/highcharts/highcharts-documentation-generators/blob/master/typedoc/README.md)
 for development information.
 

api-docs/lib/index.js

@@ -128,20 +128,6 @@ function mergeObj(a, b, ignoreEmpty, excludeMap, noOverwrite) {
     return a;
 }
 
-function getExcludeMap(node) {
-  var map = {};
-
-  ((node && node.doclet && node.doclet.tags) || []).forEach(function (tag) {
-    if (tag.title === 'excluding' || tag.title === 'exclude') {
-        tag.value.split(',').forEach(function (p) {
-        map[p.trim()] = true;
-      });
-    }
-  });
-
-  return map;
-}
-
 function getSearchBoost(optionPath) {
 
     if (!optionPath) {
@@ -691,22 +677,6 @@ module.exports = function (input, outputPath, selectedProducts, fn) {
         }
     }
 
-    // Extract array type
-    function extractArrayType(def) {
-        var s = def.indexOf('<'),
-            s2 = def.indexOf('>'),
-            res
-        ;
-
-        if (s >= 0 && s2 >= 0) {
-            res = def.substr(s + 1, s2 - s - 1);
-
-            return res;
-        }
-
-        return 'object';
-    }
-
     // Do some transformations
     function transform(name, node, parentName, parent) {
         var s, v = false;
@@ -799,7 +769,10 @@ module.exports = function (input, outputPath, selectedProducts, fn) {
             !node.doclet.type
         ) {
             let defaultvalueForType = node.doclet.defaultvalue;
-            if (typeof node.meta.default !== 'undefined' && typeof node.doclet.defaultvalue === 'undefined') {
+            if (
+                typeof node.meta.default !== 'undefined' &&
+                typeof node.doclet.defaultvalue === 'undefined'
+            ) {
                 defaultvalueForType = node.meta.default;
             }
 
@@ -998,44 +971,13 @@ module.exports = function (input, outputPath, selectedProducts, fn) {
 
     }
 
-    function templateize(name) {
-      // Enable this to use e.g. series<type> rather than series.type
-      return name;
-
-      name = name || '';
-
-      if (name.indexOf('<') > 0) {
-        return name;
-      }
-
-      if (
-          name.indexOf('series') === 0 &&
-          name.indexOf('.') >= 0
-        ) {
-
-        name = name.replace(/\./, '<');
-
-        if (name.indexOf('.') > 0) {
-          name = name.replace(/\./, '>.');
-        } else {
-          name += '>';
-        }
-      }
-
-      return name;
-    }
-
     function dumpNav(node, opath, product, version) {
         opath += 'nav/';
 
         if ((node.children || []).length === 0) {
             return;
         }
 
-        if (node.meta && node.meta.fullname) {
-            node.meta.fullname = templateize(node.meta.fullname);
-        }
-
         fs.writeFileSync(
             opath + (node.meta.fullname || 'index') + '.json',
             JSON.stringify({
@@ -1073,18 +1015,13 @@ module.exports = function (input, outputPath, selectedProducts, fn) {
     }
 
     function generateDetails(name, node, opath, product, version, toc, constr) {
-        name = templateize(name);
         version = (version === 'current' ? versionProps.version : version);
 
         // work around #8260:
         if (name.indexOf('undefined') > 0) {
             return;
         }
 
-        if (node.meta && node.meta.fullname) {
-            node.meta.fullname = templateize(node.meta.fullname);
-        }
-
         // merge(node, node.meta.fullname);
 
         if (!node.children) {

generator/build/JSON.d.ts

@@ -0,0 +1,33 @@
+/*!*
+ *
+ *  Copyright (C) Highsoft AS
+ *
+ * */
+export declare namespace JSON {
+    type Array = globalThis.Array<(Collection | Primitive)>;
+    type Collection = (Array | Object);
+    interface Object extends Record<string, (Collection | Primitive)> {
+        [key: string]: (Collection | Primitive);
+    }
+    type Primitive = (bigint | boolean | null | number | string | undefined);
+    interface PrimitiveMap {
+        bigint: bigint;
+        boolean: boolean;
+        null: null;
+        number: number;
+        string: string;
+        undefined: undefined;
+    }
+    const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
+    /**
+     * Retrieves a value as a specific primitive type and falls back to a
+     * default value, if not successfull.
+     */
+    function get<T extends keyof PrimitiveMap>(type: T, value: unknown, defaultValue: PrimitiveMap[T]): PrimitiveMap[T];
+    /**
+     * Converts a JavaScript object to JSON notation and filters circular
+     * references by removing them.
+     */
+    function stringify(obj: unknown): string;
+}
+export default JSON;

generator/build/JSON.js

@@ -0,0 +1,13 @@
+/*!*
+ *
+ *  Copyright (C) Highsoft AS
+ *
+ * */
+import * as Parser from '../../parser/build/';
+export declare class Project {
+    static load(path: string): Promise<Project>;
+    private constructor();
+    readonly ast: Parser.Project.JSON;
+    readonly path: string;
+}
+export default Project;

generator/build/JSON.js.map

@@ -0,0 +1,17 @@
+/*!*
+ *
+ *  Copyright (C) Highsoft AS
+ *
+ * */
+import JSON from './JSON';
+export declare class Template {
+    static readonly types: Record<string, Template>;
+    static load(path: string, relativeTo?: string): Promise<Template>;
+    static loadFolder(path: string, recursive?: boolean): Promise<Array<Template>>;
+    private constructor();
+    readonly name: string;
+    readonly path: string;
+    private readonly compile;
+    write(path: string, data: JSON.Object): Promise<void>;
+}
+export default Template;