prettier/prettier

Support prettier-ignore-start/end for other languages (not only Markdown)

Open

#5,287 建立於 2018年10月23日

在 GitHub 查看
 (75 留言) (437 反應) (0 負責人)JavaScript (51,868 star) (4,716 fork)batch import
area:ignorehelp wanted

描述

It seems this feature was added only for markdown (#4202 cc @ikatyang), but it's actually useful for other languages as well. It is not working on typescript files on my tests.

Related: https://github.com/facebook/create-react-app/issues/5543

Environments:

  • Prettier Version: 1.14.3
  • Running Prettier via: CLI
  • Runtime: Node.js v8.11.4
  • Operating System: macOS

Steps to reproduce:

Create a index.d.ts file with the following content:

// prettier-ignore
type A1 = string;

// prettier-ignore
type A2 = string

/* prettier-ignore-start */
type B1 = string;
type B2 = string
/* prettier-ignore-end */

type C1 = string;
type C2 = string

Expected behavior:

// prettier-ignore
type A1 = string;

// prettier-ignore
type A2 = string

/* prettier-ignore-start */
type B1 = string;
type B2 = string
/* prettier-ignore-end */

-type C1 = string;
+type C1 = string
type C2 = string

Actual behavior:

// prettier-ignore
type A1 = string;

// prettier-ignore
type A2 = string

/* prettier-ignore-start */
-type B1 = string;
+type B1 = string
type B2 = string
/* prettier-ignore-end */

-type C1 = string;
+type C1 = string
type C2 = string

貢獻者指南

技術棧
typescriptjavascript
領域
developer experiencetooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Understanding of prettier ignore comments
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
The feature already exists for Markdown (PR #4202). To extend it to TypeScript, examine the Markdown implementation in prettier's source, likely in src/language js/ or src/language markdown/. The logic for parsing 'prettier ignore start/end' comments needs to be added for JavaScript/TypeScript. Check the existing test files for 'prettier ignore' in JavaScript to understand the pattern. The issue includes a clear repro case for a .d.ts file, which can be used for testing.