Interface: Workspace
Deprecated
use ProjectsConfigurations or NxJsonConfiguration
Hierarchy
↳
Workspace
Table of contents
Properties
- affected: NxAffectedConfig
- cacheDirectory: string
- cli: Object
- defaultProject: string
- extends: string
- generators: Object
- implicitDependencies: ImplicitDependencyEntry<string[] | "*">
- installation: NxInstallationConfiguration
- namedInputs: Object
- npmScope: string
- nxCloudAccessToken: string
- nxCloudEncryptionKey: string
- nxCloudUrl: string
- parallel: number
- plugins: string[]
- pluginsConfig: Record<string, unknown>
- projects: Record<string, ProjectConfiguration>
- release: NxReleaseConfiguration
- targetDefaults: TargetDefaults
- tasksRunnerOptions: Object
- useDaemonProcess: boolean
- version: number
- workspaceLayout: Object
Properties
affected
• Optional affected: NxAffectedConfig
Default options for nx affected
Inherited from
cacheDirectory
• Optional cacheDirectory: string
Changes the directory used by Nx to store its cache.
Inherited from
NxJsonConfiguration.cacheDirectory
cli
• Optional cli: Object
Default generator collection. It is used when no collection is provided.
Type declaration
| Name | Type | Description |
|---|---|---|
defaultCollection? | string | Deprecated - defaultCollection is deprecated and will be removed |
defaultProjectName? | string | - |
packageManager? | PackageManager | - |
Inherited from
defaultProject
• Optional defaultProject: string
Default project. When project isn't provided, the default project will be used. Convenient for small workspaces with one main application.
Inherited from
NxJsonConfiguration.defaultProject
extends
• Optional extends: string
Optional (additional) Nx.json configuration file which becomes a base for this one
Inherited from
generators
• Optional generators: Object
List of default values used by generators.
These defaults are global. They are used when no other defaults are configured.
Example:
1{
2 "@nx/react": {
3 "library": {
4 "style": "scss"
5 }
6 }
7}
8Index signature
▪ [collectionName: string]: { [generatorName: string]: any; }
Inherited from
NxJsonConfiguration.generators
implicitDependencies
• Optional implicitDependencies: ImplicitDependencyEntry<string[] | "*">
Map of files to projects that implicitly depend on them
Deprecated
use namedInputs instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
Inherited from
NxJsonConfiguration.implicitDependencies
installation
• Optional installation: NxInstallationConfiguration
Configures the Nx installation for a repo. Useful for maintaining a separate set of dependencies for Nx + Plugins compared to the base package.json, but also useful for workspaces that don't have a root package.json + node_modules.
Inherited from
NxJsonConfiguration.installation
namedInputs
• Optional namedInputs: Object
Named inputs targets can refer to reduce duplication
Index signature
▪ [inputName: string]: (string | InputDefinition)[]
Inherited from
NxJsonConfiguration.namedInputs
npmScope
• Optional npmScope: string
Deprecated
This is inferred from the package.json in the workspace root. Please use getNpmScope instead. NPM Scope that the workspace uses
Inherited from
nxCloudAccessToken
• Optional nxCloudAccessToken: string
If specified Nx will use nx-cloud by default with the given token. To use a different runner that accepts an access token, define it in tasksRunnerOptions
Inherited from
NxJsonConfiguration.nxCloudAccessToken
nxCloudEncryptionKey
• Optional nxCloudEncryptionKey: string
Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
Inherited from
NxJsonConfiguration.nxCloudEncryptionKey
nxCloudUrl
• Optional nxCloudUrl: string
Specifies the url pointing to an instance of nx cloud. Used for remote caching and displaying run links.
Inherited from
NxJsonConfiguration.nxCloudUrl
parallel
• Optional parallel: number
Specifies how many tasks can be run in parallel.
Inherited from
plugins
• Optional plugins: string[]
Plugins for extending the project graph
Inherited from
pluginsConfig
• Optional pluginsConfig: Record<string, unknown>
Configuration for Nx Plugins
Inherited from
NxJsonConfiguration.pluginsConfig
projects
• projects: Record<string, ProjectConfiguration>
Projects' projects
Overrides
ProjectsConfigurations.projects
release
• Optional release: NxReleaseConfiguration
ALPHA: Configuration for nx release (versioning and publishing of applications and libraries)
Inherited from
targetDefaults
• Optional targetDefaults: TargetDefaults
Dependencies between different target names across all projects
Inherited from
NxJsonConfiguration.targetDefaults
tasksRunnerOptions
• Optional tasksRunnerOptions: Object
Available Task Runners
Index signature
▪ [tasksRunnerName: string]: { options?: any ; runner: string }
Inherited from
NxJsonConfiguration.tasksRunnerOptions
useDaemonProcess
• Optional useDaemonProcess: boolean
Set this to false to disable the daemon.
Inherited from
NxJsonConfiguration.useDaemonProcess
version
• version: number
Version of the configuration format
Inherited from
ProjectsConfigurations.version
workspaceLayout
• Optional workspaceLayout: Object
Where new apps + libs should be placed
Type declaration
| Name | Type |
|---|---|
appsDir? | string |
libsDir? | string |