NxJsonConfiguration

Nx.json configuration

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

• NxJsonConfiguration

  ↳ Workspace

• $schema
• affected
• analytics
• cacheDirectory
• cli
• defaultBase
• defaultProject
• extends
• generators
• implicitDependencies
• installation
• maxCacheSize
• namedInputs
• neverConnectToCloud
• nxCloudAccessToken
• nxCloudEncryptionKey
• nxCloudId
• nxCloudUrl
• parallel
• plugins
• pluginsConfig
• release
• sync
• targetDefaults
• tasksRunnerOptions
• tui
• useDaemonProcess
• useInferencePlugins
• workspaceLayout

• Optional $schema: string

• Optional affected: NxAffectedConfig

Default options for nx affected

Deprecated

use defaultBase instead. For more information see https://nx.dev/deprecated/affected-config#affected-config

• Optional analytics: boolean

Set this to true to allow Nx to collect usage analytics.

• Optional cacheDirectory: string

Changes the directory used by Nx to store its cache.

• Optional cli: Object

Default generator collection. It is used when no collection is provided.

• Optional defaultBase: string

Default value for —base used by nx affected and nx format.

• Optional defaultProject: string

Default project. When project isn’t provided, the default project will be used. Convenient for small workspaces with one main application.

• 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; }

• Optional implicitDependencies: ImplicitDependencyEntry<T>

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

• 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.

• Optional maxCacheSize: string

Sets the maximum size of the local cache. Accepts a number followed by a unit (e.g. 100MB). Accepted units are B, KB, MB, and GB.

• Optional namedInputs: Object

Named inputs targets can refer to reduce duplication

▪ [inputName: string]: (string | InputDefinition)[]

• Optional neverConnectToCloud: boolean

Setting this to true will cause all attempts to setup your workspace to Nx Cloud to fail. This value does not prevent using Nx Cloud if already connected. Use NX_NO_CLOUD=true env var or the --no-cloud arg to prevent using Nx Cloud when running commands.

• 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

• Optional nxCloudEncryptionKey: string

Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.

• Optional nxCloudId: string

If specified Nx will use nx-cloud by default with the given cloud id. To use a different runner that accepts a cloud id, define it in tasksRunnerOptions

• Optional nxCloudUrl: string

Specifies the url pointing to an instance of nx cloud. Used for remote caching and displaying run links.

• 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

• Optional release: NxReleaseConfiguration

Configuration for nx release (versioning and publishing of applications and libraries)

• Optional sync: NxSyncConfiguration

Configuration for the nx sync command.

• Optional targetDefaults: TargetDefaults

Dependencies between different target names across all projects

• Optional tasksRunnerOptions: Object

Deprecated

Custom task runners will be replaced by a new API starting with Nx 21. More info: https://nx.dev/deprecated/custom-tasks-runner Available Task Runners for Nx to use

▪ [tasksRunnerName: string]: { options?: any ; runner?: string }

• Optional tui: Object

Settings for the Nx Terminal User Interface (TUI)

• Optional useDaemonProcess: boolean

Set this to false to disable the daemon.

• Optional useInferencePlugins: boolean

Set this to false to disable adding inference plugins when generating new projects

• Optional workspaceLayout: Object

Where new apps + libs should be placed