nextflow-io / nextflow-io/language-server

Ability to skip formatting for specific sections of code

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

Nobody has claimed this yet.

formatting
Dominant language
Java
Stars
31
Forks
8
Avg merge
1d 10h
Merged PRs (30d)
2

Description

Automatic code formatters are amazing, but sometimes you find edge cases where they get in the way. In these situations, it's nice to have a get-out-of-jail-free-I-know-what-I'm-doing-leave-me-alone option.

Other code formatters such as Black and Prettier have this option.

My suggestion would be to follow Black and have the following options:

  • // fmt: skip - don't format just this line
  • // fmt: off - turn formatting off from here onwards (can be used to skip an entire file)
  • // fmt: on - turn formatting back on again after a // fmt: off for a code block.

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

The issue does not name files, tests, or an entry point. Start by locating the formatter implementation and its existing tests in the language server. Done means supporting // fmt: skip, // fmt: off, and // fmt: on with the described line, file, and code-block behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.