PowerShell / PowerShell/PSScriptAnalyzer

[formatter] Comment to let formatter ignore contents

オープン
#2,151 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Area - Formatter
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
2

説明

Summary of the new feature

A common feature of formatter is to ignore formatting for rest of lines/range of lines with special comments.
I propose this feature because formatting rules in pssa are rather bold, you can't get a finer control on the style, so ignoring certain part can save my code from being messed up.

# ignore a range of lines

# pssa: ignore format start
echo foo
echo bar
# pssa: ignore format end

# ignore the rest of lines

# pssa: ignore format
echo foo

Proposed technical implementation details (optional)

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

I don't know, I use powershell-editor-services

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue には、ファーマッターのファイル、テスト、エントリポイントが記載されていません。まず PSScriptAnalyzer のファーマッター実装とコメントの扱いを見つけ、その後、既存のファーマッターのテストを確認してください。提案された範囲マーカーと、後続のすべての行を無視する単一のコメントをサポートし、囲まれたコードをフォーマットしないことが完了の条件です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, powershell
領域
tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
52/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。