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

[Fix #13490] Add new Style/FileNull cop #13493

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

dvandersluis
Copy link
Member

@dvandersluis dvandersluis commented Nov 25, 2024

This cop checks for full strings matching a specific null device name (/dev/null, NUL, or NUL:) and replaces it with File::NULL, which is platform independent.

Some examples of code that could be corrected are here.

Fixes #13490.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

This cop checks for full strings matching a specific null device name (`/dev/null` or `NUL`) and replaces it with `File::NULL` which is platform independent.
@bbatsov bbatsov merged commit efc3fd8 into rubocop:master Nov 26, 2024
22 checks passed
@bbatsov
Copy link
Collaborator

bbatsov commented Nov 26, 2024

Nice addition. Probably we need something similar for File::SEPARATOR as well. Might be also good to mention those things in the style guide as well.

@dvandersluis
Copy link
Member Author

@bbatsov I opened a Style Guide PR: rubocop/ruby-style-guide#954

For File::SEPARATOR, what do you have in mind? I'm not sure how we'd safely detect "/" that should be replaced; there probably would be a ton of false positives around routers for instance.

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.

New Cop: Detect '/dev/null' and suggest File::NULL instead
2 participants