docs: prefer clean reinstall guidance for install command collisions#149
Merged
docs: prefer clean reinstall guidance for install command collisions#149
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates IdLE’s installation documentation to steer users away from Install-Module -AllowClobber when PowerShellGet reports command-name collisions, and instead recommend a clean reinstall flow.
Changes:
- Replaces the prior
-AllowClobberguidance with a Docusaurus:::infocallout for command-collision remediation. - Adds uninstall/reinstall commands intended to resolve collision scenarios by removing existing IdLE installs before reinstalling.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
Motivation
-AllowClobberfor Install-Module because it can cause unexpected behavior; prefer guiding users to perform a clean reinstall when command name collisions occur.Description
-AllowClobberrecommendation indocs/use/installation.mdwith a Docusaurus callout (:::info) that instructs users to runGet-InstalledModule IdLE, IdLE.Core -ErrorAction SilentlyContinue | Uninstall-Module -AllVersions -Forcefollowed byInstall-Module -Name IdLE -Scope CurrentUser -Forceas the preferred remediation for command collisions.Testing
Codex Task