Skip to content

Add format descriptions and lockfile metadata to plugin #88

@danyeaw

Description

@danyeaw

Checklist

  • I added a descriptive title
  • I searched open requests and couldn't find a duplicate

Type of feature request

General feature

What is the idea?

Once conda/conda#15577 is implemented, add description: str and is_lockfile: bool fields to CondaEnvironmentSpecifier and CondaEnvironmentExporter plugin types so help text can display format descriptions and group lockfiles separately.

Why is this needed?

Once conda core adds support for format descriptions and lockfile classification, conda-lockfiles should provide this metadata so help text can explain what conda-lock-v1 and pixi-lock-v6 formats are and group them as lockfiles.

What should happen?

  1. Update conda_lockfiles/plugin.py to add descriptions to both specifier and exporter plugins:
    • conda-lock-v1: "Multi-platform lockfile format with exact package versions"
    • pixi-lock-v6: "Rattler-based lockfile format from pixi"
  2. Set is_lockfile=True for both formats

Files:

  • conda_lockfiles/plugin.py

Related to lockfile format

None

Lockfile Format Information (if requesting new format support)

No response

Implementation Considerations (for new lockfile formats)

No response

Sample Lockfile (optional, for format requests)

Use Case

No response

Priority and Impact

No response

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions