diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel index 1d0b1be3..93097b4c 100644 --- a/docs/BUILD.bazel +++ b/docs/BUILD.bazel @@ -1,5 +1,13 @@ load("@aspect_bazel_lib//lib:docs.bzl", "stardoc_with_diff_test", "update_docs") +################### +# Defs +################### +stardoc_with_diff_test( + name = "defs", + bzl_library_target = "//dotnet:defs", +) + ################### # C# Specific docs ################### diff --git a/docs/defs.md b/docs/defs.md new file mode 100644 index 00000000..85b70bb3 --- /dev/null +++ b/docs/defs.md @@ -0,0 +1,333 @@ + + +Public API surface is re-exported here. + +Users should not load files under "/dotnet" + + + + +## import_dll + +
+import_dll(name, data, dll, version)
+
+ +Imports a DLL + +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| name | A unique name for this target. | Name | required | | +| data | Other files that this DLL depends on at runtime | List of labels | optional | [] | +| dll | The name of the library | Label | required | | +| version | The version of the library | String | optional | "" | + + + + +## import_library + +
+import_library(name, analyzers, data, deps, framework_list, library_name, libs, native, nupkg, refs,
+               sha512, targeting_pack_overrides, version)
+
+ +Creates a target for a static DLL for a specific target framework + +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| name | A unique name for this target. | Name | required | | +| analyzers | Static analyzer DLLs | List of labels | optional | [] | +| data | Other files that this DLL depends on at runtime | List of labels | optional | [] | +| deps | Other DLLs that this DLL depends on. | List of labels | optional | [] | +| framework_list | Targeting packs like e.g. Microsoft.NETCore.App.Ref have a PlatformManifest.txt that includes all the DLLs that are included in the targeting pack. This is used to determine which version of a DLL should be used during compilation or runtime. | Dictionary: String -> String | optional | {} | +| library_name | The name of the library | String | required | | +| libs | Static runtime DLLs | List of labels | optional | [] | +| native | Native runtime DLLs | List of labels | optional | [] | +| nupkg | The .nupkg file providing this import | Label | optional | None | +| refs | Compile time DLLs | List of labels | optional | [] | +| sha512 | The SHA512 sum of the NuGet package | String | optional | "" | +| targeting_pack_overrides | Targeting packs like e.g. Microsoft.NETCore.App.Ref have a PackageOverride.txt that includes a list of NuGet packages that should be omitted in a compiliation because they are included in the targeting pack | Dictionary: String -> String | optional | {} | +| version | The version of the library | String | optional | "" | + + + + +## nuget_archive + +
+nuget_archive(name, id, netrc, repo_mapping, sha512, sources, version)
+
+ + + +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| name | A unique name for this repository. | Name | required | | +| id | - | String | optional | "" | +| netrc | - | Label | optional | None | +| repo_mapping | A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | | +| sha512 | - | String | optional | "" | +| sources | - | List of strings | optional | [] | +| version | - | String | optional | "" | + + + + +## csharp_binary + +
+csharp_binary(runtime_identifier, use_apphost_shim, treat_warnings_as_errors, warnings_as_errors,
+              warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## csharp_library + +
+csharp_library(runtime_identifier, treat_warnings_as_errors, warnings_as_errors,
+               warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## csharp_nunit_test + +
+csharp_nunit_test(runtime_identifier, use_apphost_shim, treat_warnings_as_errors,
+                  warnings_as_errors, warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## csharp_test + +
+csharp_test(runtime_identifier, use_apphost_shim, treat_warnings_as_errors, warnings_as_errors,
+            warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## fsharp_binary + +
+fsharp_binary(runtime_identifier, use_apphost_shim, treat_warnings_as_errors, warnings_as_errors,
+              warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## fsharp_library + +
+fsharp_library(runtime_identifier, treat_warnings_as_errors, warnings_as_errors,
+               warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## fsharp_nunit_test + +
+fsharp_nunit_test(runtime_identifier, use_apphost_shim, treat_warnings_as_errors,
+                  warnings_as_errors, warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## fsharp_test + +
+fsharp_test(runtime_identifier, use_apphost_shim, treat_warnings_as_errors, warnings_as_errors,
+            warnings_not_as_errors, warning_level, strict_deps, kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| runtime_identifier |

-

| None | +| use_apphost_shim |

-

| True | +| treat_warnings_as_errors |

-

| None | +| warnings_as_errors |

-

| None | +| warnings_not_as_errors |

-

| None | +| warning_level |

-

| None | +| strict_deps |

-

| None | +| kwargs |

-

| none | + + + + +## nuget_repo + +
+nuget_repo(name, packages)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| name |

-

| none | +| packages |

-

| none | + + + + +## publish_binary + +
+publish_binary(name, binary, target_framework, self_contained, runtime_packs, runtime_identifier,
+               kwargs)
+
+ + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| name |

-

| none | +| binary |

-

| none | +| target_framework |

-

| none | +| self_contained |

-

| False | +| runtime_packs |

-

| [] | +| runtime_identifier |

-

| None | +| kwargs |

-

| none | + + diff --git a/dotnet/BUILD.bazel b/dotnet/BUILD.bazel index a49f60fe..ee4518f6 100644 --- a/dotnet/BUILD.bazel +++ b/dotnet/BUILD.bazel @@ -33,9 +33,11 @@ bzl_library( deps = [ "//dotnet/private/rules/csharp:binary", "//dotnet/private/rules/csharp:library", + "//dotnet/private/rules/csharp:nunit_test", "//dotnet/private/rules/csharp:test", "//dotnet/private/rules/fsharp:binary", "//dotnet/private/rules/fsharp:library", + "//dotnet/private/rules/fsharp:nunit_test", "//dotnet/private/rules/fsharp:test", "//dotnet/private/rules/nuget:imports", "//dotnet/private/rules/nuget:nuget_archive", @@ -84,6 +86,29 @@ bzl_library( deps = [":repositories"], ) +bzl_library( + name = "paket.paket2bazel_dependencies_extension", + srcs = ["paket.paket2bazel_dependencies_extension.bzl"], + visibility = ["//visibility:public"], + deps = [":paket.paket2bazel_dependencies"], +) + +bzl_library( + name = "paket.rules_dotnet_dev_nuget_packages_extension", + srcs = ["paket.rules_dotnet_dev_nuget_packages_extension.bzl"], + visibility = ["//visibility:public"], + deps = [":paket.rules_dotnet_dev_nuget_packages"], +) + +bzl_library( + name = "paket.rules_dotnet_nuget_packages_extension", + srcs = ["paket.rules_dotnet_nuget_packages_extension.bzl"], + visibility = ["//visibility:public"], + deps = [":paket.rules_dotnet_nuget_packages"], +) + +exports_files(["defs.bzl"]) + bzl_library( name = "toolchain", srcs = ["toolchain.bzl"], diff --git a/dotnet/private/rules/csharp/BUILD.bazel b/dotnet/private/rules/csharp/BUILD.bazel index 0e46eab8..57f0f8d5 100644 --- a/dotnet/private/rules/csharp/BUILD.bazel +++ b/dotnet/private/rules/csharp/BUILD.bazel @@ -59,6 +59,7 @@ bzl_library( bzl_library( name = "nunit_test", + srcs = ["nunit_test.bzl"], # keep visibility = [ "//docs:__subpackages__", "//dotnet:__subpackages__", diff --git a/dotnet/private/rules/fsharp/BUILD.bazel b/dotnet/private/rules/fsharp/BUILD.bazel index 10a48d43..f5e10dfc 100644 --- a/dotnet/private/rules/fsharp/BUILD.bazel +++ b/dotnet/private/rules/fsharp/BUILD.bazel @@ -58,6 +58,7 @@ bzl_library( bzl_library( name = "nunit_test", + srcs = ["nunit_test.bzl"], # keep visibility = [ "//docs:__subpackages__", "//dotnet:__subpackages__",