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

Reformat and update to .editorconfig + Remove Name #32

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

SayuShira
Copy link

Started by removing the property Name from plugin.cs that is now read from the manifest. (Discord message about this and that it should get a PR.)

Addresses #25.

  • Updated the .editorconfig with changes from goatcorp/Dalamud
  • Further rearranged and grouped properties to find and understand the config more easily
  • Removed now unused naming_rules (dotnet_naming_style.on_upper_camel_case_style.xxx)
  • Removed properties that had no effect due to being already defined (e.g. indent_size = 4 is defined for all files and doesn't need to be defined again for .c, .cs, .json,..)
  • Reformatted applicable files using the updated .editorconfig
    • .cs, .json, .targets, .csproj
    • didn't for now for packages.lock.json as it rebuilds with indent_size = 2

As of 80f0dd426b0e56751c2858a52af9ce872b98bd8c shouldn't include any functional difference other than some resharper_xxx being commented out due to not finding them (see below).

Would need help or an opinion on:

  • Removing [RequiredVersion("1.0")] in Plugin.cs
    • I read it is not necessary anymore and not planned to be reused in the future (got API levels now)
  • private instance fields are PascalCase but should be camelCase going by .editorconfig
    • e.g. private Configuration Configuration; vs. private Configuration configuration
    • Options I see:
      • Reformat to follow .editorconfig
      • Change private instance fields to PascalCase
      • Remove the style rule from .editorconfig if it is a preference
      • Change the style rule from a warning to a suggestion (which doesn't actually show at least in Rider)
  • Commented out all properties of .editorconfig that I couldn't find any documentation of (only some resharper_xxx are affected)
    • Stupid question: Do they exist and do something?
    • Keep them to make sure? Remove them for good?

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