Robin-van-der-Linde/MapCompleteVScode
1
0
Fork 0
Code Issues Pull requests Releases 1 Activity
MapCompleteVScode/README.md
Robin van der Linde 97fe45f6f9
📝 Update readme and changelog
2025-01-09 01:02:49 +01:00

3 KiB
Raw Blame History

MapCompleteVScode

This is a Visual Studio Code extension for MapComplete. It adds autocompletion and defintion support for the MapComplete theme and layer configuration files.

Currently the following features are supported:

  • Layers:
    • Autocompletion for the layer names
    • Definition support for the layer names
    • Implementation support for the layer names (showing where they are used)
  • TagRenderings:
    • Autocompletion for all tagRenderings
    • Definition support for tagRenderings
    • Implementation support for tagRenderings (showing where they are used)
  • Filters:
    • Autocompletion for all filters
    • Definition support for filters
    • Implementation support for filters (showing where they are used)
  • Icons:
    • Autocompletion for icons
    • Definition support for icons
  • Colours:
    • Support for colours in markers, lines and fills
  • License info:
    • Definition support for paths in license_info.json files

To achieve some of these feature, on startup the extension will parse all the files, which takes about 30 seconds. This will only happen once per session, and will update individual files as they are saved or removed.

Demo showing autcomplete for layers and icon definition

All notable changes to this project are documented in the CHANGELOG file.

Installation

The extension can be installed in several ways:

From the marketplace

The extension is available both in the Visual Studio Code marketplace and the Open VSX registry.

So for both Visual Studio Code and VSCodium, you should just be able to search for "MapComplete" in the extensions tab and install it from there.

Alternatively you can press Ctrl+P and paste the following command:

ext install robin-van-der-linde.mapcompletevscode

From the .vsix file

You can also install the extension from the .vsix file. You can download the latest version from the releases page. After downloading the .vsix file, you should be able to install it by going to extensions in Visual Studio Code and clicking on the three dots in the top right corner. Then click on "Install from VSIX..." and select the downloaded .vsix file.

It's also possible to install builds for any commit in any branch by checking out the workflow run for the commit you want to install, and downloading the .vsix file from the artifacts.

Usage

Most of the features should be pretty self-explanatory. As for the implementation support, the 'anchor' for this is the id property of the layer, tagRendering or filter. This means that if you want to see where a layer is used, you should be able to see all uses by using CTRL+F12 on the id property of the layer, or by right-clicking on the id property and selecting "Go to Implementations".