Merge pull request #71 from bing-framework/dev_v6.0

publish 6.0.0

Author: jianxuanbing

.editorconfig

@@ -8,8 +8,22 @@ root = true
 indent_style = space
 # (Please don't specify an indent_size here; that has too many unintended consequences.)
 
+[*.md]
+trim_trailing_whitespace = false
+
+[*.csproj]
+end_of_line              = crlf
+
+[*.sln]
+end_of_line              = crlf
+
+[*.ps1]
+indent_size              = 4
+end_of_line              = crlf
+
 # Code files
 [*.{cs,csx,vb,vbx}]
+# 缩进和间距
 indent_size = 4
 insert_final_newline = true
 charset = utf-8-bom
@@ -30,9 +44,77 @@ indent_size = 2
 end_of_line = lf
 indent_size = 2
 
+# C# 命名规则
+# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions
+[*.cs]
+## 接口示例：IPascalCase
+dotnet_naming_rule.interface_rule.symbols                                 = interface_symbol
+dotnet_naming_rule.interface_rule.style                                   = interface_style
+dotnet_naming_rule.interface_rule.severity                                = error
+dotnet_naming_symbols.interface_symbol.applicable_kinds                   = interface
+dotnet_naming_style.interface_style.required_prefix                       = I
+dotnet_naming_style.interface_style.capitalization                        = pascal_case
+
+## 类，结构，枚举，委托，方法，属性，事件示例: PascalCase
+dotnet_naming_rule.pascal_case_rule.symbols                               = pascal_case_symbol
+dotnet_naming_rule.pascal_case_rule.style                                 = pascal_case_style
+dotnet_naming_rule.pascal_case_rule.severity                              = error
+dotnet_naming_symbols.pascal_case_symbol.applicable_kinds                 = class, struct, enum, delegate, method, property, event
+dotnet_naming_style.pascal_case_style.capitalization                      = pascal_case
+
+## 私有字段示例: _camelCase
+dotnet_naming_rule.private_field_rule.symbols                             = private_field_symbol
+dotnet_naming_rule.private_field_rule.style                               = private_field_style
+dotnet_naming_rule.private_field_rule.severity                            = suggestion
+dotnet_naming_symbols.private_field_symbol.applicable_kinds               = field
+dotnet_naming_symbols.private_field_symbol.applicable_accessibilities     = private
+dotnet_naming_style.private_field_style.required_prefix                   = _
+dotnet_naming_style.private_field_style.capitalization                    = camel_case
+
+## 非私有字段示例: PascalCase
+dotnet_naming_rule.non_private_field_rule.symbols                         = non_private_field_symbol
+dotnet_naming_rule.non_private_field_rule.style                           = non_private_field_style
+dotnet_naming_rule.non_private_field_rule.severity                        = error
+dotnet_naming_symbols.non_private_field_symbol.applicable_kinds           = field
+dotnet_naming_symbols.non_private_field_symbol.applicable_accessibilities = public, internal, protected, protected_internal
+dotnet_naming_style.non_private_field_style.capitalization                = pascal_case
+
+## 非私有只读字段示例: PascalCase
+dotnet_naming_rule.protected_readonly_field_rule.symbols                            = protected_readonly_field_symbol
+dotnet_naming_rule.protected_readonly_field_rule.style                              = protected_readonly_field_style
+dotnet_naming_rule.protected_readonly_field_rule.severity                           = error
+dotnet_naming_symbols.protected_readonly_field_symbol.applicable_kinds              = field, property
+dotnet_naming_symbols.protected_readonly_field_symbol.applicable_accessibilities    = public, internal, protected, protected_internal
+dotnet_naming_symbols.protected_readonly_field_symbol.required_modifiers            = readonly
+dotnet_naming_style.protected_readonly_field_style.capitalization                   = pascal_case
+
+## 参数示例: camelCase
+dotnet_naming_rule.parameter_rule.symbols                                 = parameter_symbol
+dotnet_naming_rule.parameter_rule.style                                   = parameter_style
+dotnet_naming_rule.parameter_rule.severity                                = error
+dotnet_naming_symbols.parameter_symbol.applicable_kinds                   = parameter
+dotnet_naming_style.parameter_style.capitalization                        = camel_case
+
+## 常量示例: ALL_UPPER
+dotnet_naming_rule.const_rule.symbols                                     = const_symbol
+dotnet_naming_rule.const_rule.style                                       = const_style
+dotnet_naming_rule.const_rule.severity                                    = suggestion
+dotnet_naming_symbols.const_symbol.required_modifiers                     = const
+dotnet_naming_symbols.const_symbol.applicable_kinds                       = field
+dotnet_naming_style.const_style.capitalization                            = pascal_case # all_upper
+# dotnet_naming_style.const_style.word_separator                            = _
+
+## 异步方法示例: xxxAsync
+dotnet_naming_rule.async_method_rule.symbols                              = async_method_symbol
+dotnet_naming_rule.async_method_rule.style                                = async_method_style
+dotnet_naming_rule.async_method_rule.severity                             = error
+dotnet_naming_symbols.async_method_symbol.required_modifiers              = async
+dotnet_naming_symbols.async_method_symbol.applicable_kinds                = method
+dotnet_naming_style.async_method_style.required_suffix                    = Async
+
 # Dotnet code style settings:
 [*.{cs,vb}]
-# Sort using and Import directives with System.* appearing first
+# Sort using and Import directives with System.* appearing first(using排序)
 dotnet_sort_system_directives_first = true
 # Avoid "this." and "Me." if not necessary
 dotnet_style_qualification_for_field = false:suggestion
@@ -51,78 +133,9 @@ dotnet_style_coalesce_expression = true:suggestion
 dotnet_style_null_propagation = true:suggestion
 dotnet_style_explicit_tuple_names = true:suggestion
 
-# Non-private static fields are PascalCase
-dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
-dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
-
-dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
-dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
-dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
-
-dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
-
-# Constants are PascalCase
-dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
-dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style
-
-dotnet_naming_symbols.constants.applicable_kinds = field, local
-dotnet_naming_symbols.constants.required_modifiers = const
-
-dotnet_naming_style.constant_style.capitalization = pascal_case
-
-# Static fields are camelCase and start with s_
-dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion
-dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
-dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style
-
-dotnet_naming_symbols.static_fields.applicable_kinds = field
-dotnet_naming_symbols.static_fields.required_modifiers = static
-
-dotnet_naming_style.static_field_style.capitalization = camel_case
-dotnet_naming_style.static_field_style.required_prefix = s_
-
-# Instance fields are camelCase and start with _
-dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion
-dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
-dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
-
-dotnet_naming_symbols.instance_fields.applicable_kinds = field
-
-dotnet_naming_style.instance_field_style.capitalization = camel_case
-dotnet_naming_style.instance_field_style.required_prefix = _
-
-# Locals and parameters are camelCase
-dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion
-dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
-dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
-
-dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
-
-dotnet_naming_style.camel_case_style.capitalization = camel_case
-
-# Local functions are PascalCase
-dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
-dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style
-
-dotnet_naming_symbols.local_functions.applicable_kinds = local_function
-
-dotnet_naming_style.local_function_style.capitalization = pascal_case
-
-# By default, name items with PascalCase
-dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
-dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style
-
-dotnet_naming_symbols.all_members.applicable_kinds = *
-
-dotnet_naming_style.pascal_case_style.capitalization = pascal_case
-
 # CSharp code style settings:
 [*.cs]
-# Indentation preferences
+# Indentation preferences(缩进)
 csharp_indent_block_contents = true
 csharp_indent_braces = false
 csharp_indent_case_contents = true
@@ -152,7 +165,7 @@ csharp_style_inlined_variable_declaration = true:suggestion
 csharp_style_throw_expression = true:suggestion
 csharp_style_conditional_delegate_call = true:suggestion
 
-# Newline settings
+# Newline settings(换行)
 csharp_new_line_before_open_brace = all
 csharp_new_line_before_else = true
 csharp_new_line_before_catch = true
@@ -161,7 +174,7 @@ csharp_new_line_before_members_in_object_initializers = true
 csharp_new_line_before_members_in_anonymous_types = true
 csharp_new_line_between_query_expression_clauses = true
 
-# Spacing
+# Spacing(间距)
 csharp_space_after_cast = false
 csharp_space_after_colon_in_inheritance_clause = true
 csharp_space_after_keywords_in_control_flow_statements = true
@@ -177,4 +190,4 @@ csharp_space_between_parentheses = false
 # Blocks are allowed
 csharp_prefer_braces = true:silent
 csharp_preserve_single_line_blocks = true
-csharp_preserve_single_line_statements = true
+csharp_preserve_single_line_statements = true

.github/workflows/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: 错误报告
+about: 创建一个报告来帮助我们改进
+title: ''
+labels: ''
+assignees: ''
+---
+
+**描述这个 Bug**
+
+请简要清晰地描述这个错误是什么。
+
+**复现步骤**
+
+复现该问题的步骤如下：
+1. ...
+2. ...
+3. ....
+
+**期望的行为**
+
+请简要描述你原本预期会发生什么。
+
+**截图**
+
+如有需要，请添加截图来帮助说明你的问题。
+
+**运行时版本**
+
+- dotnet 版本：
+- `Bing` 版本：
+
+**其他上下文信息**
+
+请添加与该问题有关的其他上下文信息。

.github/workflows/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: 功能请求
+about: 为该项目提出一个改进建议
+title: ''
+labels: ''
+assignees: ''
+---
+
+**该功能请求是否与某个问题相关？请描述**
+
+请简要清晰地描述这个问题。例如：每当我遇到 [...] 的时候，我总是感到困扰。
+
+**你期望的解决方案**
+
+请简要清晰地描述你希望实现什么样的功能或行为。
+
+**你考虑过的替代方案**
+
+请简要描述你曾考虑过的其他解决方案或替代功能。
+
+**其他补充信息**
+
+请在此添加与功能请求相关的其他上下文信息或截图。

.github/workflows/workflows/dofx.yml

@@ -0,0 +1,62 @@
+name: docfx
+on:
+  push:
+    branches:
+      - "main"
+      - "master"
+      - "dev"
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in progress and the latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: "publish docs"
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the branch that triggered this workflow to the 'source' subdirectory
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            6.0.x
+            7.0.x
+            8.0.x
+            9.0.x
+      - name: install dotnet tools
+        run: |
+          dotnet tool install -g dotnet-execute
+          dotnet tool install -g docfx
+      # Run a build
+      - name: Build docs
+        run: |
+          dotnet-exec info
+          dotnet build
+          docfx ./docs/docfx.json
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/_site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+      # - name: cloudflare-pages
+      #   uses: cloudflare/wrangler-action@v3
+      #   with:
+      #     accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+      #     apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+      #     command: pages deploy docs/_site --project-name=bing-utils

.gitignore

@@ -265,4 +265,5 @@ __pycache__/
 *.DotSettings
 /bus
 /output/netstandard2.0
-Bing*.xml
+Bing*.xml
+/global.json