PowerShell / PowerShell/PowerShellEditorServices

Add support for source maps

Open
#617 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Debugging Issue-Enhancement
Dominant language
C#
Stars
767
Forks
266
Avg merge
3d 16h
Merged PRs (30d)
1

Description

One of the most common project layouts is to have every function in it's own ps1 file. When one of those projects gets at a certain size (very large, like dbatools) that can begin to affect the load time of the module. As a workaround, some of these modules will "compile" the ps1 files into a single psm1.

I think it would be a good idea to come up with a source map system so if we break somewhere in the compiled psm1 we could show the original source file instead.

This could also be useful for other projects who test against the "fully built" version of their module in a Release folder. I do this in a lot of my projects and often end up editing the temporary version of a file in Release because that's where the debugger put me.

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

The issue names no files, tests, or entry points. Start by locating the module compilation and debugger source-location handling, then determine how a source map should connect compiled psm1 locations to original ps1 files. Done should include a defined mapping format and debugger behavior, with coverage for modules built into a Release folder.

Written by the indexing model from the issue text.

Assessment

Domain
devtools
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.