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.

Sign up for GitHub

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

🔧🚗 Migrate setting value of codeFormatting.whitespaceAroundPipe (if present) to new setting codeFormatting.addWhitespaceAroundPipe automatically. #2689

Merged
merged 5 commits into from
May 12, 2020
Merged

🔧🚗 Migrate setting value of codeFormatting.whitespaceAroundPipe (if present) to new setting codeFormatting.addWhitespaceAroundPipe automatically. #2689

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e6e6b9
Migrate setting value of codeFormatting.whitespaceAroundPipe to new s…
May 10, 2020
09dd00c
fix code analysis warnings
May 10, 2020
0ab07f9
add comment to getConfigurationTarget and rename it to getEffectiveCo…
May 10, 2020
c69d197
try use quotes around undefined to see if it fixes codacy warning
May 10, 2020
10185d2
Update src/session.ts
bergmeister May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update src/session.ts
  • Loading branch information
@bergmeister
bergmeister authored May 12, 2020
commit 10185d2ad803f9ed34ddd809c3726d5fdd72c571
2 changes: 1 addition & 1 deletion src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ export class SessionManager implements Middleware {
}

// During preview, populate a new setting value but not remove the old value.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we may want to do this for the next stable release as well since a lot of customers only use stable.

After the next stable version, we can remove the old setting.

Copy link
Contributor Author

@bergmeister bergmeister May 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's exactly what I try to say: add new setting during preview but leave old setting still there (people who switch between preview/stable or use settings synchronization). Just before the next stable or in the last preview, I'd modify to to additionally remove the old setting. Is that clearer? But it sounds like we are both on the same page.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I think so. Can you capture this in an issue so we don't forget?

I'd even suggest adding a TODO with the issue number... That way if we all disappear, someone could pickup where we left off

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened issue #2693 and will add a comment

// When the PowerShell extension releases the RTM version, then the old value can be safely removed.
// TODO: When the next stable extension releases, then the old value can be safely removed. Tracked in this issue: https://github.com/PowerShell/vscode-powershell/issues/2693
private async migrateWhitespaceAroundPipeSetting() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you wanna make this more of a utility function that takes in the old an new setting?

That'll be handy in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather defer it to when it is needed as it might be a YAGNI.
Or maybe I should create an NPM package for it so that I can break the Internet later one 😂
https://www.zdnet.com/article/another-one-line-npm-package-breaks-the-javascript-ecosystem/

const configuration = vscode.workspace.getConfiguration(utils.PowerShellLanguageId);
const deprecatedSetting = 'codeFormatting.whitespaceAroundPipe'
Expand Down