feat(nxdoc): mark required properties

nx-dotnet · May 23, 2021 · 8b8b01c · 8b8b01c
1 parent db3ec62
commit 8b8b01c
Show file tree

Hide file tree

Showing 16 changed files with 212 additions and 201 deletions.
diff --git a/docs/core/executors/build.md b/docs/core/executors/build.md
@@ -6,40 +6,42 @@ Builds an app via the `dotnet` cli command.
 
 ## Options
 
-### framework (string)
+### framework
 
-Compiles for a specific framework. The framework must be defined in the project file
+- (string): Compiles for a specific framework. The framework must be defined in the project file
 
-### version-suffix (number)
+### version-suffix
 
-Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn&#39;t set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
+- (number): Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn&#39;t set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
 
-### configuration (string)
+### configuration <span style={{color:"red"}}>\*</span>
 
-Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project
+- (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)
+### force
 
-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.
+- (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)
+### no-dependencies
 
-Ignores project-to-project (P2P) references and only builds the specified root project.
+- (boolean): Ignores project-to-project (P2P) references and only builds the specified root project.
 
-### no-incremental (boolean)
+### no-incremental
 
-Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project&#39;s dependency graph.
+- (boolean): Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project&#39;s dependency graph.
 
-### no-restore (boolean)
+### no-restore
 
-Doesn&#39;t execute an implicit restore during build.
+- (boolean): Doesn&#39;t execute an implicit restore during build.
 
-### nologo (boolean)
+### nologo
 
-Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
+- (boolean): Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
 
-### output (string)
+### output
 
-Directory in which to place the built binaries. If not specified, the default path is ./bin/&lt;configuration&gt;/&lt;framework&gt;/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to define --framework when you specify this option.
+- (string): Directory in which to place the built binaries. If not specified, the default path is ./bin/&lt;configuration&gt;/&lt;framework&gt;/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to define --framework when you specify this option.
 
-### verbosity (string)
+### verbosity
+
+- (string):
diff --git a/docs/core/executors/format.md b/docs/core/executors/format.md
@@ -6,52 +6,52 @@ Formats and lints a project using the dotnet-format tool
 
 ## Options
 
-### noRestore (boolean)
+### noRestore
 
-Doesn&#39;t execute an implicit restore before formatting
+- (boolean): Doesn&#39;t execute an implicit restore before formatting
 
-### fixWhitespace (boolean)
+### fixWhitespace
 
-Run whitespace formatting. Run by default when not applying fixes.
+- (boolean): Run whitespace formatting. Run by default when not applying fixes.
 
-### fixStyle (string)
+### fixStyle
 
-Run code style analyzers and apply fixes.
+- (string): Run code style analyzers and apply fixes.
 
-### fixAnalyzers (string)
+### fixAnalyzers
 
-Run 3rd party analyzers and apply fixes.
+- (string): Run 3rd party analyzers and apply fixes.
 
 ### diagnostics
 
+-
 - (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
-
 - (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
 
-### include (array)
+### include
 
-A list of relative file or folder paths to include in formatting. All files are formatted if empty
+- (array): A list of relative file or folder paths to include in formatting. All files are formatted if empty
 
-### exclude (array)
+### exclude
 
-A list of relative file or folder paths to exclude from formatting.
+- (array): A list of relative file or folder paths to exclude from formatting.
 
-### check (boolean)
+### check
 
-Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
+- (boolean): Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
 
-### report (string)
+### report
 
-Accepts a file path, which if provided, will produce a json report in the given directory.
+- (string): Accepts a file path, which if provided, will produce a json report in the given directory.
 
-### binarylog (string)
+### binarylog
 
-Log all project or solution load information to a binary log file.
+- (string): Log all project or solution load information to a binary log file.
 
-### verbosity (string)
+### verbosity
 
-Set the verbosity level.
+- (string): Set the verbosity level.
 
-### fix (boolean)
+### fix
 
-Formats files and saves changes to disk. Equivalent to setting --check=false.
+- (boolean): Formats files and saves changes to disk. Equivalent to setting --check=false.
diff --git a/docs/core/executors/publish.md b/docs/core/executors/publish.md
@@ -6,56 +6,58 @@ Publishes an app via the `dotnet` cli command.
 
 ## Options
 
-### configuration (string)
+### configuration
 
-Defines the build configuration The default for most projects is Debug, but you can override the build configuration settings in your project.
+- (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)
+### framework
 
-Publishes the application for the specified target framework. You must specify the target framework in the project file.
+- (string): Publishes the application for the specified target framework. You must specify the target framework in the project file.
 
-### force (boolean)
+### force
 
-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.
+- (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)
+### noBuild
 
-Doesn&#39;t build the project before publishing. It also implicitly sets the --no-restore flag.
+- (boolean): Doesn&#39;t build the project before publishing. It also implicitly sets the --no-restore flag.
 
-### noDependencies (boolean)
+### noDependencies
 
-Ignores project-to-project references and only restores the root project.
+- (boolean): Ignores project-to-project references and only restores the root project.
 
-### nologo (boolean)
+### nologo
 
-Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
+- (boolean): Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
 
-### noRestore (boolean)
+### noRestore
 
-Doesn&#39;t execute an implicit restore when running the command.
+- (boolean): Doesn&#39;t execute an implicit restore when running the command.
 
-### output (string)
+### output
 
-Specifies the path for the output directory.
+- (string): Specifies the path for the output directory.
 
-### selfContained (boolean)
+### selfContained
 
-Publishes the .NET runtime with your application so the runtime doesn&#39;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).
+- (boolean): Publishes the .NET runtime with your application so the runtime doesn&#39;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)
+### runtime
 
-Publishes the application for a given runtime.
+- (string): Publishes the application for a given runtime.
 
-### verbosity (string)
+### verbosity
 
-### versionSuffix (string)
+- (string):
 
-Defines the version suffix to replace the asterisk (\*) in the version field of the project file.
+### versionSuffix
 
-### publishProfile (string)
+- (string): Defines the version suffix to replace the asterisk (\*) in the version field of the project file.
 
-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.
+### publishProfile
 
-### extraParameters (string)
+- (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.
 
-Extra command-line arguments that are passed verbatim to the dotnet command.
+### extraParameters
+
+- (string): Extra command-line arguments that are passed verbatim to the dotnet command.
diff --git a/docs/core/executors/serve.md b/docs/core/executors/serve.md
@@ -6,30 +6,30 @@ Uses `dotnet run` and chokidar to run a .NET app.
 
 ## Options
 
-### configuration (string)
+### configuration
 
-Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
+- (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)
+### framework
 
-Builds and runs the app using the specified framework. The framework must be specified in the project file.
+- (string): Builds and runs the app using the specified framework. The framework must be specified in the project file.
 
-### force (boolean)
+### force
 
-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.
+- (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)
+### launch-profile
 
-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.
+- (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)
+### no-launch-profile
 
-Doesn&#39;t try to use launchSettings.json to configure the application.
+- (boolean): Doesn&#39;t try to use launchSettings.json to configure the application.
 
-### runtime (string)
+### runtime
 
-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.
+- (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)
+### verbosity
 
-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.
+- (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.