rspec

History

Make sure that includes are always surrounded by empty lines (#2270 )

When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.

2023-06-22 10:38:01 +02:00

rspec_template

Add Benchmarks as a supported section on Resources (#1812 )

2023-04-27 10:07:31 +02:00

rspec_tools

Add check that each section is used only once

2023-06-13 18:03:28 +02:00

tests

Make sure that includes are always surrounded by empty lines (#2270 )

2023-06-22 10:38:01 +02:00

.gitignore

bootstrap rspec-tools project

2021-01-29 16:05:22 +01:00

Pipfile

RULEAPI-573: Clean and test script generating for each rule the list of plugins covering it (#429 )

2021-10-01 14:52:12 +02:00

Pipfile.lock

[dependabot] Bump gitpython from 3.1.24 to 3.1.30 in /rspec-tools (#1517 )

2023-02-01 09:13:56 +01:00

README.adoc

Add checks for education format (#1607 )

2023-03-07 17:16:47 +01:00

setup.py

bootstrap rspec-tools project

2021-01-29 16:05:22 +01:00

sonar-project.properties

RULEAPI-579: Enable project analysis in SonarQube Next (#693 )

2022-01-12 14:45:44 +00:00

README.adoc

: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
----