rspec/rspec-tools
hendrik-buchwald-sonarsource a315e5de4c
Add review checklist
This PR adds a small checklist for new PRs that will make it more
visible what parts of the RSPEC were reviewed.
2023-06-06 17:04:39 +02:00
..
2023-06-06 17:04:39 +02:00
2021-01-29 16:05:22 +01:00
2021-01-29 16:05:22 +01:00

:source-highlighter: highlightjs

rspec-tools: Tools automating RSPEC workflows
=============================================

Install
-------

.Install Pipenv
[source,shell]
----
# macos
$ brew install pipenv
----

.Install rspec-tools
[source,shell]
----
$ cd rspec-tools
$ pipenv install -e .
----


Usage
-----

.See all commands
[source,sh]
----
$ rspec-tools --help
----


Development
-----------

.Install dev dependencies

[source,sh]
----
$ pipenv install --dev -e .
----

.Run tests
[source,sh]
----
$ pytest
----

.Fixtures

When writing a new test, create a fixture rule in `tests/resources/{invalid_rules, rules}`.

In order to generate an HTML file from the ASCIIdoc, you can use [asciidoctor](https://docs.asciidoctor.org/) as follows:

[source,sh]
----
$ asciidoctor -e rule.adoc
----