-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
Issue #93589: Rename 'renameShorthandProperties' setting to 'useAliasesForRenames' #94480
Conversation
…'useAliasesForRenames'
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.
Thanks for taking a look! The name looks good but we also need to make sure migration to the new property is handled
@@ -186,7 +186,7 @@ export default class FileConfigurationManager extends Disposable { | |||
importModuleSpecifierPreference: getImportModuleSpecifierPreference(config), | |||
importModuleSpecifierEnding: getImportModuleSpecifierEndingPreference(config), | |||
allowTextChangesInNewFiles: document.uri.scheme === fileSchemes.file, | |||
providePrefixAndSuffixTextForRename: config.get<boolean>('renameShorthandProperties', true), | |||
providePrefixAndSuffixTextForRename: config.get<boolean>('useAliasesForRenames', true), |
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.
This should read both the old and new setting value for migration
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.
Thanks you guidance! This was an attempt at my first PR. I'll update this soon and keep this in mind with my future contributions.
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.
Until we remove the deprecated setting, we should make sure we respect previous setting value. Something like:
config.get<boolean>('renameShorthandProperties', true) === false ? false : config.get<boolean>('useAliasesForRenames', true)
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.
I apologize. Not sure how I missed this in the previous attempt at fixing my first commit.
"type": "boolean", | ||
"default": true, | ||
"description": "%typescript.preferences.renameShorthandProperties%", | ||
"description": "%typescript.preferences.useAliasesForRenames%", |
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.
Instead of renaming this property, create a copy of it and than mark renameShorthandProperties
with a deprecated message that points to the new property
@@ -186,7 +186,7 @@ export default class FileConfigurationManager extends Disposable { | |||
importModuleSpecifierPreference: getImportModuleSpecifierPreference(config), | |||
importModuleSpecifierEnding: getImportModuleSpecifierEndingPreference(config), | |||
allowTextChangesInNewFiles: document.uri.scheme === fileSchemes.file, | |||
providePrefixAndSuffixTextForRename: config.get<boolean>('renameShorthandProperties', true), | |||
providePrefixAndSuffixTextForRename: config.get<boolean>('useAliasesForRenames', true), |
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.
Until we remove the deprecated setting, we should make sure we respect previous setting value. Something like:
config.get<boolean>('renameShorthandProperties', true) === false ? false : config.get<boolean>('useAliasesForRenames', true)
Thanks! Will be the next VS Code insiders build and is scheduled to go out with VS code 1.45 |
This PR fixes #93589
The original setting name 'renameShorthandProperties' represents what the setting will do when disabled—not what it will do when it's enabled (the default). Changing the setting name to 'useAliasesForRenames' is better suited.