Skip to content

First-class sidecar annotations file (openshell.annotations.yaml) #20

Open

Description

@ilanh

Summary

Teams that cannot or do not want to edit source (vendored code, third-party repos, generated code, Paperclip-style test cases) need a first-class way to keep directives outside the code.

Proposal

  • Optional file openshell.annotations.yaml that the scanner merges with inline comments.
  • Entries anchor to a file and symbol (for example src/llm.ts#callOpenAI), with a line number only as a fallback.
  • lint and drift fail when an anchor no longer resolves.
  • diff-logs --write can target either the source comments or the sidecar file.

Today

A .sh sidecar file with @openshell comments works as a workaround (pocketrb). Related: #7 (extra comment leaders for unsupported languages).

Activity

  1. added
    enhancementNew feature or request
    scanopenshell-annotate scan
    languagesSource language and comment support
    on Nov 3, 2026
  2. added a commit that references this issue on Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestlanguagesSource language and comment supportscanopenshell-annotate scan

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions