Skip to content

Commit 2fca492

Browse files
Merge pull request #41306 from dotnet/main
Merge main into live
2 parents 330eafa + f668980 commit 2fca492

File tree

7 files changed

+164
-8
lines changed

7 files changed

+164
-8
lines changed

docs/azure/includes/dotnet-all.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -442,8 +442,8 @@
442442
| Functions extension for Blob Storage | NuGet [5.3.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.Storage.Blobs/5.3.0) | [docs](/dotnet/api/overview/azure/Microsoft.Azure.WebJobs.Extensions.Storage.Blobs-readme) | |
443443
| Functions extension for Cosmos DB | NuGet [4.6.1](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.CosmosDB/4.6.1) | | GitHub [4.6.1](https://github.com/Azure/azure-webjobs-sdk-extensions/tree/cosmos-v3.0.7/src/WebJobs.Extensions.CosmosDB) |
444444
| Functions extension for DocumentDB | NuGet [1.3.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DocumentDB/1.3.0) | | GitHub [1.3.0](https://github.com/Azure/azure-webjobs-sdk-extensions) |
445-
| Functions extension for Durable Task Framework | NuGet [2.13.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DurableTask/2.13.0)<br>NuGet [3.0.0-rc.1](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DurableTask/3.0.0-rc.1) | [docs](https://learn.microsoft.com/dotnet/api/overview/azure/functions) | GitHub [2.13.0](https://github.com/Azure/azure-functions-durable-extension/tree/v2.2.2/src/WebJobs.Extensions.DurableTask) |
446-
| Functions extension for Durable Task Framework - isolated worker | NuGet [1.1.0](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.DurableTask/1.1.0)<br>NuGet [1.2.0-rc.1](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.DurableTask/1.2.0-rc.1) | | |
445+
| Functions extension for Durable Task Framework | NuGet [2.13.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DurableTask/2.13.0)<br>NuGet [3.0.0-rc.2](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DurableTask/3.0.0-rc.2) | [docs](https://learn.microsoft.com/dotnet/api/overview/azure/functions) | GitHub [2.13.0](https://github.com/Azure/azure-functions-durable-extension/tree/v2.2.2/src/WebJobs.Extensions.DurableTask) |
446+
| Functions extension for Durable Task Framework - isolated worker | NuGet [1.1.0](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.DurableTask/1.1.0)<br>NuGet [1.2.0-rc.2](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.DurableTask/1.2.0-rc.2) | | |
447447
| Functions extension for HTTP | NuGet [3.2.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.Http/3.2.0) | | GitHub [3.2.0](https://github.com/Azure/azure-webjobs-sdk-extensions/tree/v3.0.2/src/WebJobs.Extensions.Http) |
448448
| Functions extension for IoT Edge | NuGet [1.0.7](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.EdgeHub/1.0.7) | | GitHub [1.0.7](https://github.com/Azure/iotedge/tree/1.0.7/edge-hub) |
449449
| Functions extension for Kafka | NuGet [3.9.0](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.Kafka/3.9.0) | | GitHub [3.9.0](https://github.com/Azure/azure-functions-kafka-extension/tree/3.0.0/src/Microsoft.Azure.WebJobs.Extensions.Kafka) |

docs/core/whats-new/dotnet-core-2-0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ For example, to create a Visual Basic "Hello World" application, do the followin
6868

6969
The command creates a project file with a `.vbproj` file extension, along with a Visual Basic source code file named *Program.vb*. This file contains the source code to write the string "Hello World!" to the console window.
7070

71-
1. Enter the command `dotnet run`. The [.NET Core CLI](../tools/index.md) automatically compiles and executes the application, which displays the message "Hello World!" in the console window.
71+
1. Enter the command `dotnet run`. The [.NET CLI](../tools/index.md) automatically compiles and executes the application, which displays the message "Hello World!" in the console window.
7272

7373
### Support for C# 7.1
7474

docs/core/whats-new/dotnet-core-2-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ You can modify this setting in any of three ways:
106106
"rollForwardOnNoCandidateFx" : 0
107107
```
108108

109-
- When using the [.NET Core CLI](../tools/index.md), add the following option with the desired value to a .NET Core command such as `run`:
109+
- When using the [.NET CLI](../tools/index.md), add the following option with the desired value to a .NET command such as `run`:
110110

111111
```dotnetcli
112112
dotnet run --rollForwardOnNoCandidateFx=0

docs/fundamentals/code-analysis/code-quality-rule-options.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,27 @@ This section lists some of the available options. To see the full list of availa
8686
- [disallowed\_symbol\_names](#disallowed_symbol_names)
8787
- [exclude\_ordefault\_methods](#exclude_ordefault_methods)
8888
- [ignore_internalsvisibleto](#ignore_internalsvisibleto)
89+
- [try_determine_additional_string_formatting_methods_automatically](#try_determine_additional_string_formatting_methods_automatically)
90+
- [unsafe_DllImportSearchPath_bits](#unsafe_dllimportsearchpath_bits)
91+
- [exclude_aspnet_core_mvc_controllerbase](#exclude_aspnet_core_mvc_controllerbase)
92+
- [dispose_analysis_kind](#dispose_analysis_kind)
93+
- [dispose_ownership_transfer_at_constructor](#dispose_ownership_transfer_at_constructor)
94+
- [dispose_ownership_transfer_at_method_call](#dispose_ownership_transfer_at_method_call)
95+
- [enum_values_prefix_trigger](#enum_values_prefix_trigger)
96+
- [exclude_indirect_base_types](#exclude_indirect_base_types)
97+
- [additional_required_suffixes](#additional_required_suffixes)
98+
- [additional_required_generic_interfaces](#additional_required_generic_interfaces)
99+
- [additional_inheritance_excluded_symbol_names](#additional_inheritance_excluded_symbol_names)
100+
- [analyzed_symbol_kinds](#analyzed_symbol_kinds)
101+
- [use_naming_heuristic](#use_naming_heuristic)
102+
- [additional_use_results_methods](#additional_use_results_methods)
103+
- [allowed_suffixes](#allowed_suffixes)
104+
- [enable_platform_analyzer_on_pre_net5_target](#additional_inheritance_excluded_symbol_names)
105+
- [exclude_structs](#exclude_structs)
106+
- [additional_enum_none_names](#additional_enum_none_names)
107+
- [enumeration_methods](#enumeration_methods)
108+
- [linq_chain_methods](#linq_chain_methods)
109+
- [assume_method_enumerates_parameters](#assume_method_enumerates_parameters)
89110
90111
### api_surface
91112
@@ -183,3 +204,138 @@ This section lists some of the available options. To see the full list of availa
183204
| Description | Allowable values | Default value | Configurable rules |
184205
| - | - | - | - |
185206
| Includes assemblies marked with <xref:System.Runtime.CompilerServices.InternalsVisibleToAttribute> in analysis. | `true` or `false` | `true` | [CA1812](quality-rules/ca1812.md) [CA1852](quality-rules/ca1852.md) |
207+
208+
### try_determine_additional_string_formatting_methods_automatically
209+
210+
| Description | Allowable values | Default value | Configurable rules |
211+
| - | - | - | - |
212+
| Boolean option to enable heuristic detection of additional string formatting methods.<br/>A method is considered a string formatting method if it has a `string format` parameter followed by a `params object[]` parameter. | `true` or `false` | `false` | [CA2241](quality-rules/ca2241.md) |
213+
214+
### unsafe_DllImportSearchPath_bits
215+
216+
<!-- markdownlint-disable MD056 -->
217+
| Description | Allowable values | Default value | Configurable rules |
218+
| - | - | - | - |
219+
| Configure which value of `DllImportSearchPath` is unsafe for the analysis | Integer values of `System.Runtime.InteropServices.DllImportSearchPath` | `770` (that is, `AssemblyDirectory | UseDllDirectoryForDependencies | ApplicationDirectory`) | [CA5393](quality-rules/ca5393.md) |
220+
<!-- markdownlint-enable MD056 -->
221+
222+
### exclude_aspnet_core_mvc_controllerbase
223+
224+
| Description | Allowable values | Default value | Configurable rules |
225+
| - | - | - | - |
226+
| Exclude ASP.NET Core MVC ControllerBase when considering CSRF | `true` or `false` | `true` | [CA5391](quality-rules/ca5391.md) |
227+
228+
### dispose_analysis_kind
229+
230+
| Description | Allowable values | Default value | Configurable rules |
231+
| - | - | - | - |
232+
| Specifies which paths to analyze for dispose violations | - `AllPaths` - Track and report missing dispose violations on all paths (non-exception and exception paths). Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.</br> - `AllPathsOnlyNotDisposed` - Track and report missing dispose violations on all paths (non-exception and exception paths). Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks.</br> - `NonExceptionPaths` - Track and report missing dispose violations only on non-exception program paths. Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.</br> - `NonExceptionPathsOnlyNotDisposed` - Track and report missing dispose violations only on non-exception program paths. Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks. | `NonExceptionPaths` | [CA2000](quality-rules/ca2000.md) |
233+
234+
### dispose_ownership_transfer_at_constructor
235+
236+
| Description | Allowable values | Default value | Configurable rules |
237+
| - | - | - | - |
238+
| Configure dispose ownership transfer for arguments passed to constructor invocation | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) |
239+
240+
### dispose_ownership_transfer_at_method_call
241+
242+
| Description | Allowable values | Default value | Configurable rules |
243+
| - | - | - | - |
244+
| Configure dispose ownership transfer for disposable objects passed as arguments to method calls | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) |
245+
246+
### enum_values_prefix_trigger
247+
248+
| Description | Allowable values | Default value | Configurable rules |
249+
| - | - | - | - |
250+
| Specifies the threshold to trigger the enum values naming rule | - `AnyEnumValue` - The rule is triggered if _any_ of the enum values starts with the enum type name.</br> - `AllEnumValues` - The rule is triggered if _all_ of the enum values start with the enum type name.</br> - `Heuristic` - The rule is triggered using the default FxCop heuristic (that is, when at least 75% of the enum values start with the enum type name).</br> | `Heuristic` | [CA1712](quality-rules/ca1712.md) |
251+
252+
### exclude_indirect_base_types
253+
254+
| Description | Allowable values | Default value | Configurable rules |
255+
| - | - | - | - |
256+
| Exclude indirect base types | `true` or `false` | `true` | [CA1710](quality-rules/ca1710.md) |
257+
258+
### additional_required_suffixes
259+
260+
| Description | Allowable values | Default value | Configurable rules |
261+
| - | - | - | - |
262+
| Specifies additional required suffixes | List of type names (separated by \|) with their required suffix (separated by `->`). Allowed type name formats:</br> - Type name only (includes all types with the name, regardless of the containing type or namespace).</br> - Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix.| None | [CA1710](quality-rules/ca1710.md) |
263+
264+
### additional_required_generic_interfaces
265+
266+
| Description | Allowable values | Default value | Configurable rules |
267+
| - | - | - | - |
268+
| Specifies additional required generic interfaces | List of interface names (separated by \|) with their required generic fully qualified interface (separated by `->`). Allowed interface formats:</br> - Interface name only (includes all interfaces with the name, regardless of the containing type or namespace).</br> - Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix. | None | [CA1010](quality-rules/ca1010.md) |
269+
270+
Examples:
271+
272+
| Option Value | Summary |
273+
| --- | --- |
274+
| ``dotnet_code_quality.CA1010.additional_required_generic_interfaces = ISomething->System.Collections.Generic.IEnumerable`1`` | All types implementing `ISomething` regardless of its namespace are expected to also implement ``System.Collections.Generic.IEnumerable\`1``. |
275+
| ``dotnet_code_quality.CA1010.additional_required_generic_interfaces = T:System.Collections.IDictionary->T:System.Collections.Generic.IDictionary`2`` | All types implementing `System.Collections.IDictionary` are expected to also implement ``System.Collections.Generic.IDictionary`2``. |
276+
277+
### additional_inheritance_excluded_symbol_names
278+
279+
| Description | Allowable values | Default value | Configurable rules |
280+
| - | - | - | - |
281+
| Specifies types or namespaces to exclude from the inheritance hierarchy tree | Allowed type name formats:</br> - Type or namespace name (includes all types with the name, regardless of the containing type or namespace and all types whose namespace contains the name).</br> - Type or namespace name ending with a wildcard symbol (includes all types whose name starts with the given name, regardless of the containing type or namespace, and all types whose namespace contains the name).</br> - Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix for types or `N:` prefix for namespaces.</br> - Fully qualified type or namespace name with an optional `T:` prefix for type or `N:` prefix for namespace and ending with the wildcard symbol (includes all types whose fully qualified name starts with the given suffix). | `N:System.*` (This value is always automatically added to the value provided) | [CA1501](quality-rules/ca1501.md) |
282+
283+
### analyzed_symbol_kinds
284+
285+
| Description | Allowable values | Default value | Configurable rules |
286+
| - | - | - | - |
287+
| Specifies the symbol kinds to analyze | One or more fields of <xref:Microsoft.CodeAnalysis.SymbolKind> as a comma-separated list. | `Namespace, NamedType, Method, Property, Event, Parameter` | [CA1716](quality-rules/ca1716.md) |
288+
289+
### use_naming_heuristic
290+
291+
| Description | Allowable values | Default value | Configurable rules |
292+
| - | - | - | - |
293+
| Configures whether parameters or property names containing `Text`, `Message`, or `Caption` trigger this rule | `true` or `false` | `false` | [CA1303](quality-rules/ca1303.md) |
294+
295+
### additional_use_results_methods
296+
297+
| Description | Allowable values | Default value | Configurable rules |
298+
| - | - | - | - |
299+
| Specifies additional custom APIs whose results must be used | Names of additional methods (separated by \|). Allowed method name formats:</br> - Method name only (includes all methods with the name, regardless of the containing type or namespace).</br> - Fully qualified names in the symbol's documentation ID format with an optional `M:` prefix. | None | [CA1806](quality-rules/ca1806.md) |
300+
301+
### allowed_suffixes
302+
303+
| Description | Allowable values | Default value | Configurable rules |
304+
| - | - | - | - |
305+
| Specifies allowable suffixes | List (separated by \|) of allowed suffixes. | None | [CA1711](quality-rules/ca1711.md) |
306+
307+
### enable_platform_analyzer_on_pre_net5_target
308+
309+
| Description | Allowable values | Default value | Configurable rules |
310+
| - | - | - | - |
311+
| Specifies whether to enable analysis for TFMs prior to .NET 5 | `true` or `false` | `false` | [CA1416](quality-rules/ca1416.md) |
312+
313+
### exclude_structs
314+
315+
| Description | Allowable values | Default value | Configurable rules |
316+
| - | - | - | - |
317+
| Specifies whether to exclude structs from analysis | `true` or `false` | `false` | [CA1051](quality-rules/ca1051.md) |
318+
319+
### additional_enum_none_names
320+
321+
| Description | Allowable values | Default value | Configurable rules |
322+
| - | - | - | - |
323+
| Specifies additional allowable names for a zero-value enumeration field | List of additional names (separated by \|). | None | [CA1008](quality-rules/ca1008.md) |
324+
325+
### enumeration_methods
326+
327+
| Description | Allowable values | Default value | Configurable rules |
328+
| - | - | - | - |
329+
| Specifies additional custom methods that enumerate an IEnumerable | Fully qualified names of additional methods (separated by \|). | None | [CA1851](quality-rules/ca1851.md) |
330+
331+
### linq_chain_methods
332+
333+
| Description | Allowable values | Default value | Configurable rules |
334+
| - | - | - | - |
335+
| Specifies additional customized LINQ chain methods (that is, methods take an `IEnumerable` argument and return a new `IEnumerable` instance) | Fully qualified names of additional methods (separated by \|). | None | [CA1851](quality-rules/ca1851.md) |
336+
337+
### assume_method_enumerates_parameters
338+
339+
| Description | Allowable values | Default value | Configurable rules |
340+
| - | - | - | - |
341+
| Specifies whether to assume that customized methods enumerate their `IEnumerable` parameters | `true` or `false` | `false` | [CA1851](quality-rules/ca1851.md) |

docs/standard/data/sqlite/custom-versions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ description: Learn how to use a custom version of the native SQLite library.
2323

2424
For example, to use the unofficial, open-source build of `SQLCipher` use the following commands.
2525

26-
### [.NET Core CLI](#tab/netcore-cli)
26+
### [.NET CLI](#tab/net-cli)
2727

2828
```dotnetcli
2929
dotnet add package Microsoft.Data.Sqlite.Core
@@ -54,7 +54,7 @@ When not relying on a bundle, you can use the available providers of SQLite with
5454

5555
To use the `sqlite3` provider use the following commands:
5656

57-
### [.NET Core CLI](#tab/netcore-cli)
57+
### [.NET CLI](#tab/net-cli)
5858

5959
```dotnetcli
6060
dotnet add package Microsoft.Data.Sqlite.Core

docs/standard/data/sqlite/encryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SQLite doesn't support encrypting database files by default. Instead, you need t
99

1010
## Installation
1111

12-
### [.NET Core CLI](#tab/netcore-cli)
12+
### [.NET CLI](#tab/net-cli)
1313

1414
```dotnetcli
1515
dotnet remove package Microsoft.Data.Sqlite

docs/standard/data/sqlite/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Microsoft.Data.Sqlite is a lightweight [ADO.NET](../../../framework/data/adonet/
1111

1212
The latest stable version is available on [NuGet](https://www.nuget.org/packages/Microsoft.Data.Sqlite).
1313

14-
### [.NET Core CLI](#tab/netcore-cli)
14+
### [.NET CLI](#tab/net-cli)
1515

1616
```dotnetcli
1717
dotnet add package Microsoft.Data.Sqlite

0 commit comments

Comments
 (0)