https://github.com/mariocadenas/vscode-alias-resolver

VSCode extension to resolve alias configurations
https://github.com/mariocadenas/vscode-alias-resolver

alias alias-resolver extension rollup vscode webpack

Last synced: 5 days ago
JSON representation

VSCode extension to resolve alias configurations

• Host: GitHub
• URL: https://github.com/mariocadenas/vscode-alias-resolver
• Owner: MarioCadenas
• Created: 2020-04-29T20:56:47.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T20:24:33.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T16:56:06.694Z (about 2 months ago)
• Topics: alias, alias-resolver, extension, rollup, vscode, webpack
• Language: JavaScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=mariocadenas.alias-resolver
• Size: 1.11 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# alias-resolver

The main idea of this extension is to automatically pick your alias configuration, and resolve all these aliases throughout the code. VSCode has a way to do this by defining a `jsconfig.json` file, but this means that you have to make the file and in case you change the aliases you need to modify them in at least two places.

This extension is heavily inspired on webstorm's behavior, it reads the webpack configuration, and resolve the aliases based on this.

What if you don't use webpack? Well, this extension lets you define which file you want it to read and you can also customize the way it access to the object.

## Features

Imagine this webpack configuration

![Route resolving](images/webpack-config.png)

and look at this React component example

![Route resolving](images/some-js-example.png)

Most probably you would like your editor to know where that route to that file is. So you can autocomplete, or even navigate to the different folders or the file. This extension will resolve that route for you.

It is also a must that vscode autocompletes this kind of routes when we are typing an import. This extension will do that too!

![Autocomplete](images/autocomplete.png)

## Extension Settings

This extension contributes the following settings:

- `alias-resolver.file`: File where your alias definition is.

- `alias-resolver.type`: The type of config you will be using. [webpack | rollup | custom]

- `alias-resolve.accessPath`: This settings lets you define where do you aliases leave. For instance, if you export an object from your file with a shape like this:

```js

module.exports = {

  a: {

    b: {

      alias: {

        '@': path.resolve(__dirname, 'src/')

      }

    }

  }

}

```

This setting would be `a.b.alias`. If you are exporting an object with aliases directly on the root, then you can ignore this setting, or leave it as an empty string.

## Extension commands

```json

      {

        "command": "alias-resolver.updateConfigFile",

        "title": "Update configuration file",

        "category": "Alias resolver"

      },

      {

        "command": "alias-resolver.updateConfigType",

        "title": "Update configuration type",

        "category": "Alias resolver"

      },

      {

        "command": "alias-resolver.updateConfigAccessType",

        "title": "Update configuration access path to object",

        "category": "Alias resolver"

      }

```