Deprecated
use ProjectsConfigurations or NxJsonConfiguration
-
↳
Workspace
- affected: NxAffectedConfig
- base: string
- cacheDirectory: string
- cli: Object
- defaultProject: string
- extends: string
- generators: Object
- implicitDependencies: ImplicitDependencyEntry<string[] | "*">
- installation: NxInstallationConfiguration
- namedInputs: Object
- nxCloudAccessToken: string
- nxCloudEncryptionKey: string
- nxCloudUrl: string
- parallel: number
- plugins: PluginConfiguration[]
- pluginsConfig: Record<string, Record<string, unknown>>
- projects: Record<string, ProjectConfiguration>
- release: NxReleaseConfiguration
- targetDefaults: TargetDefaults
- tasksRunnerOptions: Object
- useDaemonProcess: boolean
- version: number
- workspaceLayout: Object
• Optional
affected: NxAffectedConfig
Default options for nx affected
• Optional
base: string
Default value for --base used by nx affected
and nx format
.
• Optional
cacheDirectory: string
Changes the directory used by Nx to store its cache.
NxJsonConfiguration.cacheDirectory
• Optional
cli: Object
Default generator collection. It is used when no collection is provided.
Name | Type |
---|---|
defaultProjectName? |
string |
packageManager? |
PackageManager |
• Optional
defaultProject: string
Default project. When project isn't provided, the default project will be used. Convenient for small workspaces with one main application.
NxJsonConfiguration.defaultProject
• Optional
extends: string
Optional (additional) Nx.json configuration file which becomes a base for this one
• Optional
generators: Object
List of default values used by generators.
These defaults are global. They are used when no other defaults are configured.
Example:
{
"@nx/react": {
"library": {
"style": "scss"
}
}
}
▪ [collectionName: string
]: { [generatorName: string]
: any
; }
NxJsonConfiguration.generators
• 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
NxJsonConfiguration.implicitDependencies
• 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.
NxJsonConfiguration.installation
• Optional
namedInputs: Object
Named inputs targets can refer to reduce duplication
▪ [inputName: string
]: (string
| InputDefinition
)[]
NxJsonConfiguration.namedInputs
• 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
NxJsonConfiguration.nxCloudAccessToken
• Optional
nxCloudEncryptionKey: string
Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
NxJsonConfiguration.nxCloudEncryptionKey
• Optional
nxCloudUrl: string
Specifies the url pointing to an instance of nx cloud. Used for remote caching and displaying run links.
NxJsonConfiguration.nxCloudUrl
• Optional
parallel: number
Specifies how many tasks can be run in parallel.
• Optional
plugins: PluginConfiguration
[]
Plugins for extending the project graph
• Optional
pluginsConfig: Record
<string
, Record
<string
, unknown
>>
Configuration for Nx Plugins
NxJsonConfiguration.pluginsConfig
• projects: Record
<string
, ProjectConfiguration
>
Projects' projects
ProjectsConfigurations.projects
• Optional
release: NxReleaseConfiguration
ALPHA: Configuration for nx release
(versioning and publishing of applications and libraries)
• Optional
targetDefaults: TargetDefaults
Dependencies between different target names across all projects
NxJsonConfiguration.targetDefaults
• Optional
tasksRunnerOptions: Object
Available Task Runners
▪ [tasksRunnerName: string
]: { options?
: any
; runner?
: string
}
NxJsonConfiguration.tasksRunnerOptions
• Optional
useDaemonProcess: boolean
Set this to false to disable the daemon.
NxJsonConfiguration.useDaemonProcess
• version: number
Version of the configuration format
ProjectsConfigurations.version
• Optional
workspaceLayout: Object
Where new apps + libs should be placed
Name | Type |
---|---|
appsDir? |
string |
libsDir? |
string |