Skip to content

Commit

Permalink
Merge branch 'master' into feat/nx-ignore-cycles-variable
Browse files Browse the repository at this point in the history
  • Loading branch information
timfisher committed Aug 18, 2023
2 parents b03f078 + 71d2994 commit bdf432b
Show file tree
Hide file tree
Showing 62 changed files with 24,865 additions and 19,114 deletions.
22 changes: 22 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,28 @@ You can add specific languages and a filename on the code snippet displayed.
‎```
````

#### Line Highlighting

You can define groups of lines that can be interactively highlighted to illustrate a point.

````
‎```javascript {% lineGroups={ first:[2,3],second:[4,5] } %}
‎ const code = "goes here";
‎ This is in the first group
‎ This is also in the first group
‎ This is in the second group
‎ This is also in the second group
‎```
````

The line groups can be highlighted using a button on the code fence itself, or by clicking on a link that you provide that changes the url fragment.

For example:

```
[This will highlight the first group.](#first)
```

#### Terminal command

To display a terminal command, use:
Expand Down
10 changes: 5 additions & 5 deletions docs/generated/devkit/CreateDependenciesContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Context for [CreateDependencies](../../devkit/documents/CreateDependencies)

### Properties

- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap)
- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess)
- [graph](../../devkit/documents/CreateDependenciesContext#graph)
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration)
- [projectsConfigurations](../../devkit/documents/CreateDependenciesContext#projectsconfigurations)
- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap): ProjectFileMap
- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess): ProjectFileMap
- [graph](../../devkit/documents/CreateDependenciesContext#graph): ProjectGraph
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectsConfigurations](../../devkit/documents/CreateDependenciesContext#projectsconfigurations): ProjectsConfigurations

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/CreateNodesContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Context for [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)

### Properties

- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration)
- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot)
- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot): string

## Properties

Expand Down
18 changes: 9 additions & 9 deletions docs/generated/devkit/DefaultTasksRunnerOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

### Properties

- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory)
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations)
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets)
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr)
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle)
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel)
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache)
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs)
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache)
- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory): string
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations): string[]
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets): string[]
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr): boolean
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle): LifeCycle
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel): number
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache): RemoteCache
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs): string[]
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache): boolean

## Properties

Expand Down
24 changes: 12 additions & 12 deletions docs/generated/devkit/ExecutorContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ Context that is passed into an executor

### Properties

- [configurationName](../../devkit/documents/ExecutorContext#configurationname)
- [cwd](../../devkit/documents/ExecutorContext#cwd)
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose)
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration)
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph)
- [projectName](../../devkit/documents/ExecutorContext#projectname)
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations)
- [root](../../devkit/documents/ExecutorContext#root)
- [target](../../devkit/documents/ExecutorContext#target)
- [targetName](../../devkit/documents/ExecutorContext#targetname)
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph)
- [workspace](../../devkit/documents/ExecutorContext#workspace)
- [configurationName](../../devkit/documents/ExecutorContext#configurationname): string
- [cwd](../../devkit/documents/ExecutorContext#cwd): string
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose): boolean
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph): ProjectGraph
- [projectName](../../devkit/documents/ExecutorContext#projectname): string
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations): ProjectsConfigurations
- [root](../../devkit/documents/ExecutorContext#root): string
- [target](../../devkit/documents/ExecutorContext#target): TargetConfiguration<any>
- [targetName](../../devkit/documents/ExecutorContext#targetname): string
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph): TaskGraph
- [workspace](../../devkit/documents/ExecutorContext#workspace): ProjectsConfigurations & NxJsonConfiguration<string[] | "\*">

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/ExecutorsJson.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

### Properties

- [builders](../../devkit/documents/ExecutorsJson#builders)
- [executors](../../devkit/documents/ExecutorsJson#executors)
- [builders](../../devkit/documents/ExecutorsJson#builders): Record<string, ExecutorsJsonEntry>
- [executors](../../devkit/documents/ExecutorsJson#executors): Record<string, ExecutorsJsonEntry>

## Properties

Expand Down
8 changes: 4 additions & 4 deletions docs/generated/devkit/FileChange.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Description of a file change in the Nx virtual file system/

### Properties

- [content](../../devkit/documents/FileChange#content)
- [options](../../devkit/documents/FileChange#options)
- [path](../../devkit/documents/FileChange#path)
- [type](../../devkit/documents/FileChange#type)
- [content](../../devkit/documents/FileChange#content): Buffer
- [options](../../devkit/documents/FileChange#options): TreeWriteOptions
- [path](../../devkit/documents/FileChange#path): string
- [type](../../devkit/documents/FileChange#type): "CREATE" | "DELETE" | "UPDATE"

## Properties

Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/FileData.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Some metadata about a file

### Properties

- [deps](../../devkit/documents/FileData#deps)
- [file](../../devkit/documents/FileData#file)
- [hash](../../devkit/documents/FileData#hash)
- [deps](../../devkit/documents/FileData#deps): (string | [string, string])[]
- [file](../../devkit/documents/FileData#file): string
- [hash](../../devkit/documents/FileData#hash): string

## Properties

Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/GeneratorsJson.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

### Properties

- [extends](../../devkit/documents/GeneratorsJson#extends)
- [generators](../../devkit/documents/GeneratorsJson#generators)
- [schematics](../../devkit/documents/GeneratorsJson#schematics)
- [extends](../../devkit/documents/GeneratorsJson#extends): string
- [generators](../../devkit/documents/GeneratorsJson#generators): Record<string, GeneratorsJsonEntry>
- [schematics](../../devkit/documents/GeneratorsJson#schematics): Record<string, GeneratorsJsonEntry>

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/devkit/Hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ A data structure returned by the default hasher.

### Properties

- [details](../../devkit/documents/Hash#details)
- [value](../../devkit/documents/Hash#value)
- [details](../../devkit/documents/Hash#details): Object
- [value](../../devkit/documents/Hash#value): string

## Properties

Expand Down
10 changes: 5 additions & 5 deletions docs/generated/devkit/HasherContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

### Properties

- [hasher](../../devkit/documents/HasherContext#hasher)
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration)
- [projectGraph](../../devkit/documents/HasherContext#projectgraph)
- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations)
- [taskGraph](../../devkit/documents/HasherContext#taskgraph)
- [hasher](../../devkit/documents/HasherContext#hasher): TaskHasher
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/HasherContext#projectgraph): ProjectGraph
- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations): ProjectsConfigurations
- [taskGraph](../../devkit/documents/HasherContext#taskgraph): TaskGraph

## Properties

Expand Down
8 changes: 4 additions & 4 deletions docs/generated/devkit/JsonParseOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

### Properties

- [allowEmptyContent](../../devkit/documents/JsonParseOptions#allowemptycontent)
- [allowTrailingComma](../../devkit/documents/JsonParseOptions#allowtrailingcomma)
- [disallowComments](../../devkit/documents/JsonParseOptions#disallowcomments)
- [expectComments](../../devkit/documents/JsonParseOptions#expectcomments)
- [allowEmptyContent](../../devkit/documents/JsonParseOptions#allowemptycontent): boolean
- [allowTrailingComma](../../devkit/documents/JsonParseOptions#allowtrailingcomma): boolean
- [disallowComments](../../devkit/documents/JsonParseOptions#disallowcomments): boolean
- [expectComments](../../devkit/documents/JsonParseOptions#expectcomments): boolean

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/devkit/JsonSerializeOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Properties

- [spaces](../../devkit/documents/JsonSerializeOptions#spaces)
- [spaces](../../devkit/documents/JsonSerializeOptions#spaces): number

## Properties

Expand Down
12 changes: 6 additions & 6 deletions docs/generated/devkit/MigrationsJson.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

### Properties

- [collection](../../devkit/documents/MigrationsJson#collection)
- [generators](../../devkit/documents/MigrationsJson#generators)
- [name](../../devkit/documents/MigrationsJson#name)
- [packageJsonUpdates](../../devkit/documents/MigrationsJson#packagejsonupdates)
- [schematics](../../devkit/documents/MigrationsJson#schematics)
- [version](../../devkit/documents/MigrationsJson#version)
- [collection](../../devkit/documents/MigrationsJson#collection): string
- [generators](../../devkit/documents/MigrationsJson#generators): Object
- [name](../../devkit/documents/MigrationsJson#name): string
- [packageJsonUpdates](../../devkit/documents/MigrationsJson#packagejsonupdates): PackageJsonUpdates
- [schematics](../../devkit/documents/MigrationsJson#schematics): Object
- [version](../../devkit/documents/MigrationsJson#version): string

## Properties

Expand Down
12 changes: 6 additions & 6 deletions docs/generated/devkit/ModuleFederationConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

### Properties

- [additionalShared](../../devkit/documents/ModuleFederationConfig#additionalshared)
- [exposes](../../devkit/documents/ModuleFederationConfig#exposes)
- [library](../../devkit/documents/ModuleFederationConfig#library)
- [name](../../devkit/documents/ModuleFederationConfig#name)
- [remotes](../../devkit/documents/ModuleFederationConfig#remotes)
- [shared](../../devkit/documents/ModuleFederationConfig#shared)
- [additionalShared](../../devkit/documents/ModuleFederationConfig#additionalshared): AdditionalSharedConfig
- [exposes](../../devkit/documents/ModuleFederationConfig#exposes): Record<string, string>
- [library](../../devkit/documents/ModuleFederationConfig#library): ModuleFederationLibrary
- [name](../../devkit/documents/ModuleFederationConfig#name): string
- [remotes](../../devkit/documents/ModuleFederationConfig#remotes): Remotes
- [shared](../../devkit/documents/ModuleFederationConfig#shared): SharedFunction

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/devkit/NxAffectedConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Properties

- [defaultBase](../../devkit/documents/NxAffectedConfig#defaultbase)
- [defaultBase](../../devkit/documents/NxAffectedConfig#defaultbase): string

## Properties

Expand Down
30 changes: 14 additions & 16 deletions docs/generated/devkit/NxJsonConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Nx.json configuration

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

## Type parameters

| Name | Type |
Expand All @@ -20,20 +18,20 @@ Nx.json configuration

### Properties

- [affected](../../devkit/documents/NxJsonConfiguration#affected)
- [cli](../../devkit/documents/NxJsonConfiguration#cli)
- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject)
- [extends](../../devkit/documents/NxJsonConfiguration#extends)
- [generators](../../devkit/documents/NxJsonConfiguration#generators)
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies)
- [installation](../../devkit/documents/NxJsonConfiguration#installation)
- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs)
- [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope)
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins)
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig)
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults)
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout)
- [affected](../../devkit/documents/NxJsonConfiguration#affected): NxAffectedConfig
- [cli](../../devkit/documents/NxJsonConfiguration#cli): Object
- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
- [extends](../../devkit/documents/NxJsonConfiguration#extends): string
- [generators](../../devkit/documents/NxJsonConfiguration#generators): Object
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry<T>
- [installation](../../devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
- [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record<string, unknown>
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object

## Properties

Expand Down
20 changes: 9 additions & 11 deletions docs/generated/devkit/ProjectConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,19 @@

Project configuration

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

## Table of contents

### Properties

- [generators](../../devkit/documents/ProjectConfiguration#generators)
- [implicitDependencies](../../devkit/documents/ProjectConfiguration#implicitdependencies)
- [name](../../devkit/documents/ProjectConfiguration#name)
- [namedInputs](../../devkit/documents/ProjectConfiguration#namedinputs)
- [projectType](../../devkit/documents/ProjectConfiguration#projecttype)
- [root](../../devkit/documents/ProjectConfiguration#root)
- [sourceRoot](../../devkit/documents/ProjectConfiguration#sourceroot)
- [tags](../../devkit/documents/ProjectConfiguration#tags)
- [targets](../../devkit/documents/ProjectConfiguration#targets)
- [generators](../../devkit/documents/ProjectConfiguration#generators): Object
- [implicitDependencies](../../devkit/documents/ProjectConfiguration#implicitdependencies): string[]
- [name](../../devkit/documents/ProjectConfiguration#name): string
- [namedInputs](../../devkit/documents/ProjectConfiguration#namedinputs): Object
- [projectType](../../devkit/documents/ProjectConfiguration#projecttype): ProjectType
- [root](../../devkit/documents/ProjectConfiguration#root): string
- [sourceRoot](../../devkit/documents/ProjectConfiguration#sourceroot): string
- [tags](../../devkit/documents/ProjectConfiguration#tags): string[]
- [targets](../../devkit/documents/ProjectConfiguration#targets): Object

## Properties

Expand Down
8 changes: 4 additions & 4 deletions docs/generated/devkit/ProjectGraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ A Graph of projects in the workspace and dependencies between them

### Properties

- [dependencies](../../devkit/documents/ProjectGraph#dependencies)
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes)
- [nodes](../../devkit/documents/ProjectGraph#nodes)
- [version](../../devkit/documents/ProjectGraph#version)
- [dependencies](../../devkit/documents/ProjectGraph#dependencies): Record<string, ProjectGraphDependency[]>
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes): Record<string, ProjectGraphExternalNode>
- [nodes](../../devkit/documents/ProjectGraph#nodes): Record<string, ProjectGraphProjectNode>
- [version](../../devkit/documents/ProjectGraph#version): string

## Properties

Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/ProjectGraphBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/

### Properties

- [fileMap](../../devkit/documents/ProjectGraphBuilder#filemap)
- [graph](../../devkit/documents/ProjectGraphBuilder#graph)
- [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges)
- [fileMap](../../devkit/documents/ProjectGraphBuilder#filemap): ProjectFileMap
- [graph](../../devkit/documents/ProjectGraphBuilder#graph): ProjectGraph
- [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges): Object

### Methods

Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/ProjectGraphDependency.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ A dependency between two projects

### Properties

- [source](../../devkit/documents/ProjectGraphDependency#source)
- [target](../../devkit/documents/ProjectGraphDependency#target)
- [type](../../devkit/documents/ProjectGraphDependency#type)
- [source](../../devkit/documents/ProjectGraphDependency#source): string
- [target](../../devkit/documents/ProjectGraphDependency#target): string
- [type](../../devkit/documents/ProjectGraphDependency#type): string

## Properties

Expand Down
8 changes: 4 additions & 4 deletions docs/generated/devkit/ProjectGraphDependencyWithFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Optional: Specifies a file from where the dependency is made

### Properties

- [dependencyType](../../devkit/documents/ProjectGraphDependencyWithFile#dependencytype)
- [source](../../devkit/documents/ProjectGraphDependencyWithFile#source)
- [sourceFile](../../devkit/documents/ProjectGraphDependencyWithFile#sourcefile)
- [target](../../devkit/documents/ProjectGraphDependencyWithFile#target)
- [dependencyType](../../devkit/documents/ProjectGraphDependencyWithFile#dependencytype): DependencyType
- [source](../../devkit/documents/ProjectGraphDependencyWithFile#source): string
- [sourceFile](../../devkit/documents/ProjectGraphDependencyWithFile#sourcefile): string
- [target](../../devkit/documents/ProjectGraphDependencyWithFile#target): string

## Properties

Expand Down

0 comments on commit bdf432b

Please sign in to comment.