hls-qualify-imported-names-plugin: A Haskell Language Server plugin that qualifies imported names

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Please see the README on GitHub at https://github.com/haskell/haskell-language-server#readme

[Skip to Readme]

Properties

Versions	1.0.1.0, 1.0.1.0, 1.0.2.0, 2.0.0.0, 2.0.0.1, 2.1.0.0, 2.2.0.0, 2.3.0.0, 2.4.0.0, 2.5.0.0, 2.6.0.0
Change log	None available
Dependencies	aeson, base (>=4.12 && <5), containers, deepseq, dlist, ghc, ghcide (>=1.6 && <1.9), hls-graph, hls-plugin-api (>=1.3 && <1.6), lsp, text, transformers, unordered-containers [details]
License	Apache-2.0
Author	Jonathan Shen
Maintainer	shenjonathan0@gmail.com
Category	Development
Uploaded	by hls_team at 2022-09-13T21:21:20Z

Modules

[Index] [Quick Jump]

Ide
- Plugin
  - Ide.Plugin.QualifyImportedNames

Downloads

hls-qualify-imported-names-plugin-1.0.1.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

PepeIborra, jneira, eddiemundo, hls_team

For package maintainers and hackage trustees

edit package information

Readme for hls-qualify-imported-names-plugin-1.0.1.0

[back to package description]

Qualify Imported Names

Qualify Imported Names Demo

Summary

Rewrite imported names to be qualified.

Motivation

You've imported a number of modules, and have written a lot of code with unqualified names. You want to import a new module but you know there will be a number name clashes so you want to switch your current usage of names to be qualified.

It would be nice if you could change

import Blah

import Blah as Bloo

then magically qualify all the previous names imported from Blah with Bloo. After doing that you could then change

import Blah as Bloo

import qualified Blah as Bloo

and import your the new module using names from it without worry.

Well, now you can...

Usage

Put cursor over the import declaration you want to qualify names from.
Initiate a Code Action.
Select Qualify imported names.

Features

Names are qualified on a per-import declaration basis.
Names are qualified by the imported module's alias if it has one, otherwise by the imported module's name.
If the import declaration has an explicit import list then the plugin will qualify only names on the list.
If the import declaration has an explicit hiding list then the plugin will qualify names from the imported module that are not on the list.

Future possibilities

It may be possible to use the LSP rename functionality to ask for a name so that we don't have to do the as Alias dance.