mitchellh / mitchellh/vouch

Proposal: API Change

Open
#82 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nushell
Stars
5.1k
Forks
91
PR merge metrics
No merged PRs in 30d

Description

PreScript: writing this at the end, syntax will look like [action][(provider|FQDN)](@userID[:username]|:username)[REASON] square brackets are optional, round brackets for the EITHER/OR syntax split by the pipe.

  1. Optional + when vouching; i.e. it should be supported by the parser, so
    +ditherdude
    # is the same as
    ditherdude
    

    Whilst this looks prettier when viewing as a diff file, it also allows for in the future to be able to vouch/denounce someone ip the provider starts with a "-" (def. not talking from exp of owning a domain that starts wyth a hyphen and every service breaking)

  2. If a provider contains a dot (.), treat as url. (so github.com is the same as github, following the vouch example md)
  3. optional userid. I havent checked the code, but acc to the issues this isnt in yet? mark with @ symbol, reads until ':'.
  4. @include https://.../vouched.td to include other vouch files; latest change is the one that persists (so put includes above repo-defined vouches). I kn;w this is a topic of much debate, im just asking that the parser /lexer support this syntax so it can be implemented later on.
  5. extending on (4), ! action to reset vouch status to nothing (useful if an included vouchlist donounces someone but yiu dont want to vouch them)

  6. ive tried to implement the above in a way thrt doesnt break any current conf (backward-compatible), rhilst also being future proof (as importing vouched files is not planned at this point AFAIK) or at least a common standard if ppl will eg fork to add importable include files.
    EDIT: changed to HTML cuz MD made this whole issue a header???

Contributor guide

Open the contributing guide

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

No files, tests, or parser entry points are named. Start by locating the existing parser/lexer and current vouch syntax tests, then compare the requested forms with current behavior; done means the listed syntax is supported without breaking existing configuration, with coverage for backward compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.