nx/docs/generated/devkit/NxJsonConfiguration.md

Interface: NxJsonConfiguration<T>

Nx.json configuration

Type parameters

Name	Type
T	"*" | string[]

Hierarchy

• NxJsonConfiguration

  ↳ Workspace

Table of contents

Properties

• affected: NxAffectedConfig
• cli: Object
• defaultProject: string
• extends: string
• generators: Object
• implicitDependencies: ImplicitDependencyEntry<T>
• installation: NxInstallationConfiguration
• namedInputs: Object
• npmScope: string
• plugins: string[]
• pluginsConfig: Record<string, unknown>
• release: NxReleaseConfiguration
• targetDefaults: TargetDefaults
• tasksRunnerOptions: Object
• workspaceLayout: Object

Properties

affected

• Optional affected: NxAffectedConfig

Default options for nx affected

---

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	-

---

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.

---

extends

• Optional extends: string

Optional (additional) Nx.json configuration file which becomes a base for this one

---

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:

{
  "@nx/react": {
    "library": {
      "style": "scss"
    }
  }
}

Index signature

▪ [collectionName: string]: { [generatorName: string]: any; }

---

implicitDependencies

• 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

---

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.

---

namedInputs

• Optional namedInputs: Object

Named inputs targets can refer to reduce duplication

Index signature

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

---

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

---

plugins

• Optional plugins: string[]

Plugins for extending the project graph

---

pluginsConfig

• Optional pluginsConfig: Record<string, unknown>

Configuration for Nx Plugins

---

release

• Optional release: NxReleaseConfiguration

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

---

targetDefaults

• Optional targetDefaults: TargetDefaults

Dependencies between different target names across all projects

---

tasksRunnerOptions

• Optional tasksRunnerOptions: Object

Available Task Runners

Index signature

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

---

workspaceLayout

• Optional workspaceLayout: Object

Where new apps + libs should be placed

Type declaration

Name	Type
appsDir?	string
libsDir?	string
projectNameAndRootFormat?	"as-provided" | "derived"