: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]
----
$ pipenv run rspec-tools --help
----


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

.Install dev dependencies

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

.Run tests
[source,sh]
----
$ pipenv run 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 rule.adoc
----
