feat(nx-dev): types in devkit toc (#18594)

2023-08-18 11:54:36 -04:00 · 2023-08-18 11:54:36 -04:00 · 71d2994be9
commit 71d2994be9
parent 8390b9ed2d
46 changed files with 7940 additions and 2397 deletions
--- a/docs/generated/devkit/CreateDependenciesContext.md
+++ b/docs/generated/devkit/CreateDependenciesContext.md
@ -6,11 +6,11 @@ Context for [CreateDependencies](../../devkit/documents/CreateDependencies)

 ### Properties

- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap)
- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess)
- [graph](../../devkit/documents/CreateDependenciesContext#graph)
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration)
- [projectsConfigurations](../../devkit/documents/CreateDependenciesContext#projectsconfigurations)
+- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap): ProjectFileMap
+- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess): ProjectFileMap
+- [graph](../../devkit/documents/CreateDependenciesContext#graph): ProjectGraph
+- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
+- [projectsConfigurations](../../devkit/documents/CreateDependenciesContext#projectsconfigurations): ProjectsConfigurations

 ## Properties

--- a/docs/generated/devkit/CreateNodesContext.md
+++ b/docs/generated/devkit/CreateNodesContext.md
@ -6,8 +6,8 @@ Context for [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)

 ### Properties

- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration)
- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot)
+- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
+- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot): string

 ## Properties

--- a/docs/generated/devkit/DefaultTasksRunnerOptions.md
+++ b/docs/generated/devkit/DefaultTasksRunnerOptions.md
@ -4,15 +4,15 @@

 ### Properties

- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory)
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations)
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets)
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr)
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle)
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel)
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache)
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs)
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache)
+- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory): string
+- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations): string[]
+- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets): string[]
+- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr): boolean
+- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle): LifeCycle
+- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel): number
+- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache): RemoteCache
+- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs): string[]
+- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache): boolean

 ## Properties

--- a/docs/generated/devkit/ExecutorContext.md
+++ b/docs/generated/devkit/ExecutorContext.md
@ -6,18 +6,18 @@ Context that is passed into an executor

 ### Properties

- [configurationName](../../devkit/documents/ExecutorContext#configurationname)
- [cwd](../../devkit/documents/ExecutorContext#cwd)
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose)
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration)
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph)
- [projectName](../../devkit/documents/ExecutorContext#projectname)
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations)
- [root](../../devkit/documents/ExecutorContext#root)
- [target](../../devkit/documents/ExecutorContext#target)
- [targetName](../../devkit/documents/ExecutorContext#targetname)
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph)
- [workspace](../../devkit/documents/ExecutorContext#workspace)
+- [configurationName](../../devkit/documents/ExecutorContext#configurationname): string
+- [cwd](../../devkit/documents/ExecutorContext#cwd): string
+- [isVerbose](../../devkit/documents/ExecutorContext#isverbose): boolean
+- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
+- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph): ProjectGraph
+- [projectName](../../devkit/documents/ExecutorContext#projectname): string
+- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations): ProjectsConfigurations
+- [root](../../devkit/documents/ExecutorContext#root): string
+- [target](../../devkit/documents/ExecutorContext#target): TargetConfiguration&lt;any&gt;
+- [targetName](../../devkit/documents/ExecutorContext#targetname): string
+- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph): TaskGraph
+- [workspace](../../devkit/documents/ExecutorContext#workspace): ProjectsConfigurations &amp; NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;

 ## Properties

--- a/docs/generated/devkit/ExecutorsJson.md
+++ b/docs/generated/devkit/ExecutorsJson.md
@ -4,8 +4,8 @@

 ### Properties

- [builders](../../devkit/documents/ExecutorsJson#builders)
- [executors](../../devkit/documents/ExecutorsJson#executors)
+- [builders](../../devkit/documents/ExecutorsJson#builders): Record&lt;string, ExecutorsJsonEntry&gt;
+- [executors](../../devkit/documents/ExecutorsJson#executors): Record&lt;string, ExecutorsJsonEntry&gt;

 ## Properties

--- a/docs/generated/devkit/FileChange.md
+++ b/docs/generated/devkit/FileChange.md
@ -6,10 +6,10 @@ Description of a file change in the Nx virtual file system/

 ### Properties

- [content](../../devkit/documents/FileChange#content)
- [options](../../devkit/documents/FileChange#options)
- [path](../../devkit/documents/FileChange#path)
- [type](../../devkit/documents/FileChange#type)
+- [content](../../devkit/documents/FileChange#content): Buffer
+- [options](../../devkit/documents/FileChange#options): TreeWriteOptions
+- [path](../../devkit/documents/FileChange#path): string
+- [type](../../devkit/documents/FileChange#type): &quot;CREATE&quot; | &quot;DELETE&quot; | &quot;UPDATE&quot;

 ## Properties

--- a/docs/generated/devkit/FileData.md
+++ b/docs/generated/devkit/FileData.md
@ -6,9 +6,9 @@ Some metadata about a file

 ### Properties

- [deps](../../devkit/documents/FileData#deps)
- [file](../../devkit/documents/FileData#file)
- [hash](../../devkit/documents/FileData#hash)
+- [deps](../../devkit/documents/FileData#deps): (string | [string, string])[]
+- [file](../../devkit/documents/FileData#file): string
+- [hash](../../devkit/documents/FileData#hash): string

 ## Properties

--- a/docs/generated/devkit/GeneratorsJson.md
+++ b/docs/generated/devkit/GeneratorsJson.md
@ -4,9 +4,9 @@

 ### Properties

- [extends](../../devkit/documents/GeneratorsJson#extends)
- [generators](../../devkit/documents/GeneratorsJson#generators)
- [schematics](../../devkit/documents/GeneratorsJson#schematics)
+- [extends](../../devkit/documents/GeneratorsJson#extends): string
+- [generators](../../devkit/documents/GeneratorsJson#generators): Record&lt;string, GeneratorsJsonEntry&gt;
+- [schematics](../../devkit/documents/GeneratorsJson#schematics): Record&lt;string, GeneratorsJsonEntry&gt;

 ## Properties

--- a/docs/generated/devkit/Hash.md
+++ b/docs/generated/devkit/Hash.md
@ -6,8 +6,8 @@ A data structure returned by the default hasher.

 ### Properties

- [details](../../devkit/documents/Hash#details)
- [value](../../devkit/documents/Hash#value)
+- [details](../../devkit/documents/Hash#details): Object
+- [value](../../devkit/documents/Hash#value): string

 ## Properties

--- a/docs/generated/devkit/HasherContext.md
+++ b/docs/generated/devkit/HasherContext.md
@ -4,11 +4,11 @@

 ### Properties

- [hasher](../../devkit/documents/HasherContext#hasher)
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration)
- [projectGraph](../../devkit/documents/HasherContext#projectgraph)
- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations)
- [taskGraph](../../devkit/documents/HasherContext#taskgraph)
+- [hasher](../../devkit/documents/HasherContext#hasher): TaskHasher
+- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
+- [projectGraph](../../devkit/documents/HasherContext#projectgraph): ProjectGraph
+- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations): ProjectsConfigurations
+- [taskGraph](../../devkit/documents/HasherContext#taskgraph): TaskGraph

 ## Properties

--- a/docs/generated/devkit/JsonParseOptions.md
+++ b/docs/generated/devkit/JsonParseOptions.md
@ -10,10 +10,10 @@

 ### Properties

- [allowEmptyContent](../../devkit/documents/JsonParseOptions#allowemptycontent)
- [allowTrailingComma](../../devkit/documents/JsonParseOptions#allowtrailingcomma)
- [disallowComments](../../devkit/documents/JsonParseOptions#disallowcomments)
- [expectComments](../../devkit/documents/JsonParseOptions#expectcomments)
+- [allowEmptyContent](../../devkit/documents/JsonParseOptions#allowemptycontent): boolean
+- [allowTrailingComma](../../devkit/documents/JsonParseOptions#allowtrailingcomma): boolean
+- [disallowComments](../../devkit/documents/JsonParseOptions#disallowcomments): boolean
+- [expectComments](../../devkit/documents/JsonParseOptions#expectcomments): boolean

 ## Properties

--- a/docs/generated/devkit/JsonSerializeOptions.md
+++ b/docs/generated/devkit/JsonSerializeOptions.md
@ -4,7 +4,7 @@

 ### Properties

- [spaces](../../devkit/documents/JsonSerializeOptions#spaces)
+- [spaces](../../devkit/documents/JsonSerializeOptions#spaces): number

 ## Properties

--- a/docs/generated/devkit/MigrationsJson.md
+++ b/docs/generated/devkit/MigrationsJson.md
@ -4,12 +4,12 @@

 ### Properties

- [collection](../../devkit/documents/MigrationsJson#collection)
- [generators](../../devkit/documents/MigrationsJson#generators)
- [name](../../devkit/documents/MigrationsJson#name)
- [packageJsonUpdates](../../devkit/documents/MigrationsJson#packagejsonupdates)
- [schematics](../../devkit/documents/MigrationsJson#schematics)
- [version](../../devkit/documents/MigrationsJson#version)
+- [collection](../../devkit/documents/MigrationsJson#collection): string
+- [generators](../../devkit/documents/MigrationsJson#generators): Object
+- [name](../../devkit/documents/MigrationsJson#name): string
+- [packageJsonUpdates](../../devkit/documents/MigrationsJson#packagejsonupdates): PackageJsonUpdates
+- [schematics](../../devkit/documents/MigrationsJson#schematics): Object
+- [version](../../devkit/documents/MigrationsJson#version): string

 ## Properties

--- a/docs/generated/devkit/ModuleFederationConfig.md
+++ b/docs/generated/devkit/ModuleFederationConfig.md
@ -4,12 +4,12 @@

 ### Properties

- [additionalShared](../../devkit/documents/ModuleFederationConfig#additionalshared)
- [exposes](../../devkit/documents/ModuleFederationConfig#exposes)
- [library](../../devkit/documents/ModuleFederationConfig#library)
- [name](../../devkit/documents/ModuleFederationConfig#name)
- [remotes](../../devkit/documents/ModuleFederationConfig#remotes)
- [shared](../../devkit/documents/ModuleFederationConfig#shared)
+- [additionalShared](../../devkit/documents/ModuleFederationConfig#additionalshared): AdditionalSharedConfig
+- [exposes](../../devkit/documents/ModuleFederationConfig#exposes): Record&lt;string, string&gt;
+- [library](../../devkit/documents/ModuleFederationConfig#library): ModuleFederationLibrary
+- [name](../../devkit/documents/ModuleFederationConfig#name): string
+- [remotes](../../devkit/documents/ModuleFederationConfig#remotes): Remotes
+- [shared](../../devkit/documents/ModuleFederationConfig#shared): SharedFunction

 ## Properties

--- a/docs/generated/devkit/NxAffectedConfig.md
+++ b/docs/generated/devkit/NxAffectedConfig.md
@ -4,7 +4,7 @@

 ### Properties

- [defaultBase](../../devkit/documents/NxAffectedConfig#defaultbase)
+- [defaultBase](../../devkit/documents/NxAffectedConfig#defaultbase): string

 ## Properties

--- a/docs/generated/devkit/NxJsonConfiguration.md
+++ b/docs/generated/devkit/NxJsonConfiguration.md
@ -2,8 +2,6 @@

 Nx.json configuration

-@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts
-
 ## Type parameters

 | Name | Type                |
@ -20,20 +18,20 @@ Nx.json configuration

 ### Properties

- [affected](../../devkit/documents/NxJsonConfiguration#affected)
- [cli](../../devkit/documents/NxJsonConfiguration#cli)
- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject)
- [extends](../../devkit/documents/NxJsonConfiguration#extends)
- [generators](../../devkit/documents/NxJsonConfiguration#generators)
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies)
- [installation](../../devkit/documents/NxJsonConfiguration#installation)
- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs)
- [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope)
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins)
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig)
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults)
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout)
+- [affected](../../devkit/documents/NxJsonConfiguration#affected): NxAffectedConfig
+- [cli](../../devkit/documents/NxJsonConfiguration#cli): Object
+- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
+- [extends](../../devkit/documents/NxJsonConfiguration#extends): string
+- [generators](../../devkit/documents/NxJsonConfiguration#generators): Object
+- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry&lt;T&gt;
+- [installation](../../devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
+- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
+- [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
+- [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
+- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record&lt;string, unknown&gt;
+- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
+- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
+- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object

 ## Properties

--- a/docs/generated/devkit/ProjectConfiguration.md
+++ b/docs/generated/devkit/ProjectConfiguration.md
@ -2,21 +2,19 @@

 Project configuration

-@note: when adding properties here add them to `allowedProjectExtensions` in adapter/compat.ts
-
 ## Table of contents

 ### Properties

- [generators](../../devkit/documents/ProjectConfiguration#generators)
- [implicitDependencies](../../devkit/documents/ProjectConfiguration#implicitdependencies)
- [name](../../devkit/documents/ProjectConfiguration#name)
- [namedInputs](../../devkit/documents/ProjectConfiguration#namedinputs)
- [projectType](../../devkit/documents/ProjectConfiguration#projecttype)
- [root](../../devkit/documents/ProjectConfiguration#root)
- [sourceRoot](../../devkit/documents/ProjectConfiguration#sourceroot)
- [tags](../../devkit/documents/ProjectConfiguration#tags)
- [targets](../../devkit/documents/ProjectConfiguration#targets)
+- [generators](../../devkit/documents/ProjectConfiguration#generators): Object
+- [implicitDependencies](../../devkit/documents/ProjectConfiguration#implicitdependencies): string[]
+- [name](../../devkit/documents/ProjectConfiguration#name): string
+- [namedInputs](../../devkit/documents/ProjectConfiguration#namedinputs): Object
+- [projectType](../../devkit/documents/ProjectConfiguration#projecttype): ProjectType
+- [root](../../devkit/documents/ProjectConfiguration#root): string
+- [sourceRoot](../../devkit/documents/ProjectConfiguration#sourceroot): string
+- [tags](../../devkit/documents/ProjectConfiguration#tags): string[]
+- [targets](../../devkit/documents/ProjectConfiguration#targets): Object

 ## Properties

--- a/docs/generated/devkit/ProjectGraph.md
+++ b/docs/generated/devkit/ProjectGraph.md
@ -6,10 +6,10 @@ A Graph of projects in the workspace and dependencies between them

 ### Properties

- [dependencies](../../devkit/documents/ProjectGraph#dependencies)
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes)
- [nodes](../../devkit/documents/ProjectGraph#nodes)
- [version](../../devkit/documents/ProjectGraph#version)
+- [dependencies](../../devkit/documents/ProjectGraph#dependencies): Record&lt;string, ProjectGraphDependency[]&gt;
+- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes): Record&lt;string, ProjectGraphExternalNode&gt;
+- [nodes](../../devkit/documents/ProjectGraph#nodes): Record&lt;string, ProjectGraphProjectNode&gt;
+- [version](../../devkit/documents/ProjectGraph#version): string

 ## Properties

--- a/docs/generated/devkit/ProjectGraphBuilder.md
+++ b/docs/generated/devkit/ProjectGraphBuilder.md
@ -14,9 +14,9 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/

 ### Properties

- [fileMap](../../devkit/documents/ProjectGraphBuilder#filemap)
- [graph](../../devkit/documents/ProjectGraphBuilder#graph)
- [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges)
+- [fileMap](../../devkit/documents/ProjectGraphBuilder#filemap): ProjectFileMap
+- [graph](../../devkit/documents/ProjectGraphBuilder#graph): ProjectGraph
+- [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges): Object

 ### Methods

--- a/docs/generated/devkit/ProjectGraphDependency.md
+++ b/docs/generated/devkit/ProjectGraphDependency.md
@ -6,9 +6,9 @@ A dependency between two projects

 ### Properties

- [source](../../devkit/documents/ProjectGraphDependency#source)
- [target](../../devkit/documents/ProjectGraphDependency#target)
- [type](../../devkit/documents/ProjectGraphDependency#type)
+- [source](../../devkit/documents/ProjectGraphDependency#source): string
+- [target](../../devkit/documents/ProjectGraphDependency#target): string
+- [type](../../devkit/documents/ProjectGraphDependency#type): string

 ## Properties

--- a/docs/generated/devkit/ProjectGraphDependencyWithFile.md
+++ b/docs/generated/devkit/ProjectGraphDependencyWithFile.md
@ -7,10 +7,10 @@ Optional: Specifies a file from where the dependency is made

 ### Properties

- [dependencyType](../../devkit/documents/ProjectGraphDependencyWithFile#dependencytype)
- [source](../../devkit/documents/ProjectGraphDependencyWithFile#source)
- [sourceFile](../../devkit/documents/ProjectGraphDependencyWithFile#sourcefile)
- [target](../../devkit/documents/ProjectGraphDependencyWithFile#target)
+- [dependencyType](../../devkit/documents/ProjectGraphDependencyWithFile#dependencytype): DependencyType
+- [source](../../devkit/documents/ProjectGraphDependencyWithFile#source): string
+- [sourceFile](../../devkit/documents/ProjectGraphDependencyWithFile#sourcefile): string
+- [target](../../devkit/documents/ProjectGraphDependencyWithFile#target): string

 ## Properties

--- a/docs/generated/devkit/ProjectGraphExternalNode.md
+++ b/docs/generated/devkit/ProjectGraphExternalNode.md
@ -13,9 +13,9 @@ while allowing tracking of the full tree of different nested versions

 ### Properties

- [data](../../devkit/documents/ProjectGraphExternalNode#data)
- [name](../../devkit/documents/ProjectGraphExternalNode#name)
- [type](../../devkit/documents/ProjectGraphExternalNode#type)
+- [data](../../devkit/documents/ProjectGraphExternalNode#data): Object
+- [name](../../devkit/documents/ProjectGraphExternalNode#name): &#x60;npm:${string}&#x60;
+- [type](../../devkit/documents/ProjectGraphExternalNode#type): &quot;npm&quot;

 ## Properties

--- a/docs/generated/devkit/ProjectGraphProcessorContext.md
+++ b/docs/generated/devkit/ProjectGraphProcessorContext.md
@ -10,11 +10,11 @@ The ProjectGraphProcessor is deprecated. This will be removed in Nx 18.

 ### Properties

- [fileMap](../../devkit/documents/ProjectGraphProcessorContext#filemap)
- [filesToProcess](../../devkit/documents/ProjectGraphProcessorContext#filestoprocess)
- [nxJsonConfiguration](../../devkit/documents/ProjectGraphProcessorContext#nxjsonconfiguration)
- [projectsConfigurations](../../devkit/documents/ProjectGraphProcessorContext#projectsconfigurations)
- [workspace](../../devkit/documents/ProjectGraphProcessorContext#workspace)
+- [fileMap](../../devkit/documents/ProjectGraphProcessorContext#filemap): ProjectFileMap
+- [filesToProcess](../../devkit/documents/ProjectGraphProcessorContext#filestoprocess): ProjectFileMap
+- [nxJsonConfiguration](../../devkit/documents/ProjectGraphProcessorContext#nxjsonconfiguration): NxJsonConfiguration&lt;string[] | &quot;\*&quot;&gt;
+- [projectsConfigurations](../../devkit/documents/ProjectGraphProcessorContext#projectsconfigurations): ProjectsConfigurations
+- [workspace](../../devkit/documents/ProjectGraphProcessorContext#workspace): Workspace

 ## Properties

--- a/docs/generated/devkit/ProjectGraphProjectNode.md
+++ b/docs/generated/devkit/ProjectGraphProjectNode.md
@ -6,9 +6,9 @@ A node describing a project in a workspace

 ### Properties

- [data](../../devkit/documents/ProjectGraphProjectNode#data)
- [name](../../devkit/documents/ProjectGraphProjectNode#name)
- [type](../../devkit/documents/ProjectGraphProjectNode#type)
+- [data](../../devkit/documents/ProjectGraphProjectNode#data): ProjectConfiguration &amp; Object
+- [name](../../devkit/documents/ProjectGraphProjectNode#name): string
+- [type](../../devkit/documents/ProjectGraphProjectNode#type): &quot;app&quot; | &quot;e2e&quot; | &quot;lib&quot;

 ## Properties

--- a/docs/generated/devkit/ProjectsConfigurations.md
+++ b/docs/generated/devkit/ProjectsConfigurations.md
@ -1,7 +1,6 @@
 # Interface: ProjectsConfigurations

 Projects Configurations
-@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts

 ## Hierarchy

@ -13,8 +12,8 @@ Projects Configurations

 ### Properties

- [projects](../../devkit/documents/ProjectsConfigurations#projects)
- [version](../../devkit/documents/ProjectsConfigurations#version)
+- [projects](../../devkit/documents/ProjectsConfigurations#projects): Object
+- [version](../../devkit/documents/ProjectsConfigurations#version): number

 ## Properties

--- a/docs/generated/devkit/README.md
+++ b/docs/generated/devkit/README.md
@ -94,12 +94,12 @@ It only uses language primitives and immutable objects

 ### Variables

- [NX_VERSION](../../devkit/documents/NX_VERSION)
- [appRootPath](../../devkit/documents/appRootPath)
- [cacheDir](../../devkit/documents/cacheDir)
- [logger](../../devkit/documents/logger)
- [output](../../devkit/documents/output)
- [workspaceRoot](../../devkit/documents/workspaceRoot)
+- [NX_VERSION](../../devkit/documents/NX_VERSION): string
+- [appRootPath](../../devkit/documents/appRootPath): string
+- [cacheDir](../../devkit/documents/cacheDir): string
+- [logger](../../devkit/documents/logger): Object
+- [output](../../devkit/documents/output): CLIOutput
+- [workspaceRoot](../../devkit/documents/workspaceRoot): string

 ### Functions

--- a/docs/generated/devkit/RemoteCache.md
+++ b/docs/generated/devkit/RemoteCache.md
@ -4,8 +4,8 @@

 ### Properties

- [retrieve](../../devkit/documents/RemoteCache#retrieve)
- [store](../../devkit/documents/RemoteCache#store)
+- [retrieve](../../devkit/documents/RemoteCache#retrieve): Function
+- [store](../../devkit/documents/RemoteCache#store): Function

 ## Properties

--- a/docs/generated/devkit/SharedLibraryConfig.md
+++ b/docs/generated/devkit/SharedLibraryConfig.md
@ -4,10 +4,10 @@

 ### Properties

- [eager](../../devkit/documents/SharedLibraryConfig#eager)
- [requiredVersion](../../devkit/documents/SharedLibraryConfig#requiredversion)
- [singleton](../../devkit/documents/SharedLibraryConfig#singleton)
- [strictVersion](../../devkit/documents/SharedLibraryConfig#strictversion)
+- [eager](../../devkit/documents/SharedLibraryConfig#eager): boolean
+- [requiredVersion](../../devkit/documents/SharedLibraryConfig#requiredversion): string | false
+- [singleton](../../devkit/documents/SharedLibraryConfig#singleton): boolean
+- [strictVersion](../../devkit/documents/SharedLibraryConfig#strictversion): boolean

 ## Properties

--- a/docs/generated/devkit/StringDeletion.md
+++ b/docs/generated/devkit/StringDeletion.md
@ -4,9 +4,9 @@

 ### Properties

- [length](../../devkit/documents/StringDeletion#length)
- [start](../../devkit/documents/StringDeletion#start)
- [type](../../devkit/documents/StringDeletion#type)
+- [length](../../devkit/documents/StringDeletion#length): number
+- [start](../../devkit/documents/StringDeletion#start): number
+- [type](../../devkit/documents/StringDeletion#type): Delete

 ## Properties

--- a/docs/generated/devkit/StringInsertion.md
+++ b/docs/generated/devkit/StringInsertion.md
@ -4,9 +4,9 @@

 ### Properties

- [index](../../devkit/documents/StringInsertion#index)
- [text](../../devkit/documents/StringInsertion#text)
- [type](../../devkit/documents/StringInsertion#type)
+- [index](../../devkit/documents/StringInsertion#index): number
+- [text](../../devkit/documents/StringInsertion#text): string
+- [type](../../devkit/documents/StringInsertion#type): Insert

 ## Properties

--- a/docs/generated/devkit/Target.md
+++ b/docs/generated/devkit/Target.md
@ -4,9 +4,9 @@

 ### Properties

- [configuration](../../devkit/documents/Target#configuration)
- [project](../../devkit/documents/Target#project)
- [target](../../devkit/documents/Target#target)
+- [configuration](../../devkit/documents/Target#configuration): string
+- [project](../../devkit/documents/Target#project): string
+- [target](../../devkit/documents/Target#target): string

 ## Properties

--- a/docs/generated/devkit/TargetConfiguration.md
+++ b/docs/generated/devkit/TargetConfiguration.md
@ -12,14 +12,14 @@ Target's configuration

 ### Properties

- [command](../../devkit/documents/TargetConfiguration#command)
- [configurations](../../devkit/documents/TargetConfiguration#configurations)
- [defaultConfiguration](../../devkit/documents/TargetConfiguration#defaultconfiguration)
- [dependsOn](../../devkit/documents/TargetConfiguration#dependson)
- [executor](../../devkit/documents/TargetConfiguration#executor)
- [inputs](../../devkit/documents/TargetConfiguration#inputs)
- [options](../../devkit/documents/TargetConfiguration#options)
- [outputs](../../devkit/documents/TargetConfiguration#outputs)
+- [command](../../devkit/documents/TargetConfiguration#command): string
+- [configurations](../../devkit/documents/TargetConfiguration#configurations): Object
+- [defaultConfiguration](../../devkit/documents/TargetConfiguration#defaultconfiguration): string
+- [dependsOn](../../devkit/documents/TargetConfiguration#dependson): (string | TargetDependencyConfig)[]
+- [executor](../../devkit/documents/TargetConfiguration#executor): string
+- [inputs](../../devkit/documents/TargetConfiguration#inputs): (string | InputDefinition)[]
+- [options](../../devkit/documents/TargetConfiguration#options): T
+- [outputs](../../devkit/documents/TargetConfiguration#outputs): string[]

 ## Properties

--- a/docs/generated/devkit/TargetDependencyConfig.md
+++ b/docs/generated/devkit/TargetDependencyConfig.md
@ -4,10 +4,10 @@

 ### Properties

- [dependencies](../../devkit/documents/TargetDependencyConfig#dependencies)
- [params](../../devkit/documents/TargetDependencyConfig#params)
- [projects](../../devkit/documents/TargetDependencyConfig#projects)
- [target](../../devkit/documents/TargetDependencyConfig#target)
+- [dependencies](../../devkit/documents/TargetDependencyConfig#dependencies): boolean
+- [params](../../devkit/documents/TargetDependencyConfig#params): &quot;ignore&quot; | &quot;forward&quot;
+- [projects](../../devkit/documents/TargetDependencyConfig#projects): string | string[]
+- [target](../../devkit/documents/TargetDependencyConfig#target): string

 ## Properties

--- a/docs/generated/devkit/Task.md
+++ b/docs/generated/devkit/Task.md
@ -6,14 +6,14 @@ A representation of the invocation of an Executor

 ### Properties

- [endTime](../../devkit/documents/Task#endtime)
- [hash](../../devkit/documents/Task#hash)
- [hashDetails](../../devkit/documents/Task#hashdetails)
- [id](../../devkit/documents/Task#id)
- [overrides](../../devkit/documents/Task#overrides)
- [projectRoot](../../devkit/documents/Task#projectroot)
- [startTime](../../devkit/documents/Task#starttime)
- [target](../../devkit/documents/Task#target)
+- [endTime](../../devkit/documents/Task#endtime): number
+- [hash](../../devkit/documents/Task#hash): string
+- [hashDetails](../../devkit/documents/Task#hashdetails): Object
+- [id](../../devkit/documents/Task#id): string
+- [overrides](../../devkit/documents/Task#overrides): any
+- [projectRoot](../../devkit/documents/Task#projectroot): string
+- [startTime](../../devkit/documents/Task#starttime): number
+- [target](../../devkit/documents/Task#target): Object

 ## Properties

--- a/docs/generated/devkit/TaskGraph.md
+++ b/docs/generated/devkit/TaskGraph.md
@ -6,9 +6,9 @@ Graph of Tasks to be executed

 ### Properties

- [dependencies](../../devkit/documents/TaskGraph#dependencies)
- [roots](../../devkit/documents/TaskGraph#roots)
- [tasks](../../devkit/documents/TaskGraph#tasks)
+- [dependencies](../../devkit/documents/TaskGraph#dependencies): Record&lt;string, string[]&gt;
+- [roots](../../devkit/documents/TaskGraph#roots): string[]
+- [tasks](../../devkit/documents/TaskGraph#tasks): Record&lt;string, Task&gt;

 ## Properties

--- a/docs/generated/devkit/Tree.md
+++ b/docs/generated/devkit/Tree.md
@ -6,7 +6,7 @@ Virtual file system tree.

 ### Properties

- [root](../../devkit/documents/Tree#root)
+- [root](../../devkit/documents/Tree#root): string

 ### Methods

--- a/docs/generated/devkit/Workspace.md
+++ b/docs/generated/devkit/Workspace.md
@ -16,22 +16,22 @@ use ProjectsConfigurations or NxJsonConfiguration

 ### Properties

- [affected](../../devkit/documents/Workspace#affected)
- [cli](../../devkit/documents/Workspace#cli)
- [defaultProject](../../devkit/documents/Workspace#defaultproject)
- [extends](../../devkit/documents/Workspace#extends)
- [generators](../../devkit/documents/Workspace#generators)
- [implicitDependencies](../../devkit/documents/Workspace#implicitdependencies)
- [installation](../../devkit/documents/Workspace#installation)
- [namedInputs](../../devkit/documents/Workspace#namedinputs)
- [npmScope](../../devkit/documents/Workspace#npmscope)
- [plugins](../../devkit/documents/Workspace#plugins)
- [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig)
- [projects](../../devkit/documents/Workspace#projects)
- [targetDefaults](../../devkit/documents/Workspace#targetdefaults)
- [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions)
- [version](../../devkit/documents/Workspace#version)
- [workspaceLayout](../../devkit/documents/Workspace#workspacelayout)
+- [affected](../../devkit/documents/Workspace#affected): NxAffectedConfig
+- [cli](../../devkit/documents/Workspace#cli): Object
+- [defaultProject](../../devkit/documents/Workspace#defaultproject): string
+- [extends](../../devkit/documents/Workspace#extends): string
+- [generators](../../devkit/documents/Workspace#generators): Object
+- [implicitDependencies](../../devkit/documents/Workspace#implicitdependencies): ImplicitDependencyEntry&lt;string[] | &quot;\*&quot;&gt;
+- [installation](../../devkit/documents/Workspace#installation): NxInstallationConfiguration
+- [namedInputs](../../devkit/documents/Workspace#namedinputs): Object
+- [npmScope](../../devkit/documents/Workspace#npmscope): string
+- [plugins](../../devkit/documents/Workspace#plugins): string[]
+- [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record&lt;string, unknown&gt;
+- [projects](../../devkit/documents/Workspace#projects): Record&lt;string, ProjectConfiguration&gt;
+- [targetDefaults](../../devkit/documents/Workspace#targetdefaults): TargetDefaults
+- [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
+- [version](../../devkit/documents/Workspace#version): number
+- [workspaceLayout](../../devkit/documents/Workspace#workspacelayout): Object

 ## Properties

--- a/docs/generated/devkit/Workspaces.md
+++ b/docs/generated/devkit/Workspaces.md
@ -12,7 +12,7 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../

 ### Properties

- [root](../../devkit/documents/Workspaces#root)
+- [root](../../devkit/documents/Workspaces#root): string

 ### Methods

--- a/docs/generated/devkit/ngcli_adapter/NxScopedHost.md
+++ b/docs/generated/devkit/ngcli_adapter/NxScopedHost.md
@ -14,9 +14,9 @@

 ### Properties

- [\_delegate](../../devkit/documents/ngcli_adapter/NxScopedHost#_delegate)
- [\_root](../../devkit/documents/ngcli_adapter/NxScopedHost#_root)
- [root](../../devkit/documents/ngcli_adapter/NxScopedHost#root)
+- [\_delegate](../../devkit/documents/ngcli_adapter/NxScopedHost#_delegate): Host&lt;any&gt;
+- [\_root](../../devkit/documents/ngcli_adapter/NxScopedHost#_root): Path
+- [root](../../devkit/documents/ngcli_adapter/NxScopedHost#root): string

 ### Accessors

--- a/docs/generated/packages/devkit/documents/nx_devkit.md
+++ b/docs/generated/packages/devkit/documents/nx_devkit.md
@ -94,12 +94,12 @@ It only uses language primitives and immutable objects

 ### Variables

- [NX_VERSION](../../devkit/documents/NX_VERSION)
- [appRootPath](../../devkit/documents/appRootPath)
- [cacheDir](../../devkit/documents/cacheDir)
- [logger](../../devkit/documents/logger)
- [output](../../devkit/documents/output)
- [workspaceRoot](../../devkit/documents/workspaceRoot)
+- [NX_VERSION](../../devkit/documents/NX_VERSION): string
+- [appRootPath](../../devkit/documents/appRootPath): string
+- [cacheDir](../../devkit/documents/cacheDir): string
+- [logger](../../devkit/documents/logger): Object
+- [output](../../devkit/documents/output): CLIOutput
+- [workspaceRoot](../../devkit/documents/workspaceRoot): string

 ### Functions

--- a/package.json
+++ b/package.json
@ -181,6 +181,7 @@
    "fs-extra": "^11.1.0",
    "github-slugger": "^2.0.0",
    "gpt3-tokenizer": "^1.1.5",
+    "handlebars": "4.7.7",
    "html-webpack-plugin": "5.5.0",
    "http-server": "14.1.0",
    "husky": "^8.0.1",
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
--- a/scripts/documentation/generators/generate-devkit-documentation.ts
+++ b/scripts/documentation/generators/generate-devkit-documentation.ts
@ -7,7 +7,8 @@ export function generateDevkitDocumentation() {
  console.log(`\n${chalk.blue('i')} Generating Documentation for Devkit\n`);

  const execSyncOptions: ExecSyncOptions = {
-    stdio: process.env.CI === 'true' ? 'inherit' : 'ignore',
+    stdio: 'true' === 'true' ? 'inherit' : 'ignore',
+    // stdio: process.env.CI === 'true' ? 'inherit' : 'ignore',
  };

  execSync(
--- a/typedoc-theme/src/lib/comment.ts
+++ b/typedoc-theme/src/lib/comment.ts
@ -0,0 +1,51 @@
+import * as Handlebars from 'handlebars';
+import { CommentDisplayPart } from 'typedoc/dist/lib/models/comments/comment';
+
+export default function () {
+  Handlebars.registerHelper('comment', function (parts: CommentDisplayPart[]) {
+    const result: string[] = [];
+    for (const part of parts) {
+      switch (part.kind) {
+        case 'text':
+        case 'code':
+          result.push(part.text);
+          break;
+        case 'inline-tag':
+          switch (part.tag) {
+            case '@label':
+            case '@inheritdoc':
+              break;
+            case '@link':
+            case '@linkcode':
+            case '@linkplain': {
+              if (part.target) {
+                const url =
+                  typeof part.target === 'string'
+                    ? part.target
+                    : Handlebars.helpers.relativeURL((part.target as any).url);
+                const wrap = part.tag === '@linkcode' ? '`' : '';
+                result.push(
+                  url ? `[${wrap}${part.text}${wrap}](${url})` : part.text
+                );
+              } else {
+                result.push(part.text);
+              }
+              break;
+            }
+            default:
+              result.push(`{${part.tag} ${part.text}}`);
+              break;
+          }
+          break;
+        default:
+          result.push('');
+      }
+    }
+
+    return result
+      .join('')
+      .split('\n')
+      .filter((line) => !line.startsWith('@note'))
+      .join('\n');
+  });
+}
--- a/typedoc-theme/src/lib/theme.ts
+++ b/typedoc-theme/src/lib/theme.ts
@ -1,5 +1,7 @@
 import { PageEvent, Reflection, ReflectionKind, RenderTemplate } from 'typedoc';
 import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme';
+import comment from './comment';
+import toc from './toc';

 /**
 * The MarkdownTheme is based on TypeDoc's DefaultTheme @see https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/themes/DefaultTheme.ts.
@ -10,6 +12,8 @@ import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme';
 export default class NxMarkdownTheme extends MarkdownTheme {
  constructor(renderer) {
    super(renderer);
+    toc(this);
+    comment();
  }

  render(
--- a/typedoc-theme/src/lib/toc.ts
+++ b/typedoc-theme/src/lib/toc.ts
@ -0,0 +1,90 @@
+import * as Handlebars from 'handlebars';
+import {
+  DeclarationReflection,
+  ProjectReflection,
+  ReflectionGroup,
+  ReflectionKind,
+} from 'typedoc';
+import NxMarkdownTheme from './theme';
+
+export function escapeChars(str: string) {
+  return str
+    .replace(/>/g, '\\>')
+    .replace(/_/g, '\\_')
+    .replace(/`/g, '\\`')
+    .replace(/\|/g, '\\|');
+}
+export function stripLineBreaks(str: string) {
+  return str
+    ? str
+        .replace(/\n/g, ' ')
+        .replace(/\r/g, ' ')
+        .replace(/\t/g, ' ')
+        .replace(/[\s]{2,}/g, ' ')
+        .trim()
+    : '';
+}
+
+export default function (theme: NxMarkdownTheme) {
+  Handlebars.registerHelper(
+    'toc',
+    function (this: ProjectReflection | DeclarationReflection) {
+      const md: string[] = [];
+
+      const { hideInPageTOC } = theme;
+
+      const isVisible = this.groups?.some((group) =>
+        group.allChildrenHaveOwnDocument()
+      );
+
+      function pushGroup(group: ReflectionGroup, md: string[]) {
+        const children = group.children.map((child) => {
+          const propertyType = [
+            ReflectionKind.Property,
+            ReflectionKind.Variable,
+          ].includes(child.kind)
+            ? ': ' + getPropertyType(child)
+            : '';
+          return `- [${escapeChars(
+            child.name
+          )}](${Handlebars.helpers.relativeURL(child.url)})${propertyType}`;
+        });
+        md.push(children.join('\n'));
+      }
+
+      if ((!hideInPageTOC && this.groups) || (isVisible && this.groups)) {
+        if (!hideInPageTOC) {
+          md.push(`## Table of contents\n\n`);
+        }
+        const headingLevel = hideInPageTOC ? `##` : `###`;
+        this.groups?.forEach((group) => {
+          const groupTitle = group.title;
+          if (group.categories) {
+            group.categories.forEach((category) => {
+              md.push(`${headingLevel} ${category.title} ${groupTitle}\n\n`);
+              pushGroup(category as any, md);
+              md.push('\n');
+            });
+          } else {
+            if (!hideInPageTOC || group.allChildrenHaveOwnDocument()) {
+              md.push(`${headingLevel} ${groupTitle}\n\n`);
+              pushGroup(group, md);
+              md.push('\n');
+            }
+          }
+        });
+      }
+      return md.length > 0 ? md.join('\n') : null;
+    }
+  );
+}
+
+function getPropertyType(property: any) {
+  if (property.getSignature) {
+    return property.getSignature.type;
+  }
+  if (property.setSignature) {
+    return property.setSignature.type;
+  }
+  return property.type ? property.type : property;
+}