ProjectConfiguration
Project configuration
@note: when adding properties here add them to allowedProjectExtensions in adapter/compat.ts
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- generators
- implicitDependencies
- metadata
- name
- namedInputs
- projectType
- release
- root
- sourceRoot
- tags
- targets
Properties
Section titled “Properties”generators
Section titled “generators”• Optional generators: Object
List of default values used by generators.
These defaults are project specific.
Example:
{ "@nx/react": { "library": { "style": "scss" } }}Index signature
Section titled “Index signature”▪ [collectionName: string]: { [generatorName: string]: any; }
implicitDependencies
Section titled “implicitDependencies”• Optional implicitDependencies: string[]
List of projects which are added as a dependency
metadata
Section titled “metadata”• Optional metadata: ProjectMetadata
Metadata about the project
• Optional name: string
Project’s name. Optional if specified in workspace.json
namedInputs
Section titled “namedInputs”• Optional namedInputs: Object
Named inputs targets can refer to reduce duplication
Index signature
Section titled “Index signature”▪ [inputName: string]: (string | InputDefinition)[]
projectType
Section titled “projectType”• Optional projectType: ProjectType
Project type
release
Section titled “release”• Optional release: Object
Project specific configuration for nx release
Type declaration
Section titled “Type declaration”| Name | Type |
|---|---|
docker? | true | NxReleaseDockerConfiguration |
version? | Pick<NxReleaseVersionConfiguration, "versionActions" | "versionActionsOptions" | "manifestRootsToUpdate" | "currentVersionResolver" | "currentVersionResolverMetadata" | "fallbackCurrentVersionResolver" | "versionPrefix" | "preserveLocalDependencyProtocols"> |
• root: string
Project’s location relative to the root of the workspace
sourceRoot
Section titled “sourceRoot”• Optional sourceRoot: string
The location of project’s sources relative to the root of the workspace
• Optional tags: string[]
List of tags used by enforce-module-boundaries / project graph
targets
Section titled “targets”• Optional targets: Object
Project’s targets
Index signature
Section titled “Index signature”▪ [targetName: string]: TargetConfiguration