Skip to content

Commit cc9e57d

Browse files
authored
refactor: Make bom-encoding-in-file rule optional (#1626)
BOM encoding is now supported by the Robot Framework. The rule can stay as optional rule.
1 parent 41f4ff0 commit cc9e57d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/robocop/linter/rules/comments.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,11 @@ class BomEncodingRule(Rule):
225225
"""
226226
BOM (Byte Order Mark) found in the file.
227227
228-
Some code editors can save Robot file using BOM encoding. It is not supported by the Robot Framework.
229-
Ensure that file is saved in UTF-8 encoding.
228+
Some code editors can save Robot file using BOM encoding.
229+
It is not supported by older versions of the Robot Framework.
230+
Ensure that the file is saved in UTF-8 encoding.
231+
232+
Changes in 8.0.0: Rule is now optional since Robot Framework now supports BOM encoding.
230233
231234
"""
232235

@@ -236,6 +239,7 @@ class BomEncodingRule(Rule):
236239
file_wide_rule = True
237240
severity = RuleSeverity.WARNING
238241
added_in_version = "1.7.0"
242+
enabled = False
239243
sonar_qube_attrs = sonar_qube.SonarQubeAttributes(
240244
clean_code=sonar_qube.CleanCodeAttribute.CLEAR,
241245
issue_type=sonar_qube.SonarQubeIssueType.CODE_SMELL,
@@ -269,24 +273,20 @@ class CommentedOutCodeRule(Rule):
269273
This rule is disabled by default. Enable it to detect forgotten or accidentally
270274
commented-out code.
271275
272-
Example of violations::
276+
Example of violations:
273277
274278
Keyword
275279
# ${result}= Get Value
276280
# [Tags] smoke
277281
# IF ${condition}
278282
Other Keyword
279283
280-
Example of valid comments::
284+
Example of valid comments:
281285
282286
# This is a normal comment
283287
# TODO: implement this feature
284288
# If you need help, ask
285289
286-
Configuration example::
287-
288-
robocop check --configure commented-out-code.markers=todo,fixme,note
289-
290290
"""
291291

292292
name = "commented-out-code"

0 commit comments

Comments
 (0)