Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

L016: New option "ignore_comment_clause" to ignore column COMMENTs, etc. #2589

Conversation

barrywhart
Copy link
Member

@barrywhart barrywhart commented Feb 9, 2022

Brief summary of the change made

Fixes #2554

Are there any other side effects of this change that we should be aware of?

Pull Request checklist

  • Please confirm you have completed any of the necessary steps below.

  • Included test cases to demonstrate any code changes, which may be one or more of the following:

    • .yml rule test cases in test/fixtures/rules/std_rule_cases.
    • .sql/.yml parser test cases in test/fixtures/dialects (note YML files can be auto generated with tox -e generate-fixture-yml).
    • Full autofix test cases in test/fixtures/linter/autofix.
    • Other.
  • Added appropriate documentation for the change.

  • Created GitHub issues for any relevant followup/future enhancements if appropriate.

@barrywhart barrywhart marked this pull request as draft February 9, 2022 18:47
@codecov
Copy link

codecov bot commented Feb 9, 2022

Codecov Report

Merging #2589 (0712f2e) into main (c846a9e) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main     #2589   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          163       163           
  Lines        11876     11886   +10     
=========================================
+ Hits         11876     11886   +10     
Impacted Files Coverage Δ
src/sqlfluff/core/rules/config_info.py 100.00% <ø> (ø)
src/sqlfluff/rules/L016.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c846a9e...0712f2e. Read the comment docs.

@barrywhart barrywhart marked this pull request as ready for review February 9, 2022 19:36
Copy link
Member

@tunetheweb tunetheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pro github tip: to accept lots of changes (like I've suggested here) use the "files" tab and add all the suggestions to a batch and then commit that batch in one commit.

src/sqlfluff/core/default_config.cfg Outdated Show resolved Hide resolved
src/sqlfluff/core/rules/config_info.py Outdated Show resolved Hide resolved
src/sqlfluff/rules/L016.py Outdated Show resolved Hide resolved
src/sqlfluff/rules/L016.py Outdated Show resolved Hide resolved
src/sqlfluff/rules/L016.py Outdated Show resolved Hide resolved
src/sqlfluff/rules/L016.py Outdated Show resolved Hide resolved
Comment on lines 284 to 292
test_pass_ignore_comment_clause_snowflake:
pass_str: |
CREATE TABLE foo_table (bar INTEGER) COMMENT = 'very long comment line, exceeding max_line_lengthvery long comment line, exceeding max_line_length very long comment line, exceeding max_line_length very long comment line, exceeding max_line_length'
configs:
core:
dialect: snowflake
rules:
L016:
ignore_comment_clause: True
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a test case for when the line is very long - even when ignoring the comment clause? It should still fail.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@barrywhart
Copy link
Member Author

@tunetheweb: I added the test case you suggested. Ready for another review.

@tunetheweb
Copy link
Member

The tests were failing so was waiting for them to pass before approving.

@barrywhart
Copy link
Member Author

Hmm, maybe I broke something. Will look again in a bit.

@barrywhart
Copy link
Member Author

@tunetheweb: I think it'll work now. We just needed to apply the same config setting rename to the test case .yml file as the code itself.

@barrywhart barrywhart merged commit 88df89f into sqlfluff:main Feb 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update L016 to optionally ignore long COMMENT lines as well
2 participants