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

Change default of EnforcedStyle to slashes for Rails/FilePath #141

Merged
merged 1 commit into from
Nov 21, 2019

Conversation

koic
Copy link
Member

@koic koic commented Oct 13, 2019

This PR changes default of EnforcedStyle from arguments to slashes for Rails/FilePath.

The following is why slashes by default.

  • Rails.root is an instance of Pathname, so the separator (/) works for example on the Windows platform.
  • Since it can be expressed by a single string, the number of string instances can be reduced.
  • Clarified because the argument is fixed to one.

EnforcedStyle's default was arguments because it was mainly due to Windows platform considerations, but it seems to have been a mistake.

#128 (comment)


Before submitting the PR make sure the following are checked:

  • 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.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

This PR changes default of `EnforcedStyle` from `arguments` to `slashes`
for `Rails/FilePath`.

The following is why `slashes` by default.

- `Rails.root` is an instance of `Pathname`, so the separator (`/`) works
 for example on the Windows platform.
- Since it can be expressed by a single string, the number of string
 instances can be reduced.
- Clarified because the argument is fixed to one.

`EnforcedStyle`'s default was `arguments` because it was mainly due to
Windows platform considerations, but it seems to have been a mistake.

rubocop#128 (comment)
@koic koic force-pushed the enforce_style_slashes_by_default branch from 5d08ea3 to dd92d31 Compare November 21, 2019 04:14
@koic koic merged commit 46d2c47 into rubocop:master Nov 21, 2019
@koic koic deleted the enforce_style_slashes_by_default branch November 21, 2019 04:26
no-reply pushed a commit to samvera/bixby that referenced this pull request Jun 10, 2020
don't try to make existing projects change this. they have already changed all
these to match the old enforced style, and the only reason for the change is to
"reduce the number of string instances".

rubocop/rubocop-rails#141
bess pushed a commit to samvera/bixby that referenced this pull request Jun 10, 2020
don't try to make existing projects change this. they have already changed all
these to match the old enforced style, and the only reason for the change is to
"reduce the number of string instances".

rubocop/rubocop-rails#141
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.

1 participant