Robotframework-robocop

Small improvements to file configurations handling and other fixes. You can now also import external rules from Python packages/modules:

robocop --ext-rules pythonmodule


Features
---------
- External rules can be imported from external python packages. Read https://robocop.readthedocs.io/en/latest/external_rules.html for more details #404
- Comments are now supported in arguments files 406
- ``section-out-of-order`` rule can be now configured with custom order of sections 384

Fixes
-----
- Empty lines in argument files can be now used 405
- Fix issue with configuring severity of rule 402

Other
------
- ``toml`` module is now installed together with robocop for default support for ``pyproject.toml`` file

Acknowledgements
---------------------
Thanks for fdaguin and MoreFamed for reported issues and ideas

Release fixing issue with parsing configuration files.

Fixes
------
- Fix parsing option with values from config files 396

A lot of new rules and changes - with huge number of contributions from others! 🚀
Some of the rules change names - see next section for more details.

Rule names changes
------------------------
- Rename ``missing-doc-testcase`` to ``missing-doc-test-case``
- Rename ``not-capitalized-keyword-name`` to ``wrong-case-in-keyword-name``
- Rename ``setting-name-not-capitalized`` to ``setting-name-not-in-title-case``

Features
---------
- New rule for empty keyword or test case name (``E0312 keyword-name-is-empty`` and ``E0313 test-case-name-is-empty``) 337
- New rule ``W1012 consecutive-empty-lines`` checking for more than ``consecutive_empty_lines = 1`` empty lines 365
- New rule ``W1013 empty-lines-in-statement`` checking for empty lines inside multi line statement 371
- Tag rules now also parse tags defined in last line of documentation 194
- New rule ``E0403 missing-keyword-name`` for calling variables without keyword name 386
- New rule ``E1014 variable-should-left-aligned`` for ensuring that variables in variables section are left aligned 293

Fixes
-----
- Enforce utf-8 encoding when reading file for RawCheckers to fix problems with different encodings (such as inccorectly calculcated length of line) 356
- Fix invalid documentation regarding configuring format of the message 368
- ``W1004 empty-lines-between-test-cases`` should now ignore templated tests 367
- ``E0801 duplicated-test-case`` should now work correctly with normalized names 376
- Robocop will now not show ``W1003 empty-lines-between-sections`` after keyword section if the number of lines is correct 382
- ``format`` can be now used in ``.robocop`` configuraton file 387

Other
------
- When using invalid rule name Robocop will now throw exception listing close matches (if any) 358 361
- Allow to check only first word for capitalization in ``W0302`` (``wrong-case-in-keyword-name``) 359
- Documentation improvements 385

Acknowledgements
---------------------
Special thanks for:
- rauttiz for reporting issues with line length checker
- MoreFamed that provided enhancement idea for our error handling and idea for optional configuration for 0302 rule
- bollwyvl for including our license inside our package
- d-biehl that dicovered issues when parsing test cases and keywords without name and also reported & fixed 376
- rdagum that reported issue invalid documentation for rule name inside format option and suggested ignoring some of the issues when parsing code with templated tests
- kvo-harmoney for idea of rule checking for consecutive empty lines
- yo-ga for adding parsing tags from last line of documentation and implementing rule for checking if variables inside variables section are left aligned
- j3n5h for reporting & fixing issue with detecting number of empty lines after keyword section
- Calletje234 for reporting issue with configuring format of output message in config file

This is mostly a bugfix release with minor changes to configurables and a big refactor in documentation.

Fixes
-----
- Fixed typos and outdated parts in documentation, rephrased some parts 338
- Fixed typos in description of the rules 338
- Different line endings are now properly supported when using Robocop API 342
- Fixed issues with `line-too-long` (W0508) rule: 349
- Hidden characters do not count towards line length limit 345
- Tabulators are now properly counted 346
- Disablers in comment are excluded from line length limit 347

Other
-----
- Better and more concise display of configurable parameters (now they also have some description and show the default value) 338 350
- Removed 'checkers' section in documentation and moved some parts under 'rules' section 338

Acknowledgements
---------------------
Thanks d-biehl for resolving issue with line endings!

This release is mostly a big refactoring with parts of the code not touched since the very first commits. Some defaults has changed, some documentation has been updated. We made couple of fixes also and deprecated rule W0906 that is now exchanged with two new ones: W0909 and W0910. README is now written in markdown and it has a new expandable FAQ section at the bottom. There is also a new verbose mode and `pyproject.toml` is now supported for tool configuration. These and many more are described in detail below. Enjoy! 👮🏻‍♂️

New rules
-----------
- W0909 (inconsistent-assignment) checks if all assignments in ``*** Test Cases ***`` and ``*** Keywords ***`` sections are the same type 295
- W0910 (inconsistent-assignment-in-variables) checks if all assignments in ``*** Variables ***`` section are the same type 295

**Note**: Possible values for W0909 and W0910 `assignment_sign_type` parameter are: `none` (without equal sign), `equal_sign` ('='), `space_and_equal_sign` (' ='), `autodetect` (detects the most common option and looks for inconsistencies in the code).

- W0705 (bom-encoding-in-file) checks if robot file uses not supported [BOM](https://en.wikipedia.org/wiki/Byte_order_mark) (Byte Order Mark) encoding #327
- W0911 (wrong-import-order) checks if builtin libraries are imported before any other library 313


Deprecated rules
-----------------
- W0906 (redundant-equal-sign) - with the addition of W0909 and W0910 the W0906 is being deprecated. You can get the old W0906 behavior with W0909 and W0910 if you configure their parameter `assignment_sign_type` with one of: ``equal_sign`` ('='), ``none`` (''), ``space_and_equal_sign`` (' ='). W0906 will be deleted in next bigger release (1.8.0) or in the following (1.9.0) if it will be too early. 321

Fixes
-----
- W1002 (missing-trailing-blank-line) will not report each time when used with LSP 307
- Misaligned variables in `*** Variables ***` section should not cause fatal exception now 292
- Empty keyword names causing TypeError exception 318
- W0302 (not-capitalized-keyword-name) should have better support for local characters 314
- W0704 (ignored-data) now works with BOM encoded files 326
- Changed outdated data in documentation 335
- For loops and IFs inside test cases should be parsed by indent rules 331
- W1007 (uneven-indent) will now ignore comments between test cases and keywords 332
- Empty test case name will not throw IndexError from now 333

Other
------
- README has been rewritten to markdown and now includes nice FAQ section 335
- Video of our talk from RoboCon2021 is now included at the top of README file! 335
- ``pyproject.toml`` is now supported 301 See documentation for more info [docs](https://robocop.readthedocs.io/en/latest/user_guide.html#loading-configuration-from-file)
- Severity is not listed in every rule when using `--list-configurables`, instead it's listed only once 304
- `--list-configurables` now displays only rules that have configurable parameter 335
- Prettified `--list-reports` output 335
- `severity` parameter in other CLI options is now case-insensitive (both e/w/i and E/W/I are accepted) 335
- Rule name is now included in default issue output 310
- Added ``-vv / --verbose`` flag for more detailed output 72 335
- Return status is now calculated on number of found issues that exceed quality gates limits 335
- Quality gates default values are now `{'E': 0, 'W': 0, 'I': -1}` which means that any error or warning will make Robocop return non-zero status. -1 value means that issues with INFO severity will not affect return code. This can be configured by `--configure return_status:quality_gate:E=<value>:W=<value>:I=<value` 335
- Changed defaults for some lengths checkers: 335
- `testcase_max_calls`: 8 → 10 (maximum amount of keyword calls inside test case)
- `keyword_max_calls`: 8 → 10 (maximum amount of keyword calls inside keyword)
- `keyword_min_calls`: 2 → 1 (minimum amount of keyword calls inside keyword)
- `--ext_rules` option is now `--ext-rules` option (changed underscore `_` to hyphen `-`) 335
- Some command line options received short flag argument: 335
- `-nr` for `--no-recursive`
- `-lc` for `--list-configurables`
- `-lr` for `--list-reports`
- `-ft` for `--filetypes`
- `-g` for `--ignore`

Acknowledgements
----------------------
- Thanks d-biehl for fixing 333 and 318 - you're true hero!🦸‍♂️

Pack of fixes.

Fixes
------------
- file_stats will acknowledge issues excluded by configuration 299
- W1007 (uneven-indent) should not report comments as rule volations 296
- W1007 (uneven-indent) should parse IFs 297
- Robocop API should load configuration file 302
- If there is invalid configuration while using Robocop API, it will throw InvalidArgumentError instead of SystemExit 303