b51676a89a
Updates the docs structure, navigation etc to be easier + better suited for showing Nx technology support beyond just TS. **Notes:** - API (`/nx-api`) tab is removed from the navigation (i.e. menu bar), but pages still remain for now until we update references in `*.md` files. - Redirects are set up `/nx-api` to go to their respect new location e.g. `/technologies` or `/reference/core-api` - Old URLs still exist in the sitemap for now, but majority of them will be redirected -- a follow-up PR can remove them. **Preview:** https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs --------- Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
140 lines
3.9 KiB
Markdown
140 lines
3.9 KiB
Markdown
# Interface: ProjectConfiguration
|
|
|
|
Project configuration
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [generators](/reference/core-api/devkit/documents/ProjectConfiguration#generators): Object
|
|
- [implicitDependencies](/reference/core-api/devkit/documents/ProjectConfiguration#implicitdependencies): string[]
|
|
- [metadata](/reference/core-api/devkit/documents/ProjectConfiguration#metadata): ProjectMetadata
|
|
- [name](/reference/core-api/devkit/documents/ProjectConfiguration#name): string
|
|
- [namedInputs](/reference/core-api/devkit/documents/ProjectConfiguration#namedinputs): Object
|
|
- [projectType](/reference/core-api/devkit/documents/ProjectConfiguration#projecttype): ProjectType
|
|
- [release](/reference/core-api/devkit/documents/ProjectConfiguration#release): Object
|
|
- [root](/reference/core-api/devkit/documents/ProjectConfiguration#root): string
|
|
- [sourceRoot](/reference/core-api/devkit/documents/ProjectConfiguration#sourceroot): string
|
|
- [tags](/reference/core-api/devkit/documents/ProjectConfiguration#tags): string[]
|
|
- [targets](/reference/core-api/devkit/documents/ProjectConfiguration#targets): Object
|
|
|
|
## 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
|
|
|
|
---
|
|
|
|
### metadata
|
|
|
|
• `Optional` **metadata**: `ProjectMetadata`
|
|
|
|
Metadata about the project
|
|
|
|
---
|
|
|
|
### 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`](/reference/core-api/devkit/documents/ProjectType)
|
|
|
|
Project type
|
|
|
|
---
|
|
|
|
### release
|
|
|
|
• `Optional` **release**: `Object`
|
|
|
|
Project specific configuration for `nx release`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `version?` | `Pick`\<`LegacyNxReleaseVersionConfiguration`, `"generator"` \| `"generatorOptions"`\> \| `Pick`\<`NxReleaseVersionConfiguration`, `"versionActions"` \| `"versionActionsOptions"` \| `"manifestRootsToUpdate"` \| `"currentVersionResolver"` \| `"currentVersionResolverMetadata"` \| `"fallbackCurrentVersionResolver"` \| `"versionPrefix"` \| `"preserveLocalDependencyProtocols"`\> |
|
|
|
|
---
|
|
|
|
### 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`](/reference/core-api/devkit/documents/TargetConfiguration)
|