PowerShell / PowerShell/PSScriptAnalyzer

PowerShell code formatting doesn't work as expected in VSCode

Đang mở
#1,689 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Area - Formatter Issue - Bug Need Repro Info
Ngôn ngữ chính
C#
Star
2.2k
Fork
414
Merge trung bình
13 giờ 1 phút
Pull request đã merge (30 ngày)
2

Mô tả

Before submitting a bug report:

  • Make sure you are able to repro it on the latest released version
  • Perform a quick search for existing issues to check if this bug has already been reported

Steps to reproduce

I am using Visual Studio code to create PowerShell scripts and have "Format on Save" enabled. Sometimes I noticed that VSCode has issues with formatting braces correctly.

In the following file you can see an example:
https://github.com/dsccommunity/SharePointDsc/blob/1b7c1e10cd575c0e33e5268f49738d32a32e9078/SharePointDsc/DSCResources/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1#L475-L491

The opening brace of the If statement on line 476 is no aligning with closing brace on line 483. The same is true for the opening brace of the Else statement on line 485 and the closing brace on line 491.

My suspicion is that this has something to do with the code and braces in the code in these statements.

When I have this repo cloned locally, update the braces and then save, VSCode automatically reverts back to the current formatting. According to Tyler Leonhardt PSScriptAnalyzer is handling the formatting for VSCode, that is why I am raising the issue here.

Expected behavior

Both braces are placed on the same position in the line.

Actual behavior

The closing brace is moved two characters to the right, causing them to be misaligned.

Environment data

Name Value


PSVersion 5.1.19041.1023
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.19041.1023
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1

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

VSCode 1.57.1, but am experiencing this for quite a while now.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Tái hiện sự cố trong VSCode với Format on Save bằng ví dụ SharePointDsc/MSFT_SPSearchTopology/MSFT_SPSearchTopology.psm1 được liên kết và PSScriptAnalyzer 1.19.1. Theo dõi cách trình định dạng xử lý các dấu ngoặc nhọn của if/else, thêm một kiểm thử hồi quy cho căn chỉnh mong đợi và xác minh rằng các dấu ngoặc nhọn đóng không còn bị dịch sang phải hai ký tự.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
powershell, vscode
Lĩnh vực
developer-experience, tooling
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
42/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.