@graphcommerce/graphql-codegen-markdown-docs 7.1.0-canary.8 → 8.0.0-canary.40

package/CHANGELOG.md

@@ -1,5 +1,73 @@
 # Change Log
 
+## 8.0.0-canary.40
+
+### Patch Changes
+
+- [#2077](https://github.com/graphcommerce-org/graphcommerce/pull/2077) [`2e46389ed`](https://github.com/graphcommerce-org/graphcommerce/commit/2e46389edcd506c490cd7273be384e5c42df4a9e) - Render framework/config.md more nicely, so that we follow a more typescript-esque style, inline enums. ([@bramvanderholst](https://github.com/bramvanderholst))
+
+## 7.1.0-canary.39
+
+## 7.1.0-canary.38
+
+## 7.1.0-canary.37
+
+## 7.1.0-canary.36
+
+## 7.1.0-canary.35
+
+## 7.1.0-canary.34
+
+## 7.1.0-canary.33
+
+## 7.1.0-canary.32
+
+## 7.1.0-canary.31
+
+## 7.1.0-canary.30
+
+## 7.1.0-canary.29
+
+## 7.1.0-canary.28
+
+## 7.1.0-canary.27
+
+## 7.1.0-canary.26
+
+## 7.1.0-canary.25
+
+## 7.1.0-canary.24
+
+## 7.1.0-canary.23
+
+## 7.1.0-canary.22
+
+## 7.1.0-canary.21
+
+## 7.1.0-canary.20
+
+## 7.1.0-canary.19
+
+## 7.1.0-canary.18
+
+## 7.1.0-canary.17
+
+## 7.1.0-canary.16
+
+## 7.1.0-canary.15
+
+## 7.1.0-canary.14
+
+## 7.1.0-canary.13
+
+## 7.1.0-canary.12
+
+## 7.1.0-canary.11
+
+## 7.1.0-canary.10
+
+## 7.1.0-canary.9
+
 ## 7.1.0-canary.8
 
 ## 7.0.2-canary.7

package/dist/index.js

@@ -17,8 +17,14 @@ config) => {
         }
         return node.description ? `\n\n${node.description}` : '';
     };
-    const possibleScalars = ['Boolean', 'String', 'Int', 'Float', 'ID'];
-    const content = (0, graphql_1.visit)(astNode, {
+    const possibleScalars = {
+        Boolean: 'boolean',
+        String: 'string',
+        Int: 'number',
+        Float: 'number',
+        ID: 'string',
+    };
+    let content = (0, graphql_1.visit)(astNode, {
         Document: {
             leave: (node) => `<!-- Automatically generated from Config.graphqls -->${node.definitions
                 .filter(Boolean)
@@ -26,46 +32,62 @@ config) => {
         },
         Name: { leave: (node) => node.value },
         NamedType: {
-            leave: (node) => possibleScalars.includes(node.name) ? node.name : `[${node.name}](#${node.name})`,
+            leave: (node) => possibleScalars[node.name] ?? `[${node.name}](#${node.name})`,
         },
         StringValue: { leave: (node) => node.value },
-        BooleanValue: { leave: (node) => node.value },
-        EnumValue: { leave: (node) => node.value },
+        BooleanValue: {
+            leave: (node) => (node.value ? 'true' : 'false'),
+        },
+        EnumValue: { leave: (node) => `'${node.value}'` },
         IntValue: { leave: (node) => node.value },
+        ObjectValue: {
+            leave: (node) => {
+                const fields = node.fields.join(', ') ?? '';
+                return `{ ${fields} }`;
+            },
+        },
         FloatValue: { leave: (node) => node.value },
-        ListType: { leave: (node) => `[${node.type}]` },
+        ListType: {
+            leave: (node) => `${node.type.replace(' (required)', '')}[]`,
+        },
+        ObjectField: { leave: (node) => `${node.name}: ${node.value}` },
         NonNullType: {
-            leave: (node) => `${node.type}!`,
+            leave: (node) => `${node.type} (required)`,
         },
         InputValueDefinition: {
             leave: (node) => {
-                const defaultValue = node.defaultValue ? ` (default: ${node.defaultValue})` : '';
-                return `\`${node.name}: ${node.type}${defaultValue}\`${descriptionText(node)}`;
+                const defaultValue = node.defaultValue ? ` = ${node.defaultValue}` : '';
+                return `${node.name}: ${node.type}${defaultValue}${descriptionText(node)}`;
             },
         },
         InputObjectTypeDefinition: {
             enter: (node) => ({
                 ...node,
                 // Move required fields to the top.
-                fields: [...(node.fields ?? [])].sort((a, b) => a.type.kind === 'NonNullType' && b.type.kind !== 'NonNullType' ? -1 : 1),
+                fields: [...(node.fields ?? [])].sort((a, b) => 
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+                a.type.kind === 'NonNullType' && b.type.kind !== 'NonNullType' ? -1 : 1),
             }),
             leave: (node) => {
-                const title = descriptionText(node).trimStart().startsWith('#')
-                    ? `${descriptionText(node).trimStart()}\n\n### ${node.name}`
-                    : `### ${node.name}${descriptionText(node)}`;
+                const text = descriptionText(node);
+                const title = text.trimStart().startsWith('#')
+                    ? `${text.trimStart()}\n\n### ${node.name}`
+                    : `### ${node.name}${text}`;
                 return `\n${title}\n${node.fields?.map((f) => `\n#### ${f}`).join('\n')}`;
             },
         },
-        EnumValueDefinition: {
-            leave: (node) => `${node.name} # ${node.description}`,
-        },
+        EnumValueDefinition: { leave: (node) => node.name },
         EnumTypeDefinition: {
             leave: (node) => {
-                enumStings.set(node.name, node.values?.join('\n') || '');
+                if (node.values)
+                    enumStings.set(node.name, node.values.map((v) => `'${v.trim()}'`).join(' | '));
                 return '';
             },
         },
     });
+    enumStings.forEach((value, key) => {
+        content = content.replaceAll(`[${key}](#${key})`, value);
+    });
     return { content };
 };
 exports.plugin = plugin;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/graphql-codegen-markdown-docs",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "7.1.0-canary.8",
+  "version": "8.0.0-canary.40",
   "sideEffects": false,
   "type": "commonjs",
   "main": "dist/index.js",
@@ -20,20 +20,18 @@
       "project": "./tsconfig.json"
     }
   },
-  "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "7.1.0-canary.8",
-    "@graphcommerce/prettier-config-pwa": "7.1.0-canary.8",
-    "@graphcommerce/typescript-config-pwa": "7.1.0-canary.8"
-  },
   "dependencies": {
     "@graphql-codegen/add": "5.0.0",
     "@graphql-codegen/plugin-helpers": "5.0.1",
     "@graphql-codegen/visitor-plugin-common": "4.0.1",
-    "@graphql-tools/utils": "^10.0.1",
-    "@types/parse-filepath": "^1.0.0",
+    "@graphql-tools/utils": "^10.0.8",
+    "@types/parse-filepath": "^1.0.2",
     "parse-filepath": "^1.0.2"
   },
   "peerDependencies": {
+    "@graphcommerce/eslint-config-pwa": "8.0.0-canary.40",
+    "@graphcommerce/prettier-config-pwa": "8.0.0-canary.40",
+    "@graphcommerce/typescript-config-pwa": "8.0.0-canary.40",
     "graphql": "^16.7.1"
   }
 }

package/src/index.ts

@@ -25,9 +25,15 @@ export const plugin: PluginFunction<MarkdownDocsPluginConfig, Types.ComplexPlugi
     return node.description ? `\n\n${node.description}` : ''
   }
 
-  const possibleScalars = ['Boolean', 'String', 'Int', 'Float', 'ID']
+  const possibleScalars: Record<string, string> = {
+    Boolean: 'boolean',
+    String: 'string',
+    Int: 'number',
+    Float: 'number',
+    ID: 'string',
+  }
 
-  const content = visit<string>(astNode, {
+  let content = visit<string>(astNode, {
     Document: {
       leave: (node) =>
         `<!-- Automatically generated from Config.graphqls -->${node.definitions
@@ -36,22 +42,32 @@ export const plugin: PluginFunction<MarkdownDocsPluginConfig, Types.ComplexPlugi
     },
     Name: { leave: (node) => node.value },
     NamedType: {
-      leave: (node) =>
-        possibleScalars.includes(node.name) ? node.name : `[${node.name}](#${node.name})`,
+      leave: (node) => possibleScalars[node.name] ?? `[${node.name}](#${node.name})`,
     }, // String, Boolean, GraphCommerceDebugConfig, etc.
     StringValue: { leave: (node) => node.value },
-    BooleanValue: { leave: (node) => node.value },
-    EnumValue: { leave: (node) => node.value },
+    BooleanValue: {
+      leave: (node) => (node.value ? 'true' : 'false'),
+    },
+    EnumValue: { leave: (node) => `'${node.value}'` },
     IntValue: { leave: (node) => node.value },
+    ObjectValue: {
+      leave: (node) => {
+        const fields = node.fields.join(', ') ?? ''
+        return `{ ${fields} }`
+      },
+    },
     FloatValue: { leave: (node) => node.value },
-    ListType: { leave: (node) => `[${node.type}]` },
+    ListType: {
+      leave: (node) => `${node.type.replace(' (required)', '')}[]`,
+    },
+    ObjectField: { leave: (node) => `${node.name}: ${node.value}` },
     NonNullType: {
-      leave: (node) => `${node.type}!`,
+      leave: (node) => `${node.type} (required)`,
     },
     InputValueDefinition: {
       leave: (node) => {
-        const defaultValue = node.defaultValue ? ` (default: ${node.defaultValue})` : ''
-        return `\`${node.name}: ${node.type}${defaultValue}\`${descriptionText(node)}`
+        const defaultValue = node.defaultValue ? ` = ${node.defaultValue}` : ''
+        return `${node.name}: ${node.type}${defaultValue}${descriptionText(node)}`
       },
     },
     InputObjectTypeDefinition: {
@@ -59,27 +75,32 @@ export const plugin: PluginFunction<MarkdownDocsPluginConfig, Types.ComplexPlugi
         ...node,
         // Move required fields to the top.
         fields: [...(node.fields ?? [])].sort((a, b) =>
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
           a.type.kind === 'NonNullType' && b.type.kind !== 'NonNullType' ? -1 : 1,
         ),
       }),
       leave: (node) => {
-        const title = descriptionText(node).trimStart().startsWith('#')
-          ? `${descriptionText(node).trimStart()}\n\n### ${node.name}`
-          : `### ${node.name}${descriptionText(node)}`
+        const text = descriptionText(node)
+        const title = text.trimStart().startsWith('#')
+          ? `${text.trimStart()}\n\n### ${node.name}`
+          : `### ${node.name}${text}`
 
         return `\n${title}\n${node.fields?.map((f) => `\n#### ${f}`).join('\n')}`
       },
     },
-    EnumValueDefinition: {
-      leave: (node) => `${node.name} # ${node.description}`,
-    },
+    EnumValueDefinition: { leave: (node) => node.name },
     EnumTypeDefinition: {
       leave: (node) => {
-        enumStings.set(node.name, node.values?.join('\n') || '')
+        if (node.values)
+          enumStings.set(node.name, node.values.map((v) => `'${v.trim()}'`).join(' | '))
         return ''
       },
     },
   })
 
+  enumStings.forEach((value, key) => {
+    content = content.replaceAll(`[${key}](#${key})`, value)
+  })
+
   return { content }
 }