docs: updates, typedoc fixes

cube-js · Jul 2, 2020 · 0bf55cb · 0bf55cb
1 parent 0b050bc
commit 0bf55cb
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 8 deletions.
diff --git a/docs-gen/package.json b/docs-gen/package.json
@@ -8,8 +8,9 @@
   ],
   "scripts": {
     "lint": "tslint --project ./tsconfig.json",
-    "generate": "yarn build && typedoc --excludeExternals --includeDeclarations --plugin ./dist/index.js --hideSources --hideIndexes --out ../docs/Cube.js-Frontend --name @cubejs-client-core ../packages/cubejs-client-core/index.d.ts",
-    "dev-generate": "copyfiles --up 1 ./src/**/*.hbs ./dist/ && yarn generate",
+    "generate": "yarn build && yarn gen-docs",
+    "gen-docs": "typedoc --excludeExternals --includeDeclarations --plugin ./dist/index.js --hideSources --hideIndexes --out ../docs/Cube.js-Frontend --name @cubejs-client-core ../packages/cubejs-client-core/index.d.ts",
+    "dev-gen": "copyfiles --up 1 ./src/**/*.hbs ./dist/ && yarn gen-docs",
     "build": "rm -rf dist && tsc --sourceMap false --declaration false && copyfiles --up 1 ./src/**/*.hbs ./dist/",
     "watch": "tsc-watch",
     "prepublishOnly": "yarn test",

diff --git a/docs-gen/src/resources/helpers/declaration-title.ts b/docs-gen/src/resources/helpers/declaration-title.ts
@@ -24,7 +24,13 @@ export function declarationTitle(this: DeclarationReflection, showSymbol: boolea
     md.push(memberSymbol.call(this));
   }
 
-  md.push(`**${this.name}**${isOptional ? '? ' : ''}:`);
+  md.push(`**${this.name}**${isOptional ? '? ' : ''}`);
+
+  // We want to display enum members like:
+  // • DAY = "day"
+  if (this.kind !== ReflectionKind.EnumMember) {
+    md.push(':');
+  }
 
   if (this.type) {
     md.push(`*${type.call(this.type)}*`);

diff --git a/docs-gen/src/resources/helpers/member-title.ts b/docs-gen/src/resources/helpers/member-title.ts
@@ -3,9 +3,9 @@ import { DeclarationReflection } from 'typedoc';
 export function memberTitle(this: DeclarationReflection) {
   const md = [];
 
-  if (this.flags) {
-    md.push(this.flags.map((flag) => `\`${flag}\``).join(' '));
-  }
+  // if (this.flags) {
+    // md.push(this.flags.map((flag) => `\`${flag}\``).join(' '));
+  // }
   md.push(this.name);
   return md.join(' ');
 }
diff --git a/docs-gen/src/resources/helpers/meta.ts b/docs-gen/src/resources/helpers/meta.ts
@@ -27,8 +27,7 @@ export function meta(this: ProjectReflection) {
 
     (comment?.tags || []).forEach((tag: CommentTag) => {
       if (tag.tagName !== 'description') {
-        const escape = tag.tagName !== 'menuorder';
-        const text = escape ? `'${tag.text}'` : tag.text;
+        const text = tag.text.startsWith('@') ? `'${tag.text}'` : tag.text;
         md.push(`${tagConverter(tag.tagName)}: ${text}`.replace('\n', ''));
       }
     });

diff --git a/docs-gen/src/resources/helpers/signature-title.ts b/docs-gen/src/resources/helpers/signature-title.ts
@@ -10,6 +10,12 @@ export function signatureTitle(this: SignatureReflection, showSymbol: boolean) {
     md.push(`${memberSymbol.call(this)} `);
   }
 
+  // eg: `static`
+  if (this.parent?.flags) {
+    md.push(this.parent.flags.map((flag) => `\`${flag}\``).join(' ').toLowerCase());
+    md.push(' ');
+  }
+
   if (this.name === '__get') {
     md.push(`**get ${this.parent.name}**`);
   } else if (this.name === '__set') {

diff --git a/docs/Schema/dimensions.md b/docs/Schema/dimensions.md
@@ -166,3 +166,18 @@ dimensions: {
   }
 }
 ```
+
+### meta
+Custom metadata. Can be used to pass any information to the frontend.
+```javascript
+dimensions: {
+  usersCount: {
+    sql: `${Users.count}`,
+    type: `number`,
+    //...
+    meta: {
+      any: 'value
+    }
+  }
+}
+```
diff --git a/docs/Schema/measures.md b/docs/Schema/measures.md
@@ -155,6 +155,19 @@ revenue: {
 }
 ```
 
+### meta
+Custom metadata. Can be used to pass any information to the frontend.
+```javascript
+revenue: {
+  type: `sum`,
+  sql: `price`,
+  //...
+  meta: {
+    any: 'value'
+  }
+}
+```
+
 ## Calculated Measures
 In the case where you need to specify a formula for measure calculating with other measures, you can compose a formula in `sql`. For example, you want to calculate the conversion of buyers of all users.