Skip to content

Commit a4940bd

Browse files
authored
Deprecate Robotidy for Robocop 6.0+ (#743)
* Deprecate Robotidy * Deprecate Robotidy for Robocop 6.0+ * Remove dependabot
1 parent b253b06 commit a4940bd

File tree

17 files changed

+63
-54
lines changed

17 files changed

+63
-54
lines changed

.github/dependabot.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Robotidy
1616
- [Usage](#usage)
1717
- [Example](#example)
1818

19+
DEPRECATION NOTICE
20+
------------
21+
Starting from Robocop 6.0, Robotidy is part of Robocop as formatter.
22+
23+
If you are new users, please use https://github.com/MarketSquare/robotframework-robocop instead.
24+
1925
Introduction <a name="introduction"></a>
2026
------------
2127
Robotidy is a tool for autoformatting Robot Framework code.

docs/source/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
Deprecation notice
2+
-------------------
3+
4+
Starting with Robocop 6.0, Robotidy is now integrated into Robocop.
5+
The standalone version of Robotidy is deprecated and may not support the latest Robot Framework versions.
6+
7+
Please see https://robocop.readthedocs.io/en/stable/ for Robocop documentation.
8+
19
Introduction
210
------------
311
Robotidy is a tool for autoformatting Robot Framework code.

robotidy/cli.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ def cli(ctx: click.Context, **kwargs):
492492
Robotidy is a tool for formatting Robot Framework source code.
493493
Full documentation available at <https://robotidy.readthedocs.io> .
494494
"""
495+
print_deprecation_warning()
495496
cli_config = RawConfig.from_cli(ctx=ctx, **kwargs)
496497
global_config = config_module.MainConfig(cli_config)
497498
global_config.validate_src_is_required()
@@ -507,3 +508,10 @@ def cli(ctx: click.Context, **kwargs):
507508
tidy = app.Robotidy(global_config)
508509
status = tidy.transform_files()
509510
sys.exit(status)
511+
512+
513+
def print_deprecation_warning() -> None:
514+
print(
515+
"DeprecationWarning: Starting with Robocop 6.0, Robotidy is now integrated into Robocop. "
516+
"The standalone version of Robotidy is deprecated and may not support the latest Robot Framework versions.\n"
517+
)

robotidy/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "4.16.0"
1+
__version__ = "4.17.0"

setup.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@
4141
include_package_data=True,
4242
python_requires=">=3.8",
4343
install_requires=[
44-
"robotframework>=4.0,<7.3",
44+
"robotframework>=4.0",
4545
"click==8.1.*",
46-
"colorama>=0.4.3,<0.4.7",
47-
"pathspec>=0.9.0,<0.12.2",
48-
"tomli>=2.0,<2.3",
49-
"rich_click>=1.4,<1.8.6",
50-
"jinja2>=3.1.3,<4.0",
46+
"colorama>=0.4.3",
47+
"pathspec>=0.9.0",
48+
"tomli>=2.0",
49+
"rich_click>=1.4",
50+
"jinja2>=3.1.3",
5151
],
5252
extras_require={
5353
"dev": [

tests/atest/transformers/GenerateDocumentation/test_transformer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def test_invalid_template_path(self):
5252
f"Error: {self.TRANSFORMER_NAME}: Invalid 'doc_template' parameter value: '{template_path}'. "
5353
f"The template path does not exist or cannot be found.\n"
5454
)
55-
assert expected_output == result.output
55+
assert expected_output in result.output
5656

5757
def test_invalid_template(self):
5858
template_path = Path(__file__).parent / "source" / "invalid_template.jinja"
@@ -65,4 +65,4 @@ def test_invalid_template(self):
6565
f"Failed to load the template: Unexpected end of template. Jinja was looking for the "
6666
f"following tags: 'endfor' or 'else'. The innermost block that needs to be closed is 'for'.\n"
6767
)
68-
assert expected_output == result.output
68+
assert expected_output in result.output

tests/atest/transformers/MergeAndOrderSections/test_merge_and_order_sections.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def test_invalid_order_parameter(self, parameter):
6969
"Custom order should be provided in comma separated list with all section names:\n"
7070
"order=comments,settings,variables,testcases,tasks,variables\n"
7171
)
72-
assert expected_output == result.output
72+
assert expected_output in result.output
7373

7474
def test_inline_if(self):
7575
self.compare(source="inline_if.robot", not_modified=True)

tests/atest/transformers/NormalizeAssignments/test_transformer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def test_invalid_equal_sign_type(self, param_name):
4848
f"Error: {self.TRANSFORMER_NAME}: Invalid '=' parameter value: '{param_name}'. "
4949
"Possible values:\n remove\n equal_sign\n space_and_equal_sign\n"
5050
)
51-
assert expected_output == result.output
51+
assert expected_output in result.output
5252

5353
def test_disablers(self):
5454
self.compare(source="disablers.robot", not_modified=True)

tests/atest/transformers/NormalizeTags/test_transformer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def test_wrong_case(self):
3232
f"Error: {self.TRANSFORMER_NAME}: Invalid 'case' parameter value: 'invalid'. "
3333
f"Supported cases: lowercase, uppercase, titlecase.\n"
3434
)
35-
assert expected_output == result.output
35+
assert expected_output in result.output
3636

3737
def test_only_remove_duplicates(self):
3838
self.compare(source="duplicates.robot", config=f":normalize_case=False")

0 commit comments

Comments
 (0)