Fix how we reference Special folders (Desktop, Documents) #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danbelcher-MSFT
approved these changes
Nov 10, 2017
| $output = @() | ||
| $output += "The config file used to generate this submission did not have an AppId defined in it." | ||
| $output += "The AppId entry in the config helps ensure that payloads are not submitted to the wrong application." | ||
| $output += "Please update your app's StoreBroker config file by adding an ""appId"" property with" | ||
| $output += "your app's AppId to the ""appSubmission"" section. If you're unclear on what change" | ||
| $output += "needs to be done, you can re-generate your config file using" | ||
| $output += " ""New-StoreBrokerConfigFile -AppId $AppId"" -Path ""`$home\desktop\newconfig.json""" | ||
| $output += " ""New-StoreBrokerConfigFile -AppId $AppId -Path ""$configPath""" |
There was a problem hiding this comment.
nit: I prefer the back-tick + double quote syntax over 2x double quote because it takes away the need to mentally parse the string.
There was a problem hiding this comment.
Fair feedback. Will fix.
StoreBroker/Helpers.ps1
Outdated
| { | ||
| $global:SBLogPath = $(Join-Path $env:USERPROFILE "Documents\StoreBroker.log") | ||
| $global:SBLogPath = (Join-Path -Path $documentsFolder -ChildPath 'StoreBroker.log') |
There was a problem hiding this comment.
In this CR, when we're assigning the result of Join-Path to a variable, we're inconsistent about whether the expression is wrapped in parens or not.
There was a problem hiding this comment.
Ah, good catch. There's no need for that outer parenthesis...I'll remove it.
We previously referenced the Desktop and Documents folders like so: `$home\Documents` and `$home\desktop`, but those folders can be redirected to a different drive (and folder name) without changing the user�s profile directory (e.g. `$home`). Given this, we will use the special method [[System.Environment]::GetFolderPath()](https://msdn.microsoft.com/en-us/library/14tx8hby%28v=vs.110%29.aspx) which can give us the correct path to those ["special folders"](https://msdn.microsoft.com/en-us/library/system.environment.specialfolder(v=vs.110).aspx) (named `MyDocuments` and `Desktop`). This required minor changes to the code and the documentation.
HowardWolosky
force-pushed
the
documentsFix
branch
from
6669d32 to
0eef7be
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We previously referenced the Desktop and Documents folders like so:
$home\Documentsand$home\desktop, but those folders can beredirected to a different drive (and folder name) without changing
the user�'s profile directory (e.g.
$home).Given this, we will use the special method
[System.Environment]::GetFolderPath()
which can give us the correct path to those "special folders"
(named
MyDocumentsandDesktop).This required minor changes to the code and the documentation.