Metadata-Version: 2.1
Name: custom-otello-linter
Version: 1.0.5
Summary: flake8 based linter for frontend tests
Home-page: https://github.com/iri6e4k0/custom-otello-linter
Author: Irina
Author-email: iri6e4ko@gmail.com
License: Apache-2.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flake8<7.0,>=6.0
Requires-Dist: flake8-plugin-utils<2.0,>=1.3.2

# custom-otello-linter
Flake8 based linter for frontend tests

## Installation

```bash
pip install custom-otello-linter
```

## Configuration
Custom-otello-linter is flake8 plugin, so the configuration is the same as [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html).

You can ignore rules via
- file `setup.cfg`: parameter `ignore`
```editorconfig
[flake8]
ignore = OCS101
```
- comment in code `#noqa: OCS101`

```

## Rules

### Scenario Rules
1. [OCS101. Decorator @vedro.params should not be presented](./custom_otello_linter/rules/OCS101.md)
2. [OCS102. Missing "SCREENSHOTS" allure label when using "make_screenshot_for_comparison"](./custom_otello_linter/rules/OCS102.md)

###  Scenario Steps Rules
1. [OCS300. Function make_screenshot used once](./custom_otello_linter/rules/OCS300.md)
2. [OCS301. Missing "make_screenshot_for_comparison" call when using "SCREENSHOTS" label](./custom_otello_linter/rules/OCS301.md)
3. [OCS302. Missing platform param in page opening contexts of tests parametrized with platforms](./custom_otello_linter/rules/OCS302.md)
