zeek / zeek/zeekscript

Do not insert line breaks into function/event/hook definitions if they fit on a single line

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

Nobody has claimed this yet.

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

Description

As of zeek-format-1.1.0 definitions of e.g., events without body or with one-statement bodies always inserts a line break. Instead I would have expected no line break, at least in the case where there is no body (one could argue that with a body forcing a line break is good).

Example:

# Start point:
event zeek_init() {}

# Is formatted as:
event zeek_init()
{ } # Note forced ` ` in body.

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 running zeek-format 1.1.0 on the provided Zeek example and observe the forced line break and space in the empty body. Trace the formatter behavior for function, event, and hook definitions, then confirm that definitions fitting on one line remain on one line, especially those without a body.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.