Improved node docs (#1900)

* Minor improvements * Fixed example input data * Code golfing * console.log
chaiNNer-org · Jun 29, 2023 · 4d37c0c · 4d37c0c
1 parent 97ebf81
commit 4d37c0c
Show file tree

Hide file tree

Showing 19 changed files with 359 additions and 235 deletions.
diff --git a/src/common/common-types.ts b/src/common/common-types.ts
@@ -143,7 +143,7 @@ export interface Output {
     readonly label: string;
     readonly kind: OutputKind;
     readonly hasHandle: boolean;
-    readonly description?: string;
+    readonly description?: string | null;
     readonly examples?: readonly string[] | null;
 }
 

diff --git a/src/common/types/pretty.ts b/src/common/types/pretty.ts
@@ -1,4 +1,5 @@
-import { Type } from '@chainner/navi';
+/* eslint-disable no-continue */
+import { Type, ValueType } from '@chainner/navi';
 import { assertNever } from '../util';
 
 export const prettyPrintType = (type: Type): string => {
@@ -21,10 +22,36 @@ export const prettyPrintType = (type: Type): string => {
             if (type.min === 0 && type.max === Infinity) {
                 return 'uint';
             }
+            if (type.min + 1 === type.max) {
+                return `${type.min} | ${type.max}`;
+            }
             return type.toString();
 
-        case 'union':
-            return type.items.map(prettyPrintType).join(' | ');
+        case 'union': {
+            const literals: number[] = [];
+            const other: ValueType[] = [];
+            for (const item of type.items) {
+                if (item.underlying === 'number') {
+                    if (item.type === 'literal' && Number.isFinite(item.value)) {
+                        literals.push(item.value);
+                        continue;
+                    }
+                    if (item.type === 'int-interval' && item.min + 1 === item.max) {
+                        literals.push(item.min);
+                        literals.push(item.max);
+                        continue;
+                    }
+                }
+                other.push(item);
+            }
+
+            const union = [...literals, ...other.map(prettyPrintType)].join(' | ');
+
+            // hacky way to detect boolean
+            if (union === 'false | true') return 'bool';
+
+            return union;
+        }
 
         case 'struct':
             if (type.fields.length === 0) return type.name;

diff --git a/src/common/util.ts b/src/common/util.ts
@@ -2,7 +2,7 @@ import { constants } from 'fs';
 import fs from 'fs/promises';
 import { LocalStorage } from 'node-localstorage';
 import { v4 as uuid4, v5 as uuid5 } from 'uuid';
-import type { InputData, InputId, InputValue, NodeSchema, OutputId } from './common-types';
+import type { Input, InputData, InputId, InputValue, NodeSchema, OutputId } from './common-types';
 
 export const EMPTY_ARRAY: readonly never[] = [];
 export const EMPTY_SET: ReadonlySet<never> = new Set<never>();
@@ -273,3 +273,6 @@ export const getInputValue = <T extends NonNullable<InputValue>>(
 ): T | undefined => {
     return (inputData[inputId] ?? undefined) as T | undefined;
 };
+
+export const isAutoInput = (input: Input): boolean =>
+    input.kind === 'generic' && input.optional && !input.hasHandle;