okfgen: the pruning guard compares scope flags, not the scope rule

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
38/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp, yaml
Domain
backend, cli

Research direction

Start by reading BundleWriter and the manifest scope handling, then run dotnet test producers/OkfProducer.sln. The issue proposes storing a scope-rule identifier alongside scope so the existing pruning guard detects rule changes, but notes that changing the manifest format requires a compatibility decision. Done means rule changes trigger the guard without silently pruning concepts.

Written by the indexing model from the issue text.

Description

bug

Extracted from ROADMAP.md (producers/OkfProducer follow-ups).

BundleWriter refuses to prune when the previous run covered a wider scope. It decides this by comparing the flags recorded in the manifest, so it is blind to a run whose flags are identical but whose rule narrowed.

Measured: a bundle generated before scope moved to effective visibility was regenerated with the same flags. It lost five concepts and the guard stayed silent.

The producer now prints a note when it caps a public member at an internal container, which covers today's only case.

General fix: record a scope-rule identifier beside scope in the manifest, so that the existing guard fires on a rule change. This changes the manifest format, which is a compatibility decision of its own.

The producer is outside CI: run dotnet test producers/OkfProducer.sln.

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

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.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.