rspec/rspec-tools
Marco Borgeaud 00eee176da Improve probing frequency to reduce time spent on CI
Checks links every two to three days instead of every 24h to 25h40.
This improve the distribution of checks on CI runs.
2024-08-22 09:59:26 +02:00
..
2021-01-29 16:05:22 +01:00
2023-10-30 10:33:56 +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]
----
$ 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 -e rule.adoc
----