diff --git a/packages/commons/README.md b/packages/commons/README.md index 32f797cf..6ccef75c 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -21,6 +21,18 @@ This package exists primarily to help .NET tool developers integrate `axe-core` * [Deque.AxeCore.Playwright](../playwright/README.md) in combination with [Playwright for .NET](https://playwright.dev/dotnet/) * [Deque.AxeCore.Selenium](../selenium/README.md) in combination with [Selenium](https://www.selenium.dev/)'s [C# Selenium.WebDriver package](https://www.nuget.org/packages/Selenium.WebDriver) +### `AxeResult` + +`AxeResult` represents the [axe-core Results Object](https://www.deque.com/axe/core-documentation/api-documentation/#results-object). + +### `AxeRunContext` + +`AxeRunContext` represents the [axe-core Context Parameter](https://www.deque.com/axe/core-documentation/api-documentation/#context-parameter). + +### `AxeRunOptions` + +`AxeRunOptions` represents the [axe-core Options Parameter](https://www.deque.com/axe/core-documentation/api-documentation/#options-parameter). + ## Axe script providers The `IAxeScriptProvider` interface is suitable for use as an option in an API for running an `axe-core` scan of a page. It specifies a single method, `GetScript()`, which returns a string containing JavaScript code suitable for injecting into a running page. @@ -46,11 +58,10 @@ new FileAxeScriptProvider("./path/to/axe.min.js"); axeScriptProvider.GetScript(); // synchronously reads the contents of file ./path/to/axe.min.js ``` - ## License This package, including its embedded copy of [axe-core][axe-core], is distributed under the terms of the [Mozilla Public License, version 2.0](../../LICENSE-Deque.AxeCore.Commons.txt). ## Acknowledgements -This package builds on past work from the [SeleniumAxeDotnet](https://github.com/TroyWalshProf/SeleniumAxeDotnet) and [PlaywrightAxeDotnet](https://github.com/IsaacWalker/PlaywrightAxeDotnet) projects (see [NOTICE.txt](../../NOTICE.txt)). We thank all of those projects' contributors for their work. \ No newline at end of file +This package builds on past work from the [SeleniumAxeDotnet](https://github.com/TroyWalshProf/SeleniumAxeDotnet) and [PlaywrightAxeDotnet](https://github.com/IsaacWalker/PlaywrightAxeDotnet) projects (see [NOTICE.txt](../../NOTICE.txt)). We thank all of those projects' contributors for their work. diff --git a/packages/commons/src/AssemblyInfo.cs b/packages/commons/src/AssemblyInfo.cs new file mode 100644 index 00000000..e1fd6550 --- /dev/null +++ b/packages/commons/src/AssemblyInfo.cs @@ -0,0 +1,3 @@ +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Deque.AxeCore.Commons.Test")] diff --git a/packages/selenium/src/AxeResult.cs b/packages/commons/src/AxeResult.cs similarity index 98% rename from packages/selenium/src/AxeResult.cs rename to packages/commons/src/AxeResult.cs index bed7023e..a197fe7a 100644 --- a/packages/selenium/src/AxeResult.cs +++ b/packages/commons/src/AxeResult.cs @@ -1,7 +1,7 @@ using Newtonsoft.Json.Linq; using System; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeResult { diff --git a/packages/selenium/src/AxeResultCheck.cs b/packages/commons/src/AxeResultCheck.cs similarity index 88% rename from packages/selenium/src/AxeResultCheck.cs rename to packages/commons/src/AxeResultCheck.cs index d550b1e5..3cb5fa4b 100644 --- a/packages/selenium/src/AxeResultCheck.cs +++ b/packages/commons/src/AxeResultCheck.cs @@ -1,4 +1,4 @@ -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeResultCheck { diff --git a/packages/selenium/src/AxeResultItem.cs b/packages/commons/src/AxeResultItem.cs similarity index 90% rename from packages/selenium/src/AxeResultItem.cs rename to packages/commons/src/AxeResultItem.cs index c11773e6..1b37875c 100644 --- a/packages/selenium/src/AxeResultItem.cs +++ b/packages/commons/src/AxeResultItem.cs @@ -1,4 +1,4 @@ -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeResultItem { diff --git a/packages/selenium/src/AxeResultNode.cs b/packages/commons/src/AxeResultNode.cs similarity index 94% rename from packages/selenium/src/AxeResultNode.cs rename to packages/commons/src/AxeResultNode.cs index 5085eebb..1ff6a6c7 100644 --- a/packages/selenium/src/AxeResultNode.cs +++ b/packages/commons/src/AxeResultNode.cs @@ -1,7 +1,7 @@ using Newtonsoft.Json; using System.Collections.Generic; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeResultNode { diff --git a/packages/selenium/src/AxeResultRelatedNode.cs b/packages/commons/src/AxeResultRelatedNode.cs similarity index 91% rename from packages/selenium/src/AxeResultRelatedNode.cs rename to packages/commons/src/AxeResultRelatedNode.cs index da338d22..1199752f 100644 --- a/packages/selenium/src/AxeResultRelatedNode.cs +++ b/packages/commons/src/AxeResultRelatedNode.cs @@ -1,7 +1,7 @@ using Newtonsoft.Json; using System.Collections.Generic; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeResultRelatedNode { diff --git a/packages/selenium/src/AxeResultTarget.cs b/packages/commons/src/AxeResultTarget.cs similarity index 96% rename from packages/selenium/src/AxeResultTarget.cs rename to packages/commons/src/AxeResultTarget.cs index ea64ef69..c19daf95 100644 --- a/packages/selenium/src/AxeResultTarget.cs +++ b/packages/commons/src/AxeResultTarget.cs @@ -1,7 +1,7 @@ using System.Collections.Generic; using System.Text; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { /// /// With AxeResultTarget, we will have either a or for each target. diff --git a/packages/selenium/src/AxeResultTargetConverter.cs b/packages/commons/src/AxeResultTargetConverter.cs similarity index 97% rename from packages/selenium/src/AxeResultTargetConverter.cs rename to packages/commons/src/AxeResultTargetConverter.cs index 2065c719..095c9b2b 100644 --- a/packages/selenium/src/AxeResultTargetConverter.cs +++ b/packages/commons/src/AxeResultTargetConverter.cs @@ -2,7 +2,7 @@ using System; using System.Collections.Generic; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { class AxeResultTargetConverter : JsonConverter { diff --git a/packages/selenium/src/AxeRunContext.cs b/packages/commons/src/AxeRunContext.cs similarity index 88% rename from packages/selenium/src/AxeRunContext.cs rename to packages/commons/src/AxeRunContext.cs index 260e37bf..0ca05dea 100644 --- a/packages/selenium/src/AxeRunContext.cs +++ b/packages/commons/src/AxeRunContext.cs @@ -1,13 +1,13 @@ using Newtonsoft.Json; using System.Collections.Generic; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { /// /// Has the list of selectors that have to be included or excluded from scanning. If not specified the whole document will be scanned /// [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - internal class AxeRunContext + public class AxeRunContext { [JsonProperty("include")] public List Include { get; set; } diff --git a/packages/selenium/src/AxeRunOptions.cs b/packages/commons/src/AxeRunOptions.cs similarity index 99% rename from packages/selenium/src/AxeRunOptions.cs rename to packages/commons/src/AxeRunOptions.cs index eaed741d..52b773cd 100644 --- a/packages/selenium/src/AxeRunOptions.cs +++ b/packages/commons/src/AxeRunOptions.cs @@ -3,7 +3,7 @@ using System.Collections.Generic; using System.Runtime.Serialization; -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { /// /// Used as part of diff --git a/packages/selenium/src/AxeTestEnvironment.cs b/packages/commons/src/AxeTestEnvironment.cs similarity index 87% rename from packages/selenium/src/AxeTestEnvironment.cs rename to packages/commons/src/AxeTestEnvironment.cs index 2f084259..bd695e22 100644 --- a/packages/selenium/src/AxeTestEnvironment.cs +++ b/packages/commons/src/AxeTestEnvironment.cs @@ -1,4 +1,4 @@ -namespace Deque.AxeCore.Selenium +namespace Deque.AxeCore.Commons { public class AxeTestEnvironment { diff --git a/packages/commons/src/Deque.AxeCore.Commons.csproj b/packages/commons/src/Deque.AxeCore.Commons.csproj index dbce680c..0278e955 100644 --- a/packages/commons/src/Deque.AxeCore.Commons.csproj +++ b/packages/commons/src/Deque.AxeCore.Commons.csproj @@ -22,8 +22,12 @@ - - + + + + + +