Skip to content

Commit

Permalink
fix(nxdoc): invalid generators.json
Browse files Browse the repository at this point in the history
  • Loading branch information
AgentEnder committed May 21, 2021
1 parent 59c63d0 commit b3b03be
Show file tree
Hide file tree
Showing 17 changed files with 296 additions and 120 deletions.
31 changes: 0 additions & 31 deletions docs/core/executors/app.md

This file was deleted.

43 changes: 43 additions & 0 deletions docs/core/executors/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# build

## NxDotnet Build

## Options

### framework (string)

Compiles for a specific framework. The framework must be defined in the project file

### version-suffix (number)

Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.

### configuration (string)

Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project

### force (boolean)

Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.

### no-dependencies (boolean)

Ignores project-to-project (P2P) references and only builds the specified root project.

### no-incremental (boolean)

Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.

### no-restore (boolean)

Doesn't execute an implicit restore during build.

### nologo (boolean)

Doesn't display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.

### output (string)

Directory in which to place the built binaries. If not specified, the default path is ./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to define --framework when you specify this option.

### verbosity (string)
51 changes: 51 additions & 0 deletions docs/core/executors/format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# format

## Format executor

## Options

### noRestore (boolean)

Doesn't execute an implicit restore before formatting

### fixWhitespace (boolean)

Run whitespace formatting. Run by default when not applying fixes.

### fixStyle (string)

Run code style analyzers and apply fixes.

### fixAnalyzers (string)

Run 3rd party analyzers and apply fixes.

### diagnostics ()

### include (array)

A list of relative file or folder paths to include in formatting. All files are formatted if empty

### exclude (array)

A list of relative file or folder paths to exclude from formatting.

### check (boolean)

Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.

### report (string)

Accepts a file path, which if provided, will produce a json report in the given directory.

### binarylog (string)

Log all project or solution load information to a binary log file.

### verbosity (string)

Set the verbosity level.

### fix (boolean)

Formats files and saves changes to disk. Equivalent to setting --check=false.
3 changes: 0 additions & 3 deletions docs/core/executors/init.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/core/executors/lib.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/core/executors/nuget-reference.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/core/executors/project-reference.md

This file was deleted.

59 changes: 59 additions & 0 deletions docs/core/executors/publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# publish

## NxDotnet Publish

## Options

### configuration (string)

Defines the build configuration The default for most projects is Debug, but you can override the build configuration settings in your project.

### framework (string)

Publishes the application for the specified target framework. You must specify the target framework in the project file.

### force (boolean)

Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.

### noBuild (boolean)

Doesn't build the project before publishing. It also implicitly sets the --no-restore flag.

### noDependencies (boolean)

Ignores project-to-project references and only restores the root project.

### nologo (boolean)

Doesn't display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.

### noRestore (boolean)

Doesn't execute an implicit restore when running the command.

### output (string)

Specifies the path for the output directory.

### selfContained (boolean)

Publishes the .NET runtime with your application so the runtime doesn't need to be installed on the target machine. Default is true if a runtime identifier is specified and the project is an executable project (not a library project).

### runtime (string)

Publishes the application for a given runtime.

### verbosity (string)

### versionSuffix (string)

Defines the version suffix to replace the asterisk (\*) in the version field of the project file.

### publishProfile (string)

Specifies the name of the publish profile to use while publishing. Do not include the file path or the file extension. MSBuild by default looks in the Properties/PublishProfiles folder and assumes the pubxml file extension.

### extraParameters (string)

Extra command-line arguments that are passed verbatim to the dotnet command.
1 change: 0 additions & 1 deletion docs/core/executors/restore.md

This file was deleted.

33 changes: 33 additions & 0 deletions docs/core/executors/serve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# serve

## NxDotnet Serve Executor

## Options

### configuration (string)

Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.

### framework (string)

Builds and runs the app using the specified framework. The framework must be specified in the project file.

### force (boolean)

Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.

### launch-profile (string)

The name of the launch profile (if any) to use when launching the application. Launch profiles are defined in the launchSettings.json file and are typically called Development, Staging, and Production. For more information, see Working with multiple environments.

### no-launch-profile (boolean)

Doesn't try to use launchSettings.json to configure the application.

### runtime (string)

Specifies the target runtime to restore packages for. For a list of Runtime Identifiers (RIDs), see the RID catalog. -r short option available since .NET Core 3.0 SDK.

### verbosity (string)

Sets the verbosity level of the command. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]. The default value is m. Available since .NET Core 2.1 SDK.
1 change: 0 additions & 1 deletion docs/core/executors/sync.md

This file was deleted.

Loading

0 comments on commit b3b03be

Please sign in to comment.