From b61a678371a1d83d4401e7fc35e9e541a5671998 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 7 Nov 2023 09:37:52 -0700 Subject: [PATCH] doc(pwsh): update modules dirs, add ToC --- powershell/README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/powershell/README.md b/powershell/README.md index 6124f83..d4e8ea0 100644 --- a/powershell/README.md +++ b/powershell/README.md @@ -7,17 +7,6 @@ tagline: | To update or switch versions, run `webi pwsh@stable` (or `@v7.4`, `@beta`, etc). -### Files - -These are the files / directories that are created and/or modified with this -install: - -```text -~/.config/envman/PATH.env -~/.local/opt/pwsh/ -~/.local/share/powershell/Modules -``` - ## Cheat Sheet > The core benefit of running `pwsh` on Mac or Linux is that you get a way to @@ -27,6 +16,25 @@ For example, if you want to create a `curl.exe -A "windows" | powershell` script for Windows (as we do), it's helpful to be able to do some level of debugging on other platforms. +## Table of Contents + +- Files +- vim +- lint +- fmt + +### Files + +These are the files / directories that are created and/or modified with this +install: + +```text +~/.config/envman/PATH.env +~/.local/opt/pwsh/ +~/.local/share/powershell/Modules/ +~/.local/opt/pwsh/Modules/ +``` + ### How to Use PowerShell with Vim Assuming you have [vim-ale](../vim-ale/) installed - which is included with @@ -35,6 +43,10 @@ Assuming you have [vim-ale](../vim-ale/) installed - which is included with See the "Lint & Fmt" section below. +### How to Use PowerShell with VSCode + +_VS Code_ should also automatically recognize and use `PSScriptAnalyzer`. + ### How to Lint & Fmt ps1 Files You must install `PSScriptAnalyzer`. Then you can use `Invoke-ScriptAnalyzer`