godotengine/emacs-gdscript-mode

Rewrite gdscript-imenu to provide GDScript-specific tables

Open

#89 opened on Sep 8, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Emacs Lisp (41 forks)auto 404
enhancementgood first issuerefactor

Repository metrics

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

Description

While we have imenu support, it's based on the built-in Python package and not tailored to GDScript, creating tables that are useful but that also have incorrectly sorted or formatted entries at times. For instance, signals get labeled as "Structs".

Tasks:

  • Correctly label functions, variables, and inner classes.
  • Add support for optional type hints, at least for functions. We need a regexp that captures -> type. It'd be nice to have for variables too but with inferred types we're a bit limited.

Contributor guide

Research direction
Inspect the current gdscript imenu implementation and identify how to map GDScript structures (functions, variables, inner classes, signals) to imenu table entries. Add a regexp for optional type hints like ` > type`. Ensure correct labeling instead of mislabeling signals as 'Structs'.
Tech stack
None
Domain
developer experience
Issue type
Refactor
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.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75