-
Notifications
You must be signed in to change notification settings - Fork 50
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
[SM-1096] Unify State Variable Naming #895
Conversation
No New Or Fixed Issues Found |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #895 +/- ##
=======================================
Coverage 58.07% 58.08%
=======================================
Files 194 194
Lines 13194 13193 -1
=======================================
Hits 7663 7663
+ Misses 5531 5530 -1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, do we need to update the changelog as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found a typo in Go language wrapper README.md.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/SM-1096
📔 Objective
The naming around state files and paths is inconsistent. This PR aims to make the usage consistent.
Every mention of state for access token auth should follow this naming logic:
state_dir
<- This refers to the state directory, where state files are stored. The sdk is currently only aware of state files, directory handling is still being done in bws.state_file
<- This refers to a specific state file.In our code we don't append naming to variables to indicate the type (Hungarian Notation), so I thought it pertinent to truncate
_path
from these, preferring more descriptivestate_dir
andstate_file
for the names.Thanks @dani-garcia for pointing this out here.
state_file_dir
key in thebws
config file tostate_dir
. There will be more changes to this functionality with SM-1174, so I will wait to update the changelog for the next bws version until all this is completed.⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:
) or similar for great changes:memo:
) or ℹ️ (:information_source:
) for notes or general info:question:
) for questions:thinking:
) or 💭 (:thought_balloon:
) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:
) for suggestions / improvements:x:
) or:warning:
) for more significant problems or concerns needing attention:seedling:
) or ♻️ (:recycle:
) for future improvements or indications of technical debt:pick:
) for minor or nitpick changes