zeek / zeek/zeekscript

sometimes merges comments where should not

Open
#137 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

looks like for short lines ## comments are pulled up, with no break, which doesnt work where the zeek parser is greedy
(or alternately i guess this is a zeek bug that the ## should have started a new comment...)

✦4 ❯ cat bug.zeek
@load ./foo.zeek
## @load ./bar.zeek

✦4 ❯ zeek-format bug.zeek
@load ./foo.zeek## @load ./bar.zeek

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 issue with the provided bug.zeek input and the zeek-format entry point, then trace how short lines and ## comments are parsed and emitted. Compare the formatter output with the Zeek parser's expected comment boundary; done means the two @load directives remain separated and the behavior is covered by a regression test.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.