Fix naming for Characteristic.ProgramMode #1010
Conversation
removes extra '_' on end of value PROGRAM_SCHEDULED_MANUAL_MODE_
Pull Request Test Coverage Report for Build 5433048924
💛 - Coveralls |
|
I'm not sure if this change is worth deliberately breaking plugins. I would either just leave it as is, or introduce the corrected |
|
@Supereg fair call.. I think we should have it fixed from a naming consistency view.. I’ll update the commit with the old and new and mark the old as deprecated |
There was a problem hiding this comment.
This file is currently getting auto generated. Is there a way of editing the generator file so this doesn’t get overwritten on next generation?
There was a problem hiding this comment.
Well... I guess have to work out how they are auto generated.. It can take another year
There was a problem hiding this comment.
Ok. So in the HAP FramWork plist, this is defined as "Program scheduled (Manual Mode)". So the really comes done to how we handle namings when enclosed in brackets/braces etc. We can correct the auto generation code to account for this?
There was a problem hiding this comment.
This file is generated in generate-definitions.ts and there are some possibilities for overriding how definitions are handled in generator-configuration.ts.
Correcting the generation code sounds great. However, we probably want to manually patch the old value as a deprecated constant, such that we do not break backwards compatibility.
There was a problem hiding this comment.
Thanks @Supereg I'll have a look over and see what we can do for a PR. Seems might take some more work due to structure and filechanges since those were written
There was a problem hiding this comment.
@n0rt0nthec4t, we are close to release v1.0.0. Are you wanting this included?
There was a problem hiding this comment.
I wont get todo anything anytime soon. Perhaps we'll close this PR and I'll do a new on at some point to fix the issues from the root cause
There was a problem hiding this comment.
I am going to close the pr as we will resolve this in v1.0.0 and update auto generated docs soon.
|
Probably not in scope, but I noticed some warning is those example Accessories related to special chars in names. Probably related to recent PR in beta? |
yes but should be resolved. |
removes extra '' on end of value Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE
♻️ Current situation
Seems extra '_' on end of define was unintentional
💡 Proposed solution
Changes naming Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE_ to Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE
⚙️ Release Notes
This maybe a breaking change as removes define for "PROGRAM_SCHEDULED_MANUAL_MODE_". Developers will need to updated any used of Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE_ to Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE