mpyw / mpyw/declscope

Inflections are generated in one direction, so an inflected file name is never carried by its stem

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

Nobody has claimed this yet.

Dominant language
Go
Stars
1
Forks
0
Avg merge
57m
Merged PRs (30d)
49

Description

Inflected forms are generated from the namespace, and only ever longer ones. A namespace that is itself an inflected form is never carried by its own stem, so the verdict depends on which form the file name happens to use.

store.go    storingThing   carried
storing.go  storeOther     not carried

trace.go    tracingZ       carried
trace.go    tracerW        carried
tracing.go  traceX         not carried
tracing.go  tracerY        not carried

Every pair above is the same English verb. The rule separates them on nothing an author would recognise as a rule.

Where it came from

namespace.Contains allows the namespace anywhere in the name, with a free right edge. That covers a name longer than the namespace: store is a prefix of storing, so storingThing carries it without any generation at all.

Generation exists for the two inflections that change the namespace's own spelling, store to storing and apply to applies. It is built from the namespace side on purpose, so that only constructed forms are accepted and story never carries store.

That decision is still right. The gap is that generation only ever lengthens. Nothing produces trace from tracing, and the free right edge cannot help, since the namespace is the longer string.

This is real, not hypothetical

zerologlintctx has internal/ssa/tracing.go, whose declarations are tracerType, tracerEvent, traceValue, traceCommon, tracePhi. Under qualify: ondemand the file is asked for tracingTracerType and tracingTraceValue, which stutter. Renaming the file to tracer.go silences five of them and leaves the trace* ones, so the file name decides how much stuttering is demanded.

Options

Generate the stem as well. Reversing the e-drop turns tracing into trace, and that is the answer here. It is also how ring becomes r and string becomes str, so it needs a guard beyond stripping ing, and any guard is a rule about English rather than about Go.

Leave it to rules.naming.vocabulary. One line covers the case, and the free right edge makes it reach the whole family:

rules:
  naming:
    vocabulary:
      tracing: [trace]

This works today. It asks the author to notice a distinction that has no reason behind it, which is the part worth fixing.

Report it. A namespace the generator can recognise as an inflected form could carry a note in the diagnostic, pointing at the vocabulary key rather than at a rename that stutters.

Note

The rule is off by default, so nothing is broken for a project that has not opted in. What the vocabulary covers, it covers well. The asymmetry is the defect: two files spelled by the same verb are treated differently, and the author has no way to predict which one is which.

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 namespace.Contains and the inflection-generation logic, then reproduce the behavior using internal/ssa/tracing.go and the tracing/tracer examples in the issue. Compare the existing vocabulary workaround with the proposed behavior and determine how equivalent verb forms should be handled. Done means the same verb family is treated consistently without making unrelated names such as story match store.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.