PowerShell / PowerShell/PSScriptAnalyzer

Invoke-ScriptAnalyzer required Path parameter

Open
#1,887 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Engine Up-for-Grabs
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

The required -Path parameter is a usability concern. It should default to . removing the need for the required parameter.

Is there a reason or design choice of why this parameter is required without a default value?

Steps to reproduces

Invoke-ScriptAnalyzer

Expected behavior

# just runs
Invoke-ScriptAnalyzer

Actual behavior

Invoke-ScriptAnalyzer

cmdlet Invoke-ScriptAnalyzer at command pipeline position 1
Supply values for the following parameters:
Path:

If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *

Environment data

> $psversiontable

Name                           Value
----                           -----
PSVersion                      7.3.2
PSEdition                      Core
GitCommitId                    7.3.2
OS                             Microsoft Windows 10.0.19044
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }

1.21.0
1.20.0
1.19.1
1.18.3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Invoke-ScriptAnalyzer command implementation and its Path parameter definition. Check how the command behaves when Path is omitted, then verify that invoking Invoke-ScriptAnalyzer without arguments runs against the current directory and does not prompt for Path.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
cli, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.