strawberry-graphql/strawberry-django

LSP: warn on `fields="__all__"` and add code action to expose all fields

Open

#558 opened on Jun 14, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (152 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (496 stars)
PR merge metrics
 (PR metrics pending)

Description

We don't have an LSP for Strawberry Django, but in case we add one I think this feature would be neat to have.

We allow to use fields="__all__", which might lead to security issues, so the LSP could warn when using that, and also provide a code action that does what __all__ does, but with code

From this:

@strawberry.django.type(models.Flyer, fields="__all__")
class Flyer:
    ...

To this:

@strawberry.django.type(models.Flyer)
class Flyer:
    id: auto
    title: auto

We could also add code action to expose additional fields :)

Contributor guide

Research direction
Investigate LSP implementation for Strawberry Django to detect `fields=" all "` and provide code actions to expand all fields explicitly.
Tech stack
pythondjangographql
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonDjangoGraphQLLSP concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50