Relax errors, fix nested property resolution for MongoDB codebase compat

Author: ShukantPal

example/package.json

@@ -27,7 +27,8 @@
     "build-next": "cd .. && webdoc && cd example",
     "build-pixi-api": "cd ../../pixi-api && webdoc && cd ../webdoc/example",
     "build-pixi-api-prod": "cd ../../pixi-api && webdoc --site-root pixi-api && cd ../webdoc/example",
-    "build-pixi-api-gcp": "cd ../../pixi-api && webdoc --tutorials ./projects/guides --verbose && cd ../webdoc/example"
+    "build-pixi-api-gcp": "cd ../../pixi-api && webdoc --tutorials ./projects/guides --verbose && cd ../webdoc/example",
+    "build-mongodb": "cd ../../node-mongodb-native && webdoc --verbose && cd ../webdoc/example"
   },
   "bugs": {
     "url": "https://github.com/SukantPal/webdoc/issues"

packages/webdoc-model/src/doc.js

@@ -11,7 +11,7 @@ import type {
 } from "@webdoc/types";
 import {nanoid} from "nanoid";
 
-const CANONICAL_SEPARATOR = /([.#~$])/g;
+export const CANONICAL_SEPARATOR = /([.#~$])/g;
 
 function updateScope(doc: Doc, scopeStack: string[], scopePath: string): void {
   if (scopePath) {
@@ -75,7 +75,7 @@ export const createDoc = (
 
     // Sad: splitting will include the separators so filter them
     const path = doc.name.split(CANONICAL_SEPARATOR)
-      .filter((ch) => ch !== "." && ch !== "#" && ch !== "#");
+      .filter((ch) => ch !== "." && ch !== "#" && ch !== "~");
     const parserOpts = doc.parserOpts || {};
 
     doc.name = path[path.length - 1];

packages/webdoc-parser/src/tag-parsers/parseProperty.js

@@ -1,7 +1,7 @@
 // @flow
 import type {BaseDoc, PropertyTag} from "@webdoc/types";
 import {StringUtils, matchDataTypeClosure, matchDefaultValueClosure} from "./helper";
-import {createDoc} from "@webdoc/model";
+import {createDoc, findDoc, CANONICAL_SEPARATOR} from "@webdoc/model";
 import {parseDataType} from "@webdoc/model";
 
 // @property {<DATA_TYPE>} <NAME>                      - <DESC>
@@ -103,7 +103,7 @@ export function parseProperty(value: string, doc: $Shape<BaseDoc>): PropertyTag
     doc.members = [];
   }
 
-  doc.members.push(createDoc(name, "PropertyDoc", {
+  const propertyDoc = createDoc(name, "PropertyDoc", {
     object: null,
     constant: !!dataValue,
     dataType: dataType ? parseDataType(dataType) : undefined,
@@ -113,7 +113,21 @@ export function parseProperty(value: string, doc: $Shape<BaseDoc>): PropertyTag
     optional,
     scope: "default", // related-resolution doctree-mod will resolve this
     loc: doc.loc,
-  }));
+  });
+  let parent = doc;
+
+  // Properties cannot be relocated. Attempt to do it locally
+  if (propertyDoc.parserOpts && propertyDoc.parserOpts.memberof) {
+    delete propertyDoc.parserOpts.memberof;
+
+    parent = findDoc(name.split(CANONICAL_SEPARATOR).slice(0, -2).join("."), doc);
+  }
+
+  if (parent) {
+    doc.members.push(propertyDoc);
+  } else {
+    throw new Error('Property ' + name + '\'s parent cannot be located. Did you declare parent properties?');
+  }
 
   return {
     name: "property",

packages/webdoc-parser/src/validators/validate-parameters.js

@@ -20,7 +20,7 @@ function validateParameters(doc: DocShape, meta: SymbolSignature): void {
     const name = param.identifier;
 
     if (!name) {
-      throw new Error("Anonymous documented parameters are not supported");
+      console.warn("Anonymous documented parameters are not supported");
     }
 
     const dotIndex = name.indexOf(".");
@@ -33,14 +33,14 @@ function validateParameters(doc: DocShape, meta: SymbolSignature): void {
       // @param {string} string
       // @param {string} options.title
       if (firstId !== lastParam) {
-        throw new Error(`Object property ${name} parameter must be placed` +
+        console.warn(`Object property ${name} parameter must be placed` +
               `directly after object parameter ${firstId}`);
       }
 
       continue;
     }
     if (j >= metaParams.length) {
-      throw new Error(`"${name}" is not a parameter & cannot` +
+      console.warn(`"${name}" is not a parameter & cannot` +
             ` come after the last parameter "${lastParam || ""}"`);
     }