diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md new file mode 100644 index 000000000..0e6969616 --- /dev/null +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md @@ -0,0 +1,28 @@ +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. + +## 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 + +## Installation + +Install this package to add Autofac dependency injection support to your Reqnroll project: + +```powershell +dotnet add package Reqnroll.Autofac +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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..6bc386add 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/README.md b/Plugins/Reqnroll.CustomPlugin/README.md new file mode 100644 index 000000000..8e1fd86e1 --- /dev/null +++ b/Plugins/Reqnroll.CustomPlugin/README.md @@ -0,0 +1,29 @@ +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. + +## 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: + +```powershell +dotnet add package Reqnroll.CustomPlugin +``` + +## Documentation + +For more information about creating custom Reqnroll plugins, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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..1b254d7a0 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/README.md b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md new file mode 100644 index 000000000..fba420949 --- /dev/null +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md @@ -0,0 +1,29 @@ +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. + +## 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: + +```powershell +dotnet add package Reqnroll.ExternalData +``` + +## Documentation + +For more information about using external data with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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 fcc75666f..7d3404874 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.MSTest.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..461f2e275 --- /dev/null +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,34 @@ +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. + +## 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: + +```powershell +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 [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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..5c003af17 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.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md new file mode 100644 index 000000000..da541847d --- /dev/null +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md @@ -0,0 +1,29 @@ +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. + +## 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: + +```powershell +dotnet add package Reqnroll.Microsoft.Extensions.DependencyInjection +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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 b46da98c4..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 @@ -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.NUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..54e1c40e2 --- /dev/null +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,35 @@ +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. + +## 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: + +```powershell +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 [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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..f16e56408 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.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..b94f4ec84 --- /dev/null +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,29 @@ +Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow 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 + +- **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: + +```powershell +dotnet add package Reqnroll.SpecFlowCompatibility +``` + +## Documentation + +For more information about migrating from SpecFlow to Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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 584128313..b63d5b7de 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.TUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..6a5daf3b5 --- /dev/null +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,35 @@ +Reqnroll.TUnit enables using Reqnroll with 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 + +- **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: + +```powershell +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 [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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 067f0f7f7..2bf9b1cd8 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec @@ -31,6 +31,7 @@ + diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md new file mode 100644 index 000000000..d8fcb83d0 --- /dev/null +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md @@ -0,0 +1,29 @@ +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. + +## 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: + +```powershell +dotnet add package Reqnroll.Verify +``` + +## Documentation + +For more information about using Verify with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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 6b5df1ee2..d5d268a65 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/README.md b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md new file mode 100644 index 000000000..1dc12d1bd --- /dev/null +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md @@ -0,0 +1,29 @@ +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. + +## 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: + +```powershell +dotnet add package Reqnroll.Windsor +``` + +## Documentation + +For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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..1f473a950 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/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..719261198 --- /dev/null +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,35 @@ +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. + +## 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: + +```powershell +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 [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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.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 bfd71e482..aea959ac6 100644 --- a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec @@ -6,8 +6,8 @@ Reqnroll.xUnit $author$ $owner$ + README.md Package to use Reqnroll with xUnit 2.x. Use Reqnroll.xunit.v3 for xUnit 3.x. $summary$ - Package to use Reqnroll with xUnit 2.x. Use Reqnroll.xunit.v3 for xUnit 3.x. $summary$ en-US https://www.reqnroll.net @@ -41,6 +41,7 @@ + diff --git a/Reqnroll.Generator/README.md b/Reqnroll.Generator/README.md new file mode 100644 index 000000000..d6159514f --- /dev/null +++ b/Reqnroll.Generator/README.md @@ -0,0 +1,20 @@ +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. For generator configuration options, see the [Generator Configuration Documentation](https://docs.reqnroll.net/latest/installation/configuration.html#generator). + +## 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 + +- [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 0575c31e0..780d0d16a 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/README.md b/Reqnroll.Parser/README.md new file mode 100644 index 000000000..3bb2ea219 --- /dev/null +++ b/Reqnroll.Parser/README.md @@ -0,0 +1,20 @@ +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. + +## 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 + +- [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 15e39f98f..3c9d65f38 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/README.md b/Reqnroll.Tools.MsBuild.Generation/README.md new file mode 100644 index 000000000..456557882 --- /dev/null +++ b/Reqnroll.Tools.MsBuild.Generation/README.md @@ -0,0 +1,29 @@ +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. + +## 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 + +- [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.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..efb60a56d 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/README.md b/Reqnroll.Utils/README.md new file mode 100644 index 000000000..c517cd90a --- /dev/null +++ b/Reqnroll.Utils/README.md @@ -0,0 +1,20 @@ +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. + +## 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 + +- [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 06c36a843..9025803bd 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 + + + + 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 b278fdf7c..97b865e24 100644 --- a/Reqnroll/Reqnroll.nuspec +++ b/Reqnroll/Reqnroll.nuspec @@ -43,7 +43,7 @@ - + diff --git a/Templates/Reqnroll.Templates.DotNet/README.md b/Templates/Reqnroll.Templates.DotNet/README.md new file mode 100644 index 000000000..3d953a0f4 --- /dev/null +++ b/Templates/Reqnroll.Templates.DotNet/README.md @@ -0,0 +1,44 @@ +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. + +## 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: + +```powershell +dotnet new install Reqnroll.Templates.DotNet +``` + +## Usage + +After installation, you can create new projects and files: + +```powershell +# 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 [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [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 2fad44e9e..a20ae065a 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 @@ +