PowerShell / PowerShell/PSScriptAnalyzer

Support EditorConfig format settings

Open
#1,898 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Configuration Issue-Enhancement
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Summary of the new feature

It would be nice if PSSA could be able to leverage format settings inside a .editorconfig file so settings don't have to duplicated across multiple files.

https://editorconfig.org/

Proposed technical implementation details (optional)

When PSSA is called and .editorconfig is in the PWD then leverage that file to fill in formatting settings if not already set in a PSSASettings file. A switch parameter could be used to also not leverage .editorconfig files.

What is the latest version of PSScriptAnalyzer at the point of writing

1.21

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 tracing how PSSA reads PSSASettings and applies formatting settings when invoked from the PWD, then review the EditorConfig format. Determine where an optional switch would disable .editorconfig loading and how existing settings take precedence; the work is done when supported settings are loaded without overriding explicit PSSASettings values and the opt-out behavior is verified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.