rspec/rspec-tools
Johann Beleites e2c4c4b8fe
RULEAPI-770 Fix bug due to multiple sonarpedia.json files (#3983)
When there are multiple sonarpedia.json files for the same language, the rules
picked up for the next sonarpedia.json file will override the ones picked up
previously. With this fix, the rules are not overwritten but all are collected,
so one repository can have multiple sonarpedia.json files for the same language.
2024-06-11 12:15:51 +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
----