Skip to content

Commit 8b8b01c

Browse files
committed
feat(nxdoc): mark required properties
1 parent db3ec62 commit 8b8b01c

File tree

16 files changed

+212
-201
lines changed

16 files changed

+212
-201
lines changed

docs/core/executors/build.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,42 @@ Builds an app via the `dotnet` cli command.
66

77
## Options
88

9-
### framework (string)
9+
### framework
1010

11-
Compiles for a specific framework. The framework must be defined in the project file
11+
- (string): Compiles for a specific framework. The framework must be defined in the project file
1212

13-
### version-suffix (number)
13+
### version-suffix
1414

15-
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.
15+
- (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.
1616

17-
### configuration (string)
17+
### configuration <span style={{color:"red"}}>\*</span>
1818

19-
Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project
19+
- (string): Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project
2020

21-
### force (boolean)
21+
### force
2222

23-
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.
23+
- (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.
2424

25-
### no-dependencies (boolean)
25+
### no-dependencies
2626

27-
Ignores project-to-project (P2P) references and only builds the specified root project.
27+
- (boolean): Ignores project-to-project (P2P) references and only builds the specified root project.
2828

29-
### no-incremental (boolean)
29+
### no-incremental
3030

31-
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.
31+
- (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.
3232

33-
### no-restore (boolean)
33+
### no-restore
3434

35-
Doesn&#39;t execute an implicit restore during build.
35+
- (boolean): Doesn&#39;t execute an implicit restore during build.
3636

37-
### nologo (boolean)
37+
### nologo
3838

39-
Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
39+
- (boolean): Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
4040

41-
### output (string)
41+
### output
4242

43-
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.
43+
- (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.
4444

45-
### verbosity (string)
45+
### verbosity
46+
47+
- (string):

docs/core/executors/format.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,52 +6,52 @@ Formats and lints a project using the dotnet-format tool
66

77
## Options
88

9-
### noRestore (boolean)
9+
### noRestore
1010

11-
Doesn&#39;t execute an implicit restore before formatting
11+
- (boolean): Doesn&#39;t execute an implicit restore before formatting
1212

13-
### fixWhitespace (boolean)
13+
### fixWhitespace
1414

15-
Run whitespace formatting. Run by default when not applying fixes.
15+
- (boolean): Run whitespace formatting. Run by default when not applying fixes.
1616

17-
### fixStyle (string)
17+
### fixStyle
1818

19-
Run code style analyzers and apply fixes.
19+
- (string): Run code style analyzers and apply fixes.
2020

21-
### fixAnalyzers (string)
21+
### fixAnalyzers
2222

23-
Run 3rd party analyzers and apply fixes.
23+
- (string): Run 3rd party analyzers and apply fixes.
2424

2525
### diagnostics
2626

27+
-
2728
- (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
28-
2929
- (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
3030

31-
### include (array)
31+
### include
3232

33-
A list of relative file or folder paths to include in formatting. All files are formatted if empty
33+
- (array): A list of relative file or folder paths to include in formatting. All files are formatted if empty
3434

35-
### exclude (array)
35+
### exclude
3636

37-
A list of relative file or folder paths to exclude from formatting.
37+
- (array): A list of relative file or folder paths to exclude from formatting.
3838

39-
### check (boolean)
39+
### check
4040

41-
Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
41+
- (boolean): Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
4242

43-
### report (string)
43+
### report
4444

45-
Accepts a file path, which if provided, will produce a json report in the given directory.
45+
- (string): Accepts a file path, which if provided, will produce a json report in the given directory.
4646

47-
### binarylog (string)
47+
### binarylog
4848

49-
Log all project or solution load information to a binary log file.
49+
- (string): Log all project or solution load information to a binary log file.
5050

51-
### verbosity (string)
51+
### verbosity
5252

53-
Set the verbosity level.
53+
- (string): Set the verbosity level.
5454

55-
### fix (boolean)
55+
### fix
5656

57-
Formats files and saves changes to disk. Equivalent to setting --check=false.
57+
- (boolean): Formats files and saves changes to disk. Equivalent to setting --check=false.

docs/core/executors/publish.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,56 +6,58 @@ Publishes an app via the `dotnet` cli command.
66

77
## Options
88

9-
### configuration (string)
9+
### configuration
1010

11-
Defines the build configuration The default for most projects is Debug, but you can override the build configuration settings in your project.
11+
- (string): Defines the build configuration The default for most projects is Debug, but you can override the build configuration settings in your project.
1212

13-
### framework (string)
13+
### framework
1414

15-
Publishes the application for the specified target framework. You must specify the target framework in the project file.
15+
- (string): Publishes the application for the specified target framework. You must specify the target framework in the project file.
1616

17-
### force (boolean)
17+
### force
1818

19-
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.
19+
- (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.
2020

21-
### noBuild (boolean)
21+
### noBuild
2222

23-
Doesn&#39;t build the project before publishing. It also implicitly sets the --no-restore flag.
23+
- (boolean): Doesn&#39;t build the project before publishing. It also implicitly sets the --no-restore flag.
2424

25-
### noDependencies (boolean)
25+
### noDependencies
2626

27-
Ignores project-to-project references and only restores the root project.
27+
- (boolean): Ignores project-to-project references and only restores the root project.
2828

29-
### nologo (boolean)
29+
### nologo
3030

31-
Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
31+
- (boolean): Doesn&#39;t display the startup banner or the copyright message. Available since .NET Core 3.0 SDK.
3232

33-
### noRestore (boolean)
33+
### noRestore
3434

35-
Doesn&#39;t execute an implicit restore when running the command.
35+
- (boolean): Doesn&#39;t execute an implicit restore when running the command.
3636

37-
### output (string)
37+
### output
3838

39-
Specifies the path for the output directory.
39+
- (string): Specifies the path for the output directory.
4040

41-
### selfContained (boolean)
41+
### selfContained
4242

43-
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).
43+
- (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).
4444

45-
### runtime (string)
45+
### runtime
4646

47-
Publishes the application for a given runtime.
47+
- (string): Publishes the application for a given runtime.
4848

49-
### verbosity (string)
49+
### verbosity
5050

51-
### versionSuffix (string)
51+
- (string):
5252

53-
Defines the version suffix to replace the asterisk (\*) in the version field of the project file.
53+
### versionSuffix
5454

55-
### publishProfile (string)
55+
- (string): Defines the version suffix to replace the asterisk (\*) in the version field of the project file.
5656

57-
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.
57+
### publishProfile
5858

59-
### extraParameters (string)
59+
- (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.
6060

61-
Extra command-line arguments that are passed verbatim to the dotnet command.
61+
### extraParameters
62+
63+
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.

docs/core/executors/serve.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@ Uses `dotnet run` and chokidar to run a .NET app.
66

77
## Options
88

9-
### configuration (string)
9+
### configuration
1010

11-
Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
11+
- (string): Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
1212

13-
### framework (string)
13+
### framework
1414

15-
Builds and runs the app using the specified framework. The framework must be specified in the project file.
15+
- (string): Builds and runs the app using the specified framework. The framework must be specified in the project file.
1616

17-
### force (boolean)
17+
### force
1818

19-
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.
19+
- (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.
2020

21-
### launch-profile (string)
21+
### launch-profile
2222

23-
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.
23+
- (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.
2424

25-
### no-launch-profile (boolean)
25+
### no-launch-profile
2626

27-
Doesn&#39;t try to use launchSettings.json to configure the application.
27+
- (boolean): Doesn&#39;t try to use launchSettings.json to configure the application.
2828

29-
### runtime (string)
29+
### runtime
3030

31-
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.
31+
- (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.
3232

33-
### verbosity (string)
33+
### verbosity
3434

35-
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.
35+
- (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.

0 commit comments

Comments
 (0)