PowerShell / PowerShell/PSScriptAnalyzer

[formatter] Comment to let formatter ignore contents

未关闭
#2,151 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area - Formatter
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

issue 中没有列出 formatter 的文件、测试或入口点。首先定位 PSScriptAnalyzer formatter 的实现及其对注释的处理方式,然后检查现有的 formatter 测试。完成的标准是支持提议的范围标记,以及忽略后续所有行且不对其中代码进行格式化的单条注释。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, powershell
领域
tooling
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
52/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。