diff --git a/nx-dev/feature-package-schema-viewer/src/lib/content.tsx b/nx-dev/feature-package-schema-viewer/src/lib/content.tsx index 97c1ec86161411..740b94e0ac3d25 100644 --- a/nx-dev/feature-package-schema-viewer/src/lib/content.tsx +++ b/nx-dev/feature-package-schema-viewer/src/lib/content.tsx @@ -1,7 +1,9 @@ +import { HandRaisedIcon } from '@heroicons/react/24/outline'; import { XCircleIcon } from '@heroicons/react/24/solid'; import { getSchemaFromReference } from '@nrwl/nx-dev/data-access-packages'; import { JsonSchema1, NxSchema } from '@nrwl/nx-dev/models-package'; import { renderMarkdown } from '@nrwl/nx-dev/ui-markdoc'; +import cx from 'classnames'; import Link from 'next/link'; import { useRouter } from 'next/router'; import React, { ReactNode, useState } from 'react'; @@ -94,7 +96,7 @@ export function Content({ return (
-
+
+ {schemaViewModel.hidden && ( + + )}
@@ -137,6 +148,25 @@ export function Content({ {/* We remove the top description on sub property lookup */} {!schemaViewModel.subReference && ( <> + + + + + + + Schema for internal use only + + + Please do not extend this schema as it is part of Nx internal + usage. + + + +
{vm.markdown}
diff --git a/nx-dev/feature-package-schema-viewer/src/lib/get-schema-view-model.ts b/nx-dev/feature-package-schema-viewer/src/lib/get-schema-view-model.ts index ec86847566db7a..8e2441233402b9 100644 --- a/nx-dev/feature-package-schema-viewer/src/lib/get-schema-view-model.ts +++ b/nx-dev/feature-package-schema-viewer/src/lib/get-schema-view-model.ts @@ -27,6 +27,7 @@ export interface SchemaViewModel { currentSchema: NxSchema | null; currentSchemaExamples: Example | Errors; type: 'executors' | 'generators'; + hidden: boolean; } export function getSchemaViewModel( @@ -64,5 +65,6 @@ export function getSchemaViewModel( ); }, type: schemaRequest.type, + hidden: schemaMetadata.hidden, }; } diff --git a/nx-dev/feature-package-schema-viewer/src/lib/ui/package-reference.tsx b/nx-dev/feature-package-schema-viewer/src/lib/ui/package-reference.tsx index 7caf5f0bca6e44..dd41e34509d481 100644 --- a/nx-dev/feature-package-schema-viewer/src/lib/ui/package-reference.tsx +++ b/nx-dev/feature-package-schema-viewer/src/lib/ui/package-reference.tsx @@ -126,6 +126,12 @@ function SchemaListItem({ {schema.name} + + {schema.hidden && ( + + Internal + + )}

{renderMarkdown({