zeek / zeek/zeekscript

Ignore unknown directives

Open
#27 2 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

Take testing/btest/language/alternate-prototypes-deprecated-args.zeek from zeek/zeek. When reformatting, we get:

-@TEST-START-FILE hide.zeek
+@ @ TEST - START -  FILE hide.zeek

I realize that this isn't a Zeek script per se, it's a btest. But I'm wondering if we should ignore unknown directives, as the current behavior will break what it doesn't understand.

Or perhaps we make an exception and add the btest-provided directives.

Reason being is that it seems like it'd be handy to format Zeek code in btests in a similar way to other Zeek code.

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 with testing/btest/language/alternate-prototypes-deprecated-args.zeek and reproduce how its @TEST-START-FILE directive is reformatted. Read the directive-handling path in the formatter, then determine whether unknown directives or the btest-provided directives should be supported. Done means btest Zeek code formats without corrupting directives, with coverage for the named example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
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.