Skip to content

Archive spec files lack comments explaining why each plugin was removed #85

@ooloth

Description

@ooloth

Why

A developer evaluating whether to add a plugin that already exists in archive/ has no way to know whether it was superseded, tried and rejected, or simply parked — and may reintroduce a deliberate rejection.

Current state

lua/config/plugins/specs/archive/ contains 35 spec files. 29 of those files have no comment explaining why the plugin was archived. There is no indication of whether a replacement is active, whether the plugin was rejected for a specific reason, or whether it is simply under consideration for later. telescope.lua is a representative example of a file with no such context.

Ideal state

  • Every archive file begins with a -- NOTE: archived because ... comment.
  • The comment names the active replacement (if any), e.g. -- NOTE: archived — replaced by snacks-picker.
  • The comment states a reason for removal if no replacement exists, e.g. -- NOTE: archived — too slow on large repos.

Out of scope

Changing the content or structure of the spec tables themselves; adding comments to todo/ files.

Starting points

  • lua/config/plugins/specs/archive/telescope.lua — representative file with no archive comment
  • lua/config/plugins/specs/archive/ — full directory to audit

QA plan

  1. Open any file in lua/config/plugins/specs/archive/ — expect a -- NOTE: archived because ... comment at the top.
  2. Verify the comment names a replacement or a reason, not just "archived".

Done when

All 35 files in archive/ have a top-of-file comment that states why the plugin was archived and names any active replacement.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions