clojure-lsp/clojure-lsp

Rename namespace alias with API / CLI

Open

#1,792 opened on Mar 15, 2024

View on GitHub
 (3 comments) (2 reactions) (0 assignees)Clojure (177 forks)batch import
APIenhancementgood first issue

Repository metrics

Stars
 (1,310 stars)
PR merge metrics
 (Avg merge 47d 8h) (24 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

In the Editor integration I can point to a namespace alias and then rename it. But this feature is not exposed to the public API.

Describe the solution you'd like

Option A:

(clojure-lsp.api/rename-ns-alias!
 {:target-namespace 'clojure.string
  :alias 'str })

Running this on the project, would unify the alias to clojure.string in all files.

Option B:

(clojure-lsp.api/rename-ns-alias!
 {:from 'clojure-string
  :to 'str})

This would only match an existing alias clojure-string and rename it, independent of the target namespace it points to.

Contributor guide

Research direction
Look at how the editor integration performs the rename ns alias action (likely via LSP) and expose a similar function in the public API. Study existing API functions like clojure lsp.api/rename for patterns.
Tech stack
None
Domain
apicli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Clojure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60