nx/docs/generated/devkit/ProjectConfiguration.md

2.2 KiB

Interface: ProjectConfiguration

Project configuration

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

Table of contents

Properties

Properties

generators

Optional generators: Object

List of default values used by generators.

These defaults are project specific.

Example:

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

Index signature

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


implicitDependencies

Optional implicitDependencies: string[]

List of projects which are added as a dependency


name

Optional name: string

Project's name. Optional if specified in workspace.json


namedInputs

Optional namedInputs: Object

Named inputs targets can refer to reduce duplication

Index signature

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


projectType

Optional projectType: ProjectType

Project type


root

root: string

Project's location relative to the root of the workspace


sourceRoot

Optional sourceRoot: string

The location of project's sources relative to the root of the workspace


tags

Optional tags: string[]

List of tags used by enforce-module-boundaries / project graph


targets

Optional targets: Object

Project's targets

Index signature

▪ [targetName: string]: TargetConfiguration