172 lines
9.3 KiB
Markdown
172 lines
9.3 KiB
Markdown
# @nx/devkit
|
|
|
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
|
different technologies and custom use-cases. It contains many utility
|
|
functions for reading and writing files, updating configuration,
|
|
working with Abstract Syntax Trees(ASTs), and more.
|
|
|
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
|
It only uses language primitives and immutable objects
|
|
(the tree being the only exception).
|
|
|
|
## Table of contents
|
|
|
|
### Enumerations
|
|
|
|
- [ChangeType](../../devkit/documents/ChangeType)
|
|
- [DependencyType](../../devkit/documents/DependencyType)
|
|
|
|
### Classes
|
|
|
|
- [ProjectGraphBuilder](../../devkit/documents/ProjectGraphBuilder)
|
|
- [Workspaces](../../devkit/documents/Workspaces)
|
|
|
|
### Interfaces
|
|
|
|
- [CreateDependenciesContext](../../devkit/documents/CreateDependenciesContext)
|
|
- [CreateNodesContext](../../devkit/documents/CreateNodesContext)
|
|
- [DefaultTasksRunnerOptions](../../devkit/documents/DefaultTasksRunnerOptions)
|
|
- [ExecutorContext](../../devkit/documents/ExecutorContext)
|
|
- [ExecutorsJson](../../devkit/documents/ExecutorsJson)
|
|
- [FileChange](../../devkit/documents/FileChange)
|
|
- [FileData](../../devkit/documents/FileData)
|
|
- [GeneratorsJson](../../devkit/documents/GeneratorsJson)
|
|
- [Hash](../../devkit/documents/Hash)
|
|
- [HasherContext](../../devkit/documents/HasherContext)
|
|
- [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency)
|
|
- [JsonParseOptions](../../devkit/documents/JsonParseOptions)
|
|
- [JsonSerializeOptions](../../devkit/documents/JsonSerializeOptions)
|
|
- [MigrationsJson](../../devkit/documents/MigrationsJson)
|
|
- [ModuleFederationConfig](../../devkit/documents/ModuleFederationConfig)
|
|
- [NxAffectedConfig](../../devkit/documents/NxAffectedConfig)
|
|
- [NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration)
|
|
- [ProjectConfiguration](../../devkit/documents/ProjectConfiguration)
|
|
- [ProjectFileMap](../../devkit/documents/ProjectFileMap)
|
|
- [ProjectGraph](../../devkit/documents/ProjectGraph)
|
|
- [ProjectGraphDependency](../../devkit/documents/ProjectGraphDependency)
|
|
- [ProjectGraphDependencyWithFile](../../devkit/documents/ProjectGraphDependencyWithFile)
|
|
- [ProjectGraphExternalNode](../../devkit/documents/ProjectGraphExternalNode)
|
|
- [ProjectGraphProcessorContext](../../devkit/documents/ProjectGraphProcessorContext)
|
|
- [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode)
|
|
- [ProjectsConfigurations](../../devkit/documents/ProjectsConfigurations)
|
|
- [RemoteCache](../../devkit/documents/RemoteCache)
|
|
- [SharedLibraryConfig](../../devkit/documents/SharedLibraryConfig)
|
|
- [StringDeletion](../../devkit/documents/StringDeletion)
|
|
- [StringInsertion](../../devkit/documents/StringInsertion)
|
|
- [Target](../../devkit/documents/Target)
|
|
- [TargetConfiguration](../../devkit/documents/TargetConfiguration)
|
|
- [TargetDependencyConfig](../../devkit/documents/TargetDependencyConfig)
|
|
- [Task](../../devkit/documents/Task)
|
|
- [TaskGraph](../../devkit/documents/TaskGraph)
|
|
- [TaskHasher](../../devkit/documents/TaskHasher)
|
|
- [Tree](../../devkit/documents/Tree)
|
|
- [Workspace](../../devkit/documents/Workspace)
|
|
|
|
### Type Aliases
|
|
|
|
- [AdditionalSharedConfig](../../devkit/documents/AdditionalSharedConfig)
|
|
- [CreateDependencies](../../devkit/documents/CreateDependencies)
|
|
- [CreateNodes](../../devkit/documents/CreateNodes)
|
|
- [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
|
|
- [CustomHasher](../../devkit/documents/CustomHasher)
|
|
- [Executor](../../devkit/documents/Executor)
|
|
- [Generator](../../devkit/documents/Generator)
|
|
- [GeneratorCallback](../../devkit/documents/GeneratorCallback)
|
|
- [Hasher](../../devkit/documents/Hasher)
|
|
- [ImplicitDependencyEntry](../../devkit/documents/ImplicitDependencyEntry)
|
|
- [ModuleFederationLibrary](../../devkit/documents/ModuleFederationLibrary)
|
|
- [NxPlugin](../../devkit/documents/NxPlugin)
|
|
- [NxPluginV1](../../devkit/documents/NxPluginV1)
|
|
- [NxPluginV2](../../devkit/documents/NxPluginV2)
|
|
- [PackageManager](../../devkit/documents/PackageManager)
|
|
- [ProjectGraphNode](../../devkit/documents/ProjectGraphNode)
|
|
- [ProjectTargetConfigurator](../../devkit/documents/ProjectTargetConfigurator)
|
|
- [ProjectType](../../devkit/documents/ProjectType)
|
|
- [Remotes](../../devkit/documents/Remotes)
|
|
- [SharedFunction](../../devkit/documents/SharedFunction)
|
|
- [SharedWorkspaceLibraryConfig](../../devkit/documents/SharedWorkspaceLibraryConfig)
|
|
- [StringChange](../../devkit/documents/StringChange)
|
|
- [TaskGraphExecutor](../../devkit/documents/TaskGraphExecutor)
|
|
- [WorkspaceConfiguration](../../devkit/documents/WorkspaceConfiguration)
|
|
- [WorkspaceJsonConfiguration](../../devkit/documents/WorkspaceJsonConfiguration)
|
|
- [WorkspaceLibrary](../../devkit/documents/WorkspaceLibrary)
|
|
- [WorkspaceLibrarySecondaryEntryPoint](../../devkit/documents/WorkspaceLibrarySecondaryEntryPoint)
|
|
|
|
### 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)
|
|
|
|
### Functions
|
|
|
|
- [addDependenciesToPackageJson](../../devkit/documents/addDependenciesToPackageJson)
|
|
- [addProjectConfiguration](../../devkit/documents/addProjectConfiguration)
|
|
- [applyAdditionalShared](../../devkit/documents/applyAdditionalShared)
|
|
- [applyChangesToString](../../devkit/documents/applyChangesToString)
|
|
- [applySharedFunction](../../devkit/documents/applySharedFunction)
|
|
- [convertNxExecutor](../../devkit/documents/convertNxExecutor)
|
|
- [convertNxGenerator](../../devkit/documents/convertNxGenerator)
|
|
- [createProjectFileMapUsingProjectGraph](../../devkit/documents/createProjectFileMapUsingProjectGraph)
|
|
- [createProjectGraphAsync](../../devkit/documents/createProjectGraphAsync)
|
|
- [defaultTasksRunner](../../devkit/documents/defaultTasksRunner)
|
|
- [detectPackageManager](../../devkit/documents/detectPackageManager)
|
|
- [ensurePackage](../../devkit/documents/ensurePackage)
|
|
- [extractLayoutDirectory](../../devkit/documents/extractLayoutDirectory)
|
|
- [formatFiles](../../devkit/documents/formatFiles)
|
|
- [generateFiles](../../devkit/documents/generateFiles)
|
|
- [getDependentPackagesForProject](../../devkit/documents/getDependentPackagesForProject)
|
|
- [getNpmPackageSharedConfig](../../devkit/documents/getNpmPackageSharedConfig)
|
|
- [getOutputsForTargetAndConfiguration](../../devkit/documents/getOutputsForTargetAndConfiguration)
|
|
- [getPackageManagerCommand](../../devkit/documents/getPackageManagerCommand)
|
|
- [getPackageManagerVersion](../../devkit/documents/getPackageManagerVersion)
|
|
- [getProjects](../../devkit/documents/getProjects)
|
|
- [getWorkspaceLayout](../../devkit/documents/getWorkspaceLayout)
|
|
- [getWorkspacePath](../../devkit/documents/getWorkspacePath)
|
|
- [hashArray](../../devkit/documents/hashArray)
|
|
- [installPackagesTask](../../devkit/documents/installPackagesTask)
|
|
- [isStandaloneProject](../../devkit/documents/isStandaloneProject)
|
|
- [joinPathFragments](../../devkit/documents/joinPathFragments)
|
|
- [mapRemotes](../../devkit/documents/mapRemotes)
|
|
- [mapRemotesForSSR](../../devkit/documents/mapRemotesForSSR)
|
|
- [moveFilesToNewDirectory](../../devkit/documents/moveFilesToNewDirectory)
|
|
- [names](../../devkit/documents/names)
|
|
- [normalizePath](../../devkit/documents/normalizePath)
|
|
- [offsetFromRoot](../../devkit/documents/offsetFromRoot)
|
|
- [parseJson](../../devkit/documents/parseJson)
|
|
- [parseTargetString](../../devkit/documents/parseTargetString)
|
|
- [readAllWorkspaceConfiguration](../../devkit/documents/readAllWorkspaceConfiguration)
|
|
- [readCachedProjectGraph](../../devkit/documents/readCachedProjectGraph)
|
|
- [readJson](../../devkit/documents/readJson)
|
|
- [readJsonFile](../../devkit/documents/readJsonFile)
|
|
- [readNxJson](../../devkit/documents/readNxJson)
|
|
- [readProjectConfiguration](../../devkit/documents/readProjectConfiguration)
|
|
- [readRootPackageJson](../../devkit/documents/readRootPackageJson)
|
|
- [readTargetOptions](../../devkit/documents/readTargetOptions)
|
|
- [readWorkspaceConfiguration](../../devkit/documents/readWorkspaceConfiguration)
|
|
- [removeDependenciesFromPackageJson](../../devkit/documents/removeDependenciesFromPackageJson)
|
|
- [removeProjectConfiguration](../../devkit/documents/removeProjectConfiguration)
|
|
- [reverse](../../devkit/documents/reverse)
|
|
- [runExecutor](../../devkit/documents/runExecutor)
|
|
- [runTasksInSerial](../../devkit/documents/runTasksInSerial)
|
|
- [serializeJson](../../devkit/documents/serializeJson)
|
|
- [sharePackages](../../devkit/documents/sharePackages)
|
|
- [shareWorkspaceLibraries](../../devkit/documents/shareWorkspaceLibraries)
|
|
- [stripIndents](../../devkit/documents/stripIndents)
|
|
- [stripJsonComments](../../devkit/documents/stripJsonComments)
|
|
- [targetToTargetString](../../devkit/documents/targetToTargetString)
|
|
- [toJS](../../devkit/documents/toJS)
|
|
- [updateJson](../../devkit/documents/updateJson)
|
|
- [updateNxJson](../../devkit/documents/updateNxJson)
|
|
- [updateProjectConfiguration](../../devkit/documents/updateProjectConfiguration)
|
|
- [updateTsConfigsToJs](../../devkit/documents/updateTsConfigsToJs)
|
|
- [updateWorkspaceConfiguration](../../devkit/documents/updateWorkspaceConfiguration)
|
|
- [validateDependency](../../devkit/documents/validateDependency)
|
|
- [visitNotIgnoredFiles](../../devkit/documents/visitNotIgnoredFiles)
|
|
- [workspaceLayout](../../devkit/documents/workspaceLayout)
|
|
- [writeJson](../../devkit/documents/writeJson)
|
|
- [writeJsonFile](../../devkit/documents/writeJsonFile)
|