stackblitz / stackblitz/eslint-plugin

`@blitz/lines-around-comment` conflicts with `prettier/prettier`

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
10
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Reproduction

https://stackblitz.com/~/edit/stackblitz-starters-afmjq7?file=types.d.ts&file=types-with-line-break.d.ts

1 | declare namespace something {
2 |   /** JSDoc describing this */
      ^ 2:3  error  Expected line before comment  @blitz/lines-around-comment
3 |   export const entry: 1;
4 | }
1 | declare namespace something2 {
2 |
    ^  2:1  error  Delete `⏎`  prettier/prettier
3 |   /** JSDoc describing this */
4 |   export const entry2: 1;
5 | }

Contributor guide

No contributing guide indexed for this repository

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

Start with the StackBlitz reproduction and compare types.d.ts with types-with-line-break.d.ts. Trace the @blitz/lines-around-comment rule behavior for the JSDoc comment alongside prettier/prettier. Done means the conflicting diagnostics are resolved for the shown TypeScript cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.