nextflow-io / nextflow-io/language-server

Linting

Open
#6 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Once a source file has been parsed (barring any syntax errors), you have an AST and you can do all sorts of static analysis on it. Much of that analysis will fall under error checking, like checking names, function call arguments, and types, but there are things beyond that which generally fall under "linting", which is checking for things that aren't technically errors but could lead to errors or are considered bad practice.

Linting is a very broad topic and is not something that is ever complete. The goal of this issue is to collect some of the most useful examples of linting as a starting point.

Resources:

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 by reviewing the issue's linting scope and the linked CodeNarc, Nextflow linter-rules, and Reftrace resources. Identify a focused set of useful initial linting examples for the language server; done means the selected rules and their intended behavior are clearly defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.