zeek / zeek/zeekscript

The first comments in vectors/sets/structs don't get indented properly

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

Nobody has claimed this yet.

Dominant language
Python
Stars
11
Forks
4
Avg merge
3d 19h
Merged PRs (30d)
1

Description

Given some ports definition (like is in the Spicy protocol plugin template), the indentation doesn't start until the first item, so comments get unindented:

const ports = {
-	# This comment gets unindented
+# This comment gets unindented
	1234/tcp,
	# This one stays, though
	5678/tcp,
};

I would expect no change.

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

Reproduce the formatting behavior using the ports definition from the linked Spicy protocol plugin template, focusing on comments before the first item in vector, set, and struct literals. Compare the formatter's output with the input and consider the issue done when those leading comments retain their indentation without changing other formatting.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.