docs(misc): render values correctly (#9712)

nrwl · Apr 8, 2022 · 96db3c5 · 96db3c5 · vercel · Apr 8, 2022
1 parent 7c7e415
commit 96db3c5
Show file tree

Hide file tree

Showing 12 changed files with 17 additions and 15 deletions.
diff --git a/docs/generated/cli/affected-apps.md b/docs/generated/cli/affected-apps.md
@@ -59,7 +59,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/affected-graph.md b/docs/generated/cli/affected-graph.md
@@ -77,7 +77,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/affected-libs.md b/docs/generated/cli/affected-libs.md
@@ -59,7 +59,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md
@@ -77,7 +77,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/create-nx-workspace.md b/docs/generated/cli/create-nx-workspace.md
@@ -35,7 +35,7 @@ The name of the application when a preset with pregenerated app is selected
 
 Type: string
 
-Choices: ["nx", "angular"]
+Choices: [nx, angular]
 
 CLI to power the Nx workspace
 
@@ -75,7 +75,7 @@ Use Nx Cloud
 
 Type: string
 
-Choices: ["npm", "pnpm", "yarn"]
+Choices: [npm, pnpm, yarn]
 
 Default: npm
 
@@ -85,7 +85,7 @@ Package manager to use
 
 Type: string
 
-Choices: ["apps", "empty", "core", "npm", "ts", "web-components", "angular", "angular-nest", "react", "react-express", "react-native", "next", "nest", "express"]
+Choices: [apps, empty, core, npm, ts, web-components, angular, angular-nest, react, react-express, react-native, next, nest, express]
 
 Customizes the initial content of your workspace. To build your own see https://nx.dev/nx-plugin/overview#preset
 

diff --git a/docs/generated/cli/format-check.md b/docs/generated/cli/format-check.md
@@ -39,7 +39,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/format-write.md b/docs/generated/cli/format-write.md
@@ -39,7 +39,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/print-affected.md b/docs/generated/cli/print-affected.md
@@ -71,7 +71,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md
@@ -53,7 +53,7 @@ This is the configuration to use when performing tasks on projects
 
 Type: array
 
-Default:
+Default: []
 
 Exclude certain projects from being processed
 

diff --git a/nx-dev/feature-package-schema-viewer/src/lib/parameter-metadata.ts b/nx-dev/feature-package-schema-viewer/src/lib/parameter-metadata.ts
@@ -18,7 +18,7 @@ export function getParameterMetadata(schema: JsonSchema): ParameterMetadata[] {
     return {
       name,
       key: slugify(name),
-      value: String(value),
+      value: JSON.stringify(value).replace(/"/g, ''),
     };
   }
 

diff --git a/nx-dev/feature-package-schema-viewer/src/lib/parameter-view.tsx b/nx-dev/feature-package-schema-viewer/src/lib/parameter-view.tsx
@@ -96,7 +96,7 @@ function ParameterEnums({
       Accepted values:{' '}
       {potentialEnums.map((e, i) => (
         <span key={'enums-' + e}>
-          <code>{e}</code>
+          <code>{JSON.stringify(e).replace(/"/g, '')}</code>
           {potentialEnums.length === i + 1 ? null : ', '}
         </span>
       ))}

diff --git a/scripts/documentation/utils.ts b/scripts/documentation/utils.ts
@@ -200,11 +200,13 @@ export function generateOptionsMarkdown(command): string {
         }
         if (option.choices !== undefined) {
           response += dedent`
-          Choices: [${option.choices.map((c) => `"${c}"`).join(', ')}]\n`;
+          Choices: [${option.choices
+            .map((c) => JSON.stringify(c).replace(/"/g, ''))
+            .join(', ')}]\n`;
         }
         if (option.default !== undefined && option.default !== '') {
           response += dedent`
-          Default: ${option.default}\n`;
+          Default: ${JSON.stringify(option.default).replace(/"/g, '')}\n`;
         }
         response += dedent`
               ${formatDeprecated(option.description, option.deprecated)}