From a6693c11130515b87e92348c9e80faed02d23276 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 16 Aug 2025 22:07:34 +0000 Subject: [PATCH 1/5] Initial plan From 7a70f105e7807406741bc9d5e216cfa75404a928 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 16 Aug 2025 22:20:07 +0000 Subject: [PATCH 2/5] Add README files and XML docs for core packages: Reqnroll.Parser, Reqnroll.Generator, Reqnroll.Utils, Reqnroll.Tools.MsBuild.Generation Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com> --- Reqnroll.Generator/PackageReadme.md | 20 +++++++++++++ Reqnroll.Generator/Reqnroll.Generator.csproj | 7 +++++ Reqnroll.Parser/PackageReadme.md | 20 +++++++++++++ Reqnroll.Parser/Reqnroll.Parser.csproj | 7 +++++ .../PackageReadme.md | 29 +++++++++++++++++++ .../Reqnroll.Tools.MsBuild.Generation.csproj | 2 ++ .../Reqnroll.Tools.MsBuild.Generation.nuspec | 2 ++ Reqnroll.Utils/PackageReadme.md | 20 +++++++++++++ Reqnroll.Utils/Reqnroll.Utils.csproj | 7 +++++ 9 files changed, 114 insertions(+) create mode 100644 Reqnroll.Generator/PackageReadme.md create mode 100644 Reqnroll.Parser/PackageReadme.md create mode 100644 Reqnroll.Tools.MsBuild.Generation/PackageReadme.md create mode 100644 Reqnroll.Utils/PackageReadme.md diff --git a/Reqnroll.Generator/PackageReadme.md b/Reqnroll.Generator/PackageReadme.md new file mode 100644 index 000000000..e8ee1078f --- /dev/null +++ b/Reqnroll.Generator/PackageReadme.md @@ -0,0 +1,20 @@ +Reqnroll.Generator (pronounced as [reknroʊl]) is the code generation component of the Reqnroll framework. + +This package provides code generation capabilities that convert Gherkin feature files into executable test code for the Reqnroll BDD test automation framework for .NET. + +## Key Features + +- **Code Generation**: Converts Gherkin feature files into C# test code +- **Test Framework Integration**: Supports multiple test frameworks (MSTest, NUnit, xUnit) +- **Binding Generation**: Generates binding code and step definition skeletons +- **Multiple Target Frameworks**: Supports .NET Standard 2.0 and later + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Generator/Reqnroll.Generator.csproj b/Reqnroll.Generator/Reqnroll.Generator.csproj index 0575c31e0..3b8659db5 100644 --- a/Reqnroll.Generator/Reqnroll.Generator.csproj +++ b/Reqnroll.Generator/Reqnroll.Generator.csproj @@ -8,12 +8,19 @@ Reqnroll.Generator $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + true + README.md + $(NoWarn);1591 + + + + diff --git a/Reqnroll.Parser/PackageReadme.md b/Reqnroll.Parser/PackageReadme.md new file mode 100644 index 000000000..001e0e289 --- /dev/null +++ b/Reqnroll.Parser/PackageReadme.md @@ -0,0 +1,20 @@ +Reqnroll.Parser (pronounced as [reknroʊl]) is the Gherkin parsing component of the Reqnroll framework. + +This package provides Gherkin feature file parsing capabilities that convert Gherkin syntax into structured data models for the Reqnroll BDD test automation framework for .NET. + +## Key Features + +- **Gherkin Parsing**: Parses `.feature` files written in Gherkin syntax +- **Structured Output**: Converts Gherkin files into structured data models +- **Multi-language Support**: Supports Gherkin keywords in multiple languages +- **Error Handling**: Provides detailed parsing error information + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Parser/Reqnroll.Parser.csproj b/Reqnroll.Parser/Reqnroll.Parser.csproj index fa3697c0a..06cf0a038 100644 --- a/Reqnroll.Parser/Reqnroll.Parser.csproj +++ b/Reqnroll.Parser/Reqnroll.Parser.csproj @@ -8,12 +8,19 @@ Reqnroll.Parser $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + true + README.md + $(NoWarn);1591 + + + + diff --git a/Reqnroll.Tools.MsBuild.Generation/PackageReadme.md b/Reqnroll.Tools.MsBuild.Generation/PackageReadme.md new file mode 100644 index 000000000..610d7808d --- /dev/null +++ b/Reqnroll.Tools.MsBuild.Generation/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.Tools.MsBuild.Generation (pronounced as [reknroʊl]) enables code-behind file generation during build time for Reqnroll projects. + +This package provides MSBuild tasks and targets that automatically generate test code from Gherkin feature files during the build process, eliminating the need for manual code generation. + +## Key Features + +- **Build-Time Code Generation**: Automatically generates test code during MSBuild process +- **Multi-Targeting Support**: Works with both .NET Framework and .NET Core projects +- **Custom Build Configuration**: Configurable build options and target frameworks +- **IDE Integration**: Seamless integration with Visual Studio and other IDEs + +## Usage + +This package is automatically included when you install one of the Reqnroll test framework packages: +- Reqnroll.MSTest +- Reqnroll.NUnit +- Reqnroll.xUnit + +## Documentation + +For more information about build configuration and code generation, see: +- [Configuring Build](https://docs.reqnroll.net/installation/configuring-build.html) +- [Code Generation](https://docs.reqnroll.net/automation/code-generation.html) + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj index d2d992be3..698d24a46 100644 --- a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj +++ b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj @@ -10,6 +10,8 @@ true true false + true + $(NoWarn);1591 diff --git a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec index 524c4881a..723ce6a81 100644 --- a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec +++ b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec @@ -6,6 +6,7 @@ Reqnroll.Tools.MsBuild.Generation $author$ $owner$ + README.md Package to enable the code-behind file generation during build time http://reqnroll.net/documentation/Generate-Tests-from-MsBuild/ en-US https://www.reqnroll.net @@ -29,6 +30,7 @@ + \ No newline at end of file diff --git a/Reqnroll.Utils/PackageReadme.md b/Reqnroll.Utils/PackageReadme.md new file mode 100644 index 000000000..54fc60781 --- /dev/null +++ b/Reqnroll.Utils/PackageReadme.md @@ -0,0 +1,20 @@ +Reqnroll.Utils (pronounced as [reknroʊl]) provides utility classes and helper functions for the Reqnroll framework. + +This package contains common utilities and helper classes used by various components of the Reqnroll BDD test automation framework for .NET. + +## Key Features + +- **Common Utilities**: Shared utility classes and helper methods +- **Configuration Helpers**: Configuration-related utility functions +- **File System Utilities**: File and directory manipulation helpers +- **Extension Methods**: Commonly used extension methods + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Utils/Reqnroll.Utils.csproj b/Reqnroll.Utils/Reqnroll.Utils.csproj index 06c36a843..6ad578ddd 100644 --- a/Reqnroll.Utils/Reqnroll.Utils.csproj +++ b/Reqnroll.Utils/Reqnroll.Utils.csproj @@ -7,5 +7,12 @@ $(Reqnroll_KeyFile) $(Reqnroll_EnableStrongNameSigning) $(Reqnroll_PublicSign) + true + README.md + $(NoWarn);1591 + + + + From 0a41b268f726f14d09a78489e8cdceba19f9a2a7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 16 Aug 2025 22:26:47 +0000 Subject: [PATCH 3/5] Add README files and XML docs for test framework packages: MSTest, NUnit, xUnit, TUnit Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com> --- .../PackageReadme.md | 34 ++++++++++++++++++ ...oll.MSTest.Generator.ReqnrollPlugin.csproj | 2 ++ .../Reqnroll.MSTest.nuspec | 2 ++ .../PackageReadme.md | 35 +++++++++++++++++++ ...roll.NUnit.Generator.ReqnrollPlugin.csproj | 2 ++ .../Reqnroll.NUnit.nuspec | 2 ++ .../PackageReadme.md | 35 +++++++++++++++++++ ...roll.TUnit.Generator.ReqnrollPlugin.csproj | 3 +- .../Reqnroll.TUnit.nuspec | 2 ++ .../PackageReadme.md | 35 +++++++++++++++++++ ...roll.xUnit.Generator.ReqnrollPlugin.csproj | 2 ++ .../Reqnroll.xUnit.nuspec | 2 ++ 12 files changed, 155 insertions(+), 1 deletion(-) create mode 100644 Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..7dc75942a --- /dev/null +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,34 @@ +Reqnroll.MSTest (pronounced as [reknroʊl]) enables using Reqnroll with MSTest v2 test framework. + +This package provides integration between Reqnroll and MSTest, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework. + +## Key Features + +- **MSTest Integration**: Seamless integration with MSTest v2 test framework +- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax +- **Test Discovery**: Automatic test discovery by MSTest runners +- **Parameterized Tests**: Support for scenario outlines and examples +- **Parallel Execution**: Support for parallel test execution + +## Installation + +Install this package to add Reqnroll support to your MSTest project: + +```bash +dotnet add package Reqnroll.MSTest +``` + +This package automatically includes: +- Reqnroll core functionality +- MSTest integration components +- Build-time code generation tools + +## Documentation + +For more information about using Reqnroll with MSTest, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj index 29f0d76a9..239c6960d 100644 --- a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj @@ -7,6 +7,8 @@ $(Reqnroll_PublicSign) Reqnroll.MsTest true + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec index 4dc83fc58..76ce0290e 100644 --- a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec @@ -6,6 +6,7 @@ Reqnroll.MsTest $author$ $owner$ + README.md Package to use Reqnroll for use with MsTest v2. $summary$ en-US https://www.reqnroll.net @@ -32,6 +33,7 @@ + diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..03c5853d3 --- /dev/null +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,35 @@ +Reqnroll.NUnit (pronounced as [reknroʊl]) enables using Reqnroll with NUnit test framework. + +This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework. + +## Key Features + +- **NUnit Integration**: Seamless integration with NUnit test framework +- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax +- **Test Discovery**: Automatic test discovery by NUnit runners +- **Parameterized Tests**: Support for scenario outlines and examples +- **Parallel Execution**: Support for parallel test execution +- **Rich Assertions**: Full access to NUnit's assertion framework + +## Installation + +Install this package to add Reqnroll support to your NUnit project: + +```bash +dotnet add package Reqnroll.NUnit +``` + +This package automatically includes: +- Reqnroll core functionality +- NUnit integration components +- Build-time code generation tools + +## Documentation + +For more information about using Reqnroll with NUnit, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj index 963ebbf17..aa8ec368f 100644 --- a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj @@ -7,6 +7,8 @@ $(Reqnroll_PublicSign) Reqnroll.NUnit true + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec index 97f8b4d4a..add209fe7 100644 --- a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec @@ -6,6 +6,7 @@ Reqnroll.NUnit $author$ $owner$ + README.md Package to use Reqnroll with NUnit 3.13 and later. $summary$ en-US https://www.reqnroll.net @@ -32,6 +33,7 @@ + diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..7f9903e5e --- /dev/null +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,35 @@ +Reqnroll.TUnit (pronounced as [reknroʊl]) enables using Reqnroll with TUnit test framework. + +This package provides integration between Reqnroll and TUnit, allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework. + +## Key Features + +- **TUnit Integration**: Seamless integration with TUnit test framework +- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax +- **Test Discovery**: Automatic test discovery by TUnit runners +- **Parameterized Tests**: Support for scenario outlines and examples +- **Parallel Execution**: Support for parallel test execution +- **Modern Testing**: Full access to TUnit's modern testing features + +## Installation + +Install this package to add Reqnroll support to your TUnit project: + +```bash +dotnet add package Reqnroll.TUnit +``` + +This package automatically includes: +- Reqnroll core functionality +- TUnit integration components +- Build-time code generation tools + +## Documentation + +For more information about using Reqnroll with TUnit, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj index 7c075b03e..fad11872f 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj @@ -9,7 +9,8 @@ Reqnroll.TUnit true - $(NoWarn);NU5128 + $(NoWarn);NU5128;1591 + true diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec index 5e46a6702..15cb6b47f 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec @@ -6,6 +6,7 @@ Reqnroll.TUnit $author$ $owner$ + README.md Package to use Reqnroll with TUnit 0.25.21 and later. $summary$ en-US https://www.reqnroll.net @@ -31,6 +32,7 @@ + diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..26f0b07c3 --- /dev/null +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,35 @@ +Reqnroll.xUnit (pronounced as [reknroʊl]) enables using Reqnroll with xUnit test framework. + +This package provides integration between Reqnroll and xUnit, allowing you to write BDD tests using Gherkin syntax that run with the xUnit test framework. + +## Key Features + +- **xUnit Integration**: Seamless integration with xUnit test framework +- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax +- **Test Discovery**: Automatic test discovery by xUnit runners +- **Parameterized Tests**: Support for scenario outlines and examples +- **Parallel Execution**: Support for parallel test execution +- **Rich Assertions**: Full access to xUnit's assertion framework + +## Installation + +Install this package to add Reqnroll support to your xUnit project: + +```bash +dotnet add package Reqnroll.xUnit +``` + +This package automatically includes: +- Reqnroll core functionality +- xUnit integration components +- Build-time code generation tools + +## Documentation + +For more information about using Reqnroll with xUnit, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.Generator.ReqnrollPlugin.csproj b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.Generator.ReqnrollPlugin.csproj index 89e8b7d58..38ffe0dda 100644 --- a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.Generator.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.Generator.ReqnrollPlugin.csproj @@ -7,6 +7,8 @@ $(Reqnroll_PublicSign) true Reqnroll.xUnit + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec index 67565a74b..84c47c80b 100644 --- a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec @@ -6,6 +6,7 @@ Reqnroll.xUnit $author$ $owner$ + README.md Package to use Reqnroll with xUnit 2.x. Note: this package won't support xUnit 3.x. $summary$ en-US https://www.reqnroll.net @@ -40,6 +41,7 @@ + From d01d9a3937d754b42b7a38f330b8afa7c3df9f25 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 16 Aug 2025 22:35:21 +0000 Subject: [PATCH 4/5] Add README files and XML docs for remaining plugins: Autofac, Windsor, DI, ExternalData, Verify, SpecFlowCompatibility, CustomPlugin, Templates Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com> --- .../PackageReadme.md | 29 ++++++++++++ .../Reqnroll.Autofac.ReqnrollPlugin.csproj | 2 + .../Reqnroll.Autofac.nuspec | 2 + .../Reqnroll.CustomPlugin/PackageReadme.md | 29 ++++++++++++ .../Reqnroll.CustomPlugin.csproj | 3 +- .../Reqnroll.CustomPlugin.nuspec | 2 + .../PackageReadme.md | 29 ++++++++++++ .../Reqnroll.ExternalData.nuspec | 2 + .../PackageReadme.md | 29 ++++++++++++ ...soft.Extensions.DependencyInjection.nuspec | 2 + .../PackageReadme.md | 29 ++++++++++++ .../Reqnroll.SpecFlowCompatibility.nuspec | 2 + .../PackageReadme.md | 29 ++++++++++++ .../Reqnroll.Verify.nuspec | 2 + .../PackageReadme.md | 29 ++++++++++++ .../Reqnroll.Windsor.ReqnrollPlugin.csproj | 2 + .../Reqnroll.Windsor.nuspec | 2 + .../PackageReadme.md | 44 +++++++++++++++++++ .../Reqnroll.Templates.DotNet.csproj | 2 + 19 files changed, 269 insertions(+), 1 deletion(-) create mode 100644 Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.CustomPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md create mode 100644 Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md create mode 100644 Templates/Reqnroll.Templates.DotNet/PackageReadme.md diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..57f2b5d44 --- /dev/null +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.Autofac (pronounced as [reknroʊl]) provides Autofac dependency injection integration for Reqnroll. + +This package enables Reqnroll to use Autofac as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. + +## Key Features + +- **Autofac Integration**: Use Autofac as your DI container in Reqnroll projects +- **Step Definition Injection**: Automatic dependency injection for step definition classes +- **Hook Injection**: Dependency injection support for before/after hooks +- **Lifecycle Management**: Proper scoping and lifecycle management of dependencies +- **Easy Configuration**: Simple setup and configuration + +## Installation + +Install this package to add Autofac dependency injection support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.Autofac +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj index 52f3bf3cf..f0d0c839b 100644 --- a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj @@ -10,6 +10,8 @@ $(MSBuildThisFileDirectory)Reqnroll.Autofac.nuspec Reqnroll.Autofac + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec index 6e4a7286b..acca27eed 100644 --- a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec @@ -6,6 +6,7 @@ Reqnroll Autofac integration plugin Gaspar Nagy, Spec Solutions, $author$ Gaspar Nagy, Spec Solutions, $owner$ + README.md Reqnroll plugin that enables to use Autofac for resolving test dependencies. en-US https://www.reqnroll.net @@ -29,6 +30,7 @@ + \ No newline at end of file diff --git a/Plugins/Reqnroll.CustomPlugin/PackageReadme.md b/Plugins/Reqnroll.CustomPlugin/PackageReadme.md new file mode 100644 index 000000000..d3fb49c5d --- /dev/null +++ b/Plugins/Reqnroll.CustomPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.CustomPlugin (pronounced as [reknroʊl]) provides a sample custom plugin for Reqnroll. + +This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions. + +## Key Features + +- **Plugin Template**: Serves as a starting point for custom plugin development +- **Extension Examples**: Shows how to extend Reqnroll functionality +- **Custom Generators**: Demonstrates custom code generation capabilities +- **Plugin Architecture**: Illustrates Reqnroll's plugin architecture +- **Development Guide**: Provides examples for plugin developers + +## Installation + +This package is primarily for development and educational purposes: + +```bash +dotnet add package Reqnroll.CustomPlugin +``` + +## Documentation + +For more information about creating custom Reqnroll plugins, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj index bc4b0f3d0..68d636138 100644 --- a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj +++ b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj @@ -7,7 +7,8 @@ true true - + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec index fd46fbe3f..fb2f0c1b6 100644 --- a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec +++ b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec @@ -6,6 +6,7 @@ Reqnroll.CustomPlugin $author$ $owner$ + README.md Package for writing custom generator extensions for Reqnroll. en-US https://www.reqnroll.net @@ -29,6 +30,7 @@ + diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..8c789f9c3 --- /dev/null +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.ExternalData (pronounced as [reknroʊl]) provides external data loading capabilities for Reqnroll scenarios. + +This package enables Reqnroll to load test data from external sources such as CSV files, JSON files, and other data formats, allowing for more flexible and maintainable test scenarios. + +## Key Features + +- **External Data Sources**: Load test data from CSV, JSON, and other file formats +- **Scenario Outlines Enhancement**: Extend scenario outlines with external data +- **Dynamic Data Loading**: Load data dynamically during test execution +- **Multiple Formats**: Support for various data file formats +- **Data Transformation**: Transform and filter external data as needed + +## Installation + +Install this package to add external data loading support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.ExternalData +``` + +## Documentation + +For more information about using external data with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec index fcc75666f..3b6cff557 100644 --- a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec @@ -5,6 +5,7 @@ Reqnroll.ExternalData $author$ $owner$ + README.md Package to use external data in Gherkin scenarios en-US https://www.reqnroll.net @@ -24,6 +25,7 @@ + \ No newline at end of file diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..94783f78c --- /dev/null +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.Microsoft.Extensions.DependencyInjection (pronounced as [reknroʊl]) provides Microsoft.Extensions.DependencyInjection integration for Reqnroll. + +This package enables Reqnroll to use the standard .NET dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. + +## Key Features + +- **Microsoft DI Integration**: Use the standard .NET DI container in Reqnroll projects +- **Step Definition Injection**: Automatic dependency injection for step definition classes +- **Hook Injection**: Dependency injection support for before/after hooks +- **Service Collection Support**: Easy registration using IServiceCollection +- **Scope Management**: Proper scoping and lifecycle management of dependencies + +## Installation + +Install this package to add Microsoft.Extensions.DependencyInjection support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.Microsoft.Extensions.DependencyInjection +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec index b46da98c4..67f4b037f 100644 --- a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec @@ -6,6 +6,7 @@ Reqnroll Microsoft.Extensions.DependencyInjection integration plugin Mark Hoek, Solid Token, Stef Heyenrath, $author$ Mark Hoek, Solid Token, Stef Heyenrath, $owner$ + README.md Reqnroll plugin that enables to use Microsoft.Extensions.DependencyInjection for resolving test dependencies. en-US https://www.reqnroll.net @@ -29,6 +30,7 @@ + diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..a882c9111 --- /dev/null +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.SpecFlowCompatibility (pronounced as [reknroʊl]) provides compatibility layer for migrating from SpecFlow to Reqnroll. + +This package helps ease the migration from SpecFlow by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll. + +## Key Features + +- **Migration Support**: Ease the transition from SpecFlow to Reqnroll +- **Compatibility Layer**: Provides compatibility with existing SpecFlow code +- **Gradual Migration**: Allows incremental migration of test suites +- **API Compatibility**: Maintains compatibility with common SpecFlow APIs +- **Legacy Code Support**: Supports legacy SpecFlow patterns and conventions + +## Installation + +Install this package to add SpecFlow compatibility support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.SpecFlowCompatibility +``` + +## Documentation + +For more information about migrating from SpecFlow to Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec index 584128313..9c91c576c 100644 --- a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec @@ -6,6 +6,7 @@ Reqnroll.SpecFlowCompatibility $author$ $owner$ + README.md Enables SpecFlow compatibility mode for Reqnroll en-US https://www.reqnroll.net @@ -35,6 +36,7 @@ + diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..defb02689 --- /dev/null +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.Verify (pronounced as [reknroʊl]) provides integration with Verify for snapshot testing in Reqnroll scenarios. + +This package enables Reqnroll to use Verify for approval/snapshot testing, allowing you to verify complex objects, text outputs, and other test results using the Verify library. + +## Key Features + +- **Verify Integration**: Use Verify for snapshot/approval testing in Reqnroll +- **Object Verification**: Verify complex objects and data structures +- **Text Verification**: Verify text outputs and formatted content +- **Automatic Approval**: Streamlined approval process for snapshot tests +- **Multiple Formats**: Support for various output formats and serializers + +## Installation + +Install this package to add Verify snapshot testing support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.Verify +``` + +## Documentation + +For more information about using Verify with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec index 6b5df1ee2..59af3dd34 100644 --- a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec @@ -5,6 +5,7 @@ Reqnroll.Verify $author$ $owner$ + README.md Package to use Verify.Xunit with Reqnroll en-US https://www.reqnroll.net @@ -34,6 +35,7 @@ + \ No newline at end of file diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md new file mode 100644 index 000000000..475339266 --- /dev/null +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md @@ -0,0 +1,29 @@ +Reqnroll.Windsor (pronounced as [reknroʊl]) provides Castle Windsor dependency injection integration for Reqnroll. + +This package enables Reqnroll to use Castle Windsor as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. + +## Key Features + +- **Castle Windsor Integration**: Use Castle Windsor as your DI container in Reqnroll projects +- **Step Definition Injection**: Automatic dependency injection for step definition classes +- **Hook Injection**: Dependency injection support for before/after hooks +- **Lifecycle Management**: Proper scoping and lifecycle management of dependencies +- **Interceptor Support**: Take advantage of Windsor's AOP capabilities + +## Installation + +Install this package to add Castle Windsor dependency injection support to your Reqnroll project: + +```bash +dotnet add package Reqnroll.Windsor +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj index 7e49c3a58..3d40a2f50 100644 --- a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj @@ -8,6 +8,8 @@ Reqnroll.Windsor true $(MSBuildThisFileDirectory)Reqnroll.Windsor.nuspec + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec index c13a790ec..24f090a02 100644 --- a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec @@ -6,6 +6,7 @@ Reqnroll Windsor integration plugin $author$ Gaspar Nagy, Spec Solutions, $owner$ + README.md Reqnroll plugin that enables to use Windsor for resolving test dependencies. en-US https://www.reqnroll.net @@ -29,6 +30,7 @@ + \ No newline at end of file diff --git a/Templates/Reqnroll.Templates.DotNet/PackageReadme.md b/Templates/Reqnroll.Templates.DotNet/PackageReadme.md new file mode 100644 index 000000000..1a915640c --- /dev/null +++ b/Templates/Reqnroll.Templates.DotNet/PackageReadme.md @@ -0,0 +1,44 @@ +Reqnroll.Templates.DotNet (pronounced as [reknroʊl]) provides dotnet new templates for creating Reqnroll projects and files. + +This package contains project templates and item templates that can be used with the `dotnet new` command to quickly scaffold Reqnroll projects and add common files to existing projects. + +## Key Features + +- **Project Templates**: Templates for creating new Reqnroll projects with different test frameworks +- **Item Templates**: Templates for adding Reqnroll configuration files and feature files +- **Test Framework Support**: Templates for MSTest, NUnit, and xUnit projects +- **Quick Setup**: Fast way to get started with Reqnroll +- **Best Practices**: Templates follow Reqnroll best practices and conventions + +## Installation + +Install the templates globally to use with dotnet new: + +```bash +dotnet new install Reqnroll.Templates.DotNet +``` + +## Usage + +After installation, you can create new projects and files: + +```bash +# Create a new Reqnroll project +dotnet new reqnroll-project + +# Add a configuration file +dotnet new reqnroll-config + +# Add a feature file +dotnet new reqnroll-feature +``` + +## Documentation + +For more information about Reqnroll templates and getting started, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj index 2fad44e9e..9dfd62f17 100644 --- a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj +++ b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj @@ -15,6 +15,7 @@ true true false + README.md true @@ -24,6 +25,7 @@ + From 3eb6338469b23815bc808e5167dc3c8b35d2096d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 21:04:40 +0000 Subject: [PATCH 5/5] Address README feedback: rename files, remove pronunciation guides, update links, change bash to powershell Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com> --- .../{PackageReadme.md => README.md} | 9 ++++----- .../Reqnroll.Autofac.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.ExternalData.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.MSTest.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- ...oll.Microsoft.Extensions.DependencyInjection.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.NUnit.nuspec | 2 +- .../{PackageReadme.md => README.md} | 10 +++++----- .../Reqnroll.SpecFlowCompatibility.nuspec | 2 +- .../{PackageReadme.md => README.md} | 10 +++++----- .../Reqnroll.TUnit.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.Verify.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.Windsor.nuspec | 2 +- .../{PackageReadme.md => README.md} | 8 ++++---- .../Reqnroll.xUnit.nuspec | 2 +- Reqnroll.Generator/{PackageReadme.md => README.md} | 6 +++--- Reqnroll.Generator/Reqnroll.Generator.csproj | 2 +- Reqnroll.Parser/{PackageReadme.md => README.md} | 4 ++-- Reqnroll.Parser/Reqnroll.Parser.csproj | 2 +- .../{PackageReadme.md => README.md} | 4 ++-- .../Reqnroll.Tools.MsBuild.Generation.nuspec | 2 +- Reqnroll.Utils/{PackageReadme.md => README.md} | 4 ++-- Reqnroll.Utils/Reqnroll.Utils.csproj | 2 +- Reqnroll/{PackageReadme.md => README.md} | 0 Reqnroll/Reqnroll.nuspec | 2 +- .../{PackageReadme.md => README.md} | 10 +++++----- .../Reqnroll.Templates.DotNet.csproj | 2 +- 34 files changed, 77 insertions(+), 78 deletions(-) rename Plugins/Reqnroll.Autofac.ReqnrollPlugin/{PackageReadme.md => README.md} (76%) rename Plugins/Reqnroll.CustomPlugin/{PackageReadme.md => README.md} (82%) rename Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/{PackageReadme.md => README.md} (80%) rename Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/{PackageReadme.md => README.md} (78%) rename Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/{PackageReadme.md => README.md} (74%) rename Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/{PackageReadme.md => README.md} (83%) rename Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/{PackageReadme.md => README.md} (61%) rename Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/{PackageReadme.md => README.md} (71%) rename Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/{PackageReadme.md => README.md} (78%) rename Plugins/Reqnroll.Windsor.ReqnrollPlugin/{PackageReadme.md => README.md} (78%) rename Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/{PackageReadme.md => README.md} (82%) rename Reqnroll.Generator/{PackageReadme.md => README.md} (68%) rename Reqnroll.Parser/{PackageReadme.md => README.md} (83%) rename Reqnroll.Tools.MsBuild.Generation/{PackageReadme.md => README.md} (85%) rename Reqnroll.Utils/{PackageReadme.md => README.md} (80%) rename Reqnroll/{PackageReadme.md => README.md} (100%) rename Templates/Reqnroll.Templates.DotNet/{PackageReadme.md => README.md} (82%) diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md similarity index 76% rename from Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md index 57f2b5d44..0e6969616 100644 --- a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.Autofac (pronounced as [reknroʊl]) provides Autofac dependency injection integration for Reqnroll. +Reqnroll.Autofac provides [Autofac](https://github.com/autofac/Autofac) dependency injection integration for Reqnroll. This package enables Reqnroll to use Autofac as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. @@ -8,22 +8,21 @@ This package enables Reqnroll to use Autofac as the dependency injection contain - **Step Definition Injection**: Automatic dependency injection for step definition classes - **Hook Injection**: Dependency injection support for before/after hooks - **Lifecycle Management**: Proper scoping and lifecycle management of dependencies -- **Easy Configuration**: Simple setup and configuration ## Installation Install this package to add Autofac dependency injection support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.Autofac ``` ## Documentation -For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec index acca27eed..6bc386add 100644 --- a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec @@ -30,7 +30,7 @@ - + \ No newline at end of file diff --git a/Plugins/Reqnroll.CustomPlugin/PackageReadme.md b/Plugins/Reqnroll.CustomPlugin/README.md similarity index 82% rename from Plugins/Reqnroll.CustomPlugin/PackageReadme.md rename to Plugins/Reqnroll.CustomPlugin/README.md index d3fb49c5d..8e1fd86e1 100644 --- a/Plugins/Reqnroll.CustomPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.CustomPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.CustomPlugin (pronounced as [reknroʊl]) provides a sample custom plugin for Reqnroll. +Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll. This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions. @@ -14,16 +14,16 @@ This package serves as a template and example for creating custom plugins that e This package is primarily for development and educational purposes: -```bash +```powershell dotnet add package Reqnroll.CustomPlugin ``` ## Documentation -For more information about creating custom Reqnroll plugins, visit the [documentation](https://docs.reqnroll.net/). +For more information about creating custom Reqnroll plugins, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec index fb2f0c1b6..1b254d7a0 100644 --- a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec +++ b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec @@ -30,7 +30,7 @@ - + diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md similarity index 80% rename from Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md index 8c789f9c3..fba420949 100644 --- a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.ExternalData (pronounced as [reknroʊl]) provides external data loading capabilities for Reqnroll scenarios. +Reqnroll.ExternalData provides external data loading capabilities for Reqnroll scenarios. This package enables Reqnroll to load test data from external sources such as CSV files, JSON files, and other data formats, allowing for more flexible and maintainable test scenarios. @@ -14,16 +14,16 @@ This package enables Reqnroll to load test data from external sources such as CS Install this package to add external data loading support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.ExternalData ``` ## Documentation -For more information about using external data with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about using external data with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec index 3b6cff557..7d3404874 100644 --- a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec @@ -25,7 +25,7 @@ - + \ No newline at end of file diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md similarity index 78% rename from Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md index 7dc75942a..461f2e275 100644 --- a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.MSTest (pronounced as [reknroʊl]) enables using Reqnroll with MSTest v2 test framework. +Reqnroll.MSTest enables using Reqnroll with [MSTest v2 test framework](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-csharp-with-mstest). This package provides integration between Reqnroll and MSTest, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework. @@ -14,7 +14,7 @@ This package provides integration between Reqnroll and MSTest, allowing you to w Install this package to add Reqnroll support to your MSTest project: -```bash +```powershell dotnet add package Reqnroll.MSTest ``` @@ -25,10 +25,10 @@ This package automatically includes: ## Documentation -For more information about using Reqnroll with MSTest, visit the [documentation](https://docs.reqnroll.net/). +For more information about using Reqnroll with MSTest, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec index 76ce0290e..5c003af17 100644 --- a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec @@ -33,7 +33,7 @@ - + diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md similarity index 74% rename from Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md index 94783f78c..da541847d 100644 --- a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.Microsoft.Extensions.DependencyInjection (pronounced as [reknroʊl]) provides Microsoft.Extensions.DependencyInjection integration for Reqnroll. +Reqnroll.Microsoft.Extensions.DependencyInjection provides [Microsoft.Extensions.DependencyInjection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage) integration for Reqnroll. This package enables Reqnroll to use the standard .NET dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. @@ -14,16 +14,16 @@ This package enables Reqnroll to use the standard .NET dependency injection cont Install this package to add Microsoft.Extensions.DependencyInjection support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.Microsoft.Extensions.DependencyInjection ``` ## Documentation -For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec index 67f4b037f..2b1b686a5 100644 --- a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec @@ -30,7 +30,7 @@ - + diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md similarity index 83% rename from Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md index 03c5853d3..54e1c40e2 100644 --- a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.NUnit (pronounced as [reknroʊl]) enables using Reqnroll with NUnit test framework. +Reqnroll.NUnit enables using Reqnroll with [NUnit test framework](https://nunit.org/). This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework. @@ -15,7 +15,7 @@ This package provides integration between Reqnroll and NUnit, allowing you to wr Install this package to add Reqnroll support to your NUnit project: -```bash +```powershell dotnet add package Reqnroll.NUnit ``` @@ -26,10 +26,10 @@ This package automatically includes: ## Documentation -For more information about using Reqnroll with NUnit, visit the [documentation](https://docs.reqnroll.net/). +For more information about using Reqnroll with NUnit, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec index add209fe7..f16e56408 100644 --- a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec @@ -33,7 +33,7 @@ - + diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md similarity index 61% rename from Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md index a882c9111..b94f4ec84 100644 --- a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md @@ -1,6 +1,6 @@ -Reqnroll.SpecFlowCompatibility (pronounced as [reknroʊl]) provides compatibility layer for migrating from SpecFlow to Reqnroll. +Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow to Reqnroll. -This package helps ease the migration from SpecFlow by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll. +This package helps ease the [migration from SpecFlow](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html) by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll. ## Key Features @@ -14,16 +14,16 @@ This package helps ease the migration from SpecFlow by providing compatibility s Install this package to add SpecFlow compatibility support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.SpecFlowCompatibility ``` ## Documentation -For more information about migrating from SpecFlow to Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about migrating from SpecFlow to Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec index 9c91c576c..b63d5b7de 100644 --- a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec @@ -36,7 +36,7 @@ - + diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md similarity index 71% rename from Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md index 7f9903e5e..6a5daf3b5 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md @@ -1,6 +1,6 @@ -Reqnroll.TUnit (pronounced as [reknroʊl]) enables using Reqnroll with TUnit test framework. +Reqnroll.TUnit enables using Reqnroll with TUnit test framework. -This package provides integration between Reqnroll and TUnit, allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework. +This package provides integration between Reqnroll and [TUnit](https://tunit.dev/), allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework. ## Key Features @@ -15,7 +15,7 @@ This package provides integration between Reqnroll and TUnit, allowing you to wr Install this package to add Reqnroll support to your TUnit project: -```bash +```powershell dotnet add package Reqnroll.TUnit ``` @@ -26,10 +26,10 @@ This package automatically includes: ## Documentation -For more information about using Reqnroll with TUnit, visit the [documentation](https://docs.reqnroll.net/). +For more information about using Reqnroll with TUnit, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec index 15cb6b47f..1d7438ee0 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec @@ -32,7 +32,7 @@ - + diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md similarity index 78% rename from Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md index defb02689..d8fcb83d0 100644 --- a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.Verify (pronounced as [reknroʊl]) provides integration with Verify for snapshot testing in Reqnroll scenarios. +Reqnroll.Verify provides integration with [Verify](https://github.com/VerifyTests/Verify) for snapshot testing in Reqnroll scenarios. This package enables Reqnroll to use Verify for approval/snapshot testing, allowing you to verify complex objects, text outputs, and other test results using the Verify library. @@ -14,16 +14,16 @@ This package enables Reqnroll to use Verify for approval/snapshot testing, allow Install this package to add Verify snapshot testing support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.Verify ``` ## Documentation -For more information about using Verify with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about using Verify with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec index 59af3dd34..d5d268a65 100644 --- a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec @@ -35,7 +35,7 @@ - + \ No newline at end of file diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md similarity index 78% rename from Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md index 475339266..1dc12d1bd 100644 --- a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.Windsor (pronounced as [reknroʊl]) provides Castle Windsor dependency injection integration for Reqnroll. +Reqnroll.Windsor provides [Castle Windsor](https://github.com/castleproject/Windsor) dependency injection integration for Reqnroll. This package enables Reqnroll to use Castle Windsor as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. @@ -14,16 +14,16 @@ This package enables Reqnroll to use Castle Windsor as the dependency injection Install this package to add Castle Windsor dependency injection support to your Reqnroll project: -```bash +```powershell dotnet add package Reqnroll.Windsor ``` ## Documentation -For more information about using dependency injection with Reqnroll, visit the [documentation](https://docs.reqnroll.net/). +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec index 24f090a02..1f473a950 100644 --- a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec @@ -30,7 +30,7 @@ - + \ No newline at end of file diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md similarity index 82% rename from Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md rename to Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md index 26f0b07c3..719261198 100644 --- a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/PackageReadme.md +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md @@ -1,4 +1,4 @@ -Reqnroll.xUnit (pronounced as [reknroʊl]) enables using Reqnroll with xUnit test framework. +Reqnroll.xUnit enables using Reqnroll with [xUnit test framework](https://xunit.net/?tabs=cs). This package provides integration between Reqnroll and xUnit, allowing you to write BDD tests using Gherkin syntax that run with the xUnit test framework. @@ -15,7 +15,7 @@ This package provides integration between Reqnroll and xUnit, allowing you to wr Install this package to add Reqnroll support to your xUnit project: -```bash +```powershell dotnet add package Reqnroll.xUnit ``` @@ -26,10 +26,10 @@ This package automatically includes: ## Documentation -For more information about using Reqnroll with xUnit, visit the [documentation](https://docs.reqnroll.net/). +For more information about using Reqnroll with xUnit, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec index 84c47c80b..dd8b83a71 100644 --- a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec @@ -41,7 +41,7 @@ - + diff --git a/Reqnroll.Generator/PackageReadme.md b/Reqnroll.Generator/README.md similarity index 68% rename from Reqnroll.Generator/PackageReadme.md rename to Reqnroll.Generator/README.md index e8ee1078f..d6159514f 100644 --- a/Reqnroll.Generator/PackageReadme.md +++ b/Reqnroll.Generator/README.md @@ -1,6 +1,6 @@ -Reqnroll.Generator (pronounced as [reknroʊl]) is the code generation component of the Reqnroll framework. +Reqnroll.Generator is the code generation component of the Reqnroll framework. -This package provides code generation capabilities that convert Gherkin feature files into executable test code for the Reqnroll BDD test automation framework for .NET. +This package provides code generation capabilities that convert Gherkin feature files into executable test code for the Reqnroll BDD test automation framework for .NET. For generator configuration options, see the [Generator Configuration Documentation](https://docs.reqnroll.net/latest/installation/configuration.html#generator). ## Key Features @@ -15,6 +15,6 @@ For more information about Reqnroll and its components, visit the [documentation ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Generator/Reqnroll.Generator.csproj b/Reqnroll.Generator/Reqnroll.Generator.csproj index 3b8659db5..780d0d16a 100644 --- a/Reqnroll.Generator/Reqnroll.Generator.csproj +++ b/Reqnroll.Generator/Reqnroll.Generator.csproj @@ -18,7 +18,7 @@ - + diff --git a/Reqnroll.Parser/PackageReadme.md b/Reqnroll.Parser/README.md similarity index 83% rename from Reqnroll.Parser/PackageReadme.md rename to Reqnroll.Parser/README.md index 001e0e289..3bb2ea219 100644 --- a/Reqnroll.Parser/PackageReadme.md +++ b/Reqnroll.Parser/README.md @@ -1,4 +1,4 @@ -Reqnroll.Parser (pronounced as [reknroʊl]) is the Gherkin parsing component of the Reqnroll framework. +Reqnroll.Parser is the Gherkin parsing component of the Reqnroll framework. This package provides Gherkin feature file parsing capabilities that convert Gherkin syntax into structured data models for the Reqnroll BDD test automation framework for .NET. @@ -15,6 +15,6 @@ For more information about Reqnroll and its components, visit the [documentation ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Parser/Reqnroll.Parser.csproj b/Reqnroll.Parser/Reqnroll.Parser.csproj index 06cf0a038..a872454b5 100644 --- a/Reqnroll.Parser/Reqnroll.Parser.csproj +++ b/Reqnroll.Parser/Reqnroll.Parser.csproj @@ -18,7 +18,7 @@ - + diff --git a/Reqnroll.Tools.MsBuild.Generation/PackageReadme.md b/Reqnroll.Tools.MsBuild.Generation/README.md similarity index 85% rename from Reqnroll.Tools.MsBuild.Generation/PackageReadme.md rename to Reqnroll.Tools.MsBuild.Generation/README.md index 610d7808d..456557882 100644 --- a/Reqnroll.Tools.MsBuild.Generation/PackageReadme.md +++ b/Reqnroll.Tools.MsBuild.Generation/README.md @@ -1,4 +1,4 @@ -Reqnroll.Tools.MsBuild.Generation (pronounced as [reknroʊl]) enables code-behind file generation during build time for Reqnroll projects. +Reqnroll.Tools.MsBuild.Generation enables code-behind file generation during build time for Reqnroll projects. This package provides MSBuild tasks and targets that automatically generate test code from Gherkin feature files during the build process, eliminating the need for manual code generation. @@ -24,6 +24,6 @@ For more information about build configuration and code generation, see: ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec index 723ce6a81..efb60a56d 100644 --- a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec +++ b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.nuspec @@ -30,7 +30,7 @@ - + \ No newline at end of file diff --git a/Reqnroll.Utils/PackageReadme.md b/Reqnroll.Utils/README.md similarity index 80% rename from Reqnroll.Utils/PackageReadme.md rename to Reqnroll.Utils/README.md index 54fc60781..c517cd90a 100644 --- a/Reqnroll.Utils/PackageReadme.md +++ b/Reqnroll.Utils/README.md @@ -1,4 +1,4 @@ -Reqnroll.Utils (pronounced as [reknroʊl]) provides utility classes and helper functions for the Reqnroll framework. +Reqnroll.Utils provides utility classes and helper functions for the Reqnroll framework. This package contains common utilities and helper classes used by various components of the Reqnroll BDD test automation framework for .NET. @@ -15,6 +15,6 @@ For more information about Reqnroll and its components, visit the [documentation ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Utils/Reqnroll.Utils.csproj b/Reqnroll.Utils/Reqnroll.Utils.csproj index 6ad578ddd..9025803bd 100644 --- a/Reqnroll.Utils/Reqnroll.Utils.csproj +++ b/Reqnroll.Utils/Reqnroll.Utils.csproj @@ -13,6 +13,6 @@ - + diff --git a/Reqnroll/PackageReadme.md b/Reqnroll/README.md similarity index 100% rename from Reqnroll/PackageReadme.md rename to Reqnroll/README.md diff --git a/Reqnroll/Reqnroll.nuspec b/Reqnroll/Reqnroll.nuspec index 739b64284..1fac840d5 100644 --- a/Reqnroll/Reqnroll.nuspec +++ b/Reqnroll/Reqnroll.nuspec @@ -43,7 +43,7 @@ - + diff --git a/Templates/Reqnroll.Templates.DotNet/PackageReadme.md b/Templates/Reqnroll.Templates.DotNet/README.md similarity index 82% rename from Templates/Reqnroll.Templates.DotNet/PackageReadme.md rename to Templates/Reqnroll.Templates.DotNet/README.md index 1a915640c..3d953a0f4 100644 --- a/Templates/Reqnroll.Templates.DotNet/PackageReadme.md +++ b/Templates/Reqnroll.Templates.DotNet/README.md @@ -1,4 +1,4 @@ -Reqnroll.Templates.DotNet (pronounced as [reknroʊl]) provides dotnet new templates for creating Reqnroll projects and files. +Reqnroll.Templates.DotNet provides dotnet new templates for creating Reqnroll projects and files. This package contains project templates and item templates that can be used with the `dotnet new` command to quickly scaffold Reqnroll projects and add common files to existing projects. @@ -14,7 +14,7 @@ This package contains project templates and item templates that can be used with Install the templates globally to use with dotnet new: -```bash +```powershell dotnet new install Reqnroll.Templates.DotNet ``` @@ -22,7 +22,7 @@ dotnet new install Reqnroll.Templates.DotNet After installation, you can create new projects and files: -```bash +```powershell # Create a new Reqnroll project dotnet new reqnroll-project @@ -35,10 +35,10 @@ dotnet new reqnroll-feature ## Documentation -For more information about Reqnroll templates and getting started, visit the [documentation](https://docs.reqnroll.net/). +For more information about Reqnroll templates and getting started, visit the [Reqnroll documentation](https://docs.reqnroll.net/). ## Support -- [Documentation](https://docs.reqnroll.net/) +- [Reqnroll Documentation](https://docs.reqnroll.net/) - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj index 9dfd62f17..a20ae065a 100644 --- a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj +++ b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj @@ -25,7 +25,7 @@ - +