PowerShell / PowerShell/PSScriptAnalyzer

Provide an asynchronous API

Open
#1,482 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Consider - 2.0
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

PSSA2 should provide an API set that allows hosts to run PSSA asynchronously.

This includes:

  • A set of asynchronous methods to run analysis, with cancellation token support
  • A new rule executor that provides an asynchronous run strategy, including for non-threadsafe rules
  • An asynchronous rule API for rules wishing to implement their own asynchronous methods
    • It should be possible to implement an asynchronous and synchronous rule in the same class
  • An asynchronous harness for running synchronous rules with a minimum of overhead

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 existing analysis entry points, rule executor, rule API, and synchronous harness; the issue names no files or tests. Done means hosts can run analysis asynchronously with cancellation, non-threadsafe rules have an asynchronous strategy, rules can provide asynchronous and synchronous methods, and synchronous rules can run through an asynchronous harness.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.