wwt / SwiftCurrent

A library for managing complex workflows in Swift

https://wwt.github.io/SwiftCurrent/

Apache License 2.0

308 stars 19 forks source link

Adds preference for attributes on the same line as what they attribute to the StyleGuide #63

Closed wiemerm closed 3 years ago

wiemerm commented 3 years ago

Linked Issue: #42

Checklist:

[ ] Is the linter reporting 0 errors?
[ ] Did you comply with our styleguide?
[ ] Is there adequate test coverage for your new code?
[ ] Does the CI pipeline pass?
[ ] Did you update the documentation?
[ ] Did you update the sample app?
[ ] Do we need to increment the minor/major version?
[ ] Did you change the public API?
[ ] Have you done everything you can to make sure that errors that can occur are compile-time errors, and if they have to be runtime do you have adequate tests and documentation around those runtime errors? For more details.

If Applicable:

[ ] Did you test when the first item is skipped?
[ ] Did you test when the last item is skipped?
[ ] Did you test when middle items are skipped?
[ ] Did you test when incorrect data is passed forward?
[ ] Did you test proceeding backwards?

If Public API Has Changed:

[ ] Did you deprecate (rather than remove) any old methods/variables/etc? Our philosophy for deprecation.
[ ] Have you done the best that you can to make sure that the compiler guides people to changing to the new API? (Example: the renamed attribute)
[ ] If necessary, have you tested the upgrade path for at least N-1 versions? For example, if data persists between v1 and v2 then that upgrade should be tested and as easy as we can make it.

Tyler-Keith-Thompson commented 3 years ago

Should we call out the @available attribute?

codecov-commenter commented 3 years ago

Codecov Report

Merging #63 (2ef71b1) into main (2baa360) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #63   +/-   ##
=======================================
  Coverage   97.25%   97.25%           
=======================================
  Files          35       35           
  Lines         985      985           
=======================================
  Hits          958      958           
  Misses         27       27

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 260c93f...2ef71b1. Read the comment docs.

wiemerm commented 3 years ago

EOD: Decided to make 2 rules, one for inlining attributes for properties, functions, and closures and another for a separate line for classes, structs, and actors. Currently working through expanding content order to be clearer that attributes are included.