Fix: Do not substitute environment variables on windows (#280)

Author: Schottkyc137

Cargo.lock

@@ -1,32 +1,43 @@
 # Overview
+
 This repository contains a fast VHDL language server and analysis library written in Rust.
 
 The speed makes the tool very pleasant to use since it loads projects really fast and does not consume a lot of ram.
-A 200.000 line VHDL project is analyzed in 160 ms on my Desktop using 8 cores and only consumes 180 MByte of RAM when loaded. 
+A 200.000 line VHDL project is analyzed in 160 ms on my Desktop using 8 cores and only consumes 180 MByte of RAM when
+loaded.
 
-I very much appreciate help from other people especially regarding semantic analysis of VHDL. You do not need to be a programmer to help, it is even more helpful to interpret and clarify the VHDL standard and provide minimal examples and describe how they should work according to the standard. Further information about contributing can be found by reading the [Contributors Guide](https://github.com/kraigher/rust_hdl/wiki/Contributor-Guide) 
+I very much appreciate help from other people especially regarding semantic analysis of VHDL. You do not need to be a
+programmer to help, it is even more helpful to interpret and clarify the VHDL standard and provide minimal examples and
+describe how they should work according to the standard. Further information about contributing can be found by reading
+the [Contributors Guide](https://github.com/kraigher/rust_hdl/wiki/Contributor-Guide)
 
 [![Chat](https://img.shields.io/matrix/VHDL-LS:matrix.org)](https://matrix.to/#/#VHDL-LS:matrix.org)
 [![Build Status](https://github.com/kraigher/rust_hdl/workflows/Build%20%26%20test%20all%20configs/badge.svg)](https://github.com/kraigher/rust_hdl/actions?query=workflow%3A%22Build+%26+test+all+configs%22)
 
 ## Contributors
+
 - Maintainer: [Lukas Scheller](https://github.com/Schottkyc137)
 - Founder: [Olof Kraigher](https://github.com/kraigher)
- 
+
 # Projects
+
 ## VHDL Language Server
+
 [![vhdl ls crate](https://img.shields.io/crates/v/vhdl_ls.svg)](https://crates.io/crates/vhdl_ls)
+
 ### Goals
+
 - A complete VHDL language server protocol implementation with diagnostics, navigate to symbol, find all references etc.
 
 ### Features
-- Live syntax and type checking 
+
+- Live syntax and type checking
 - Checks for missing and duplicate declarations
 - Supports goto-definition/declaration (also in presence of overloading)
 - Supports find-references (also in presence of overloading)
 - Supports goto-implementation
-  - From component declaration to matching entity by default binding
-  - From entity to matching component declaration by default binding
+    - From component declaration to matching entity by default binding
+    - From entity to matching component declaration by default binding
 - Supports hovering symbols
 - Rename symbol
 - Find workspace symbols
@@ -35,16 +46,21 @@ I very much appreciate help from other people especially regarding semantic anal
 ## When Installing it from Crate
 
 When installing the VHDL_LS from [crates.io](https://crates.io/crates/vhdl_ls) the required  
-[vhdl_libraries](https://github.com/VHDL-LS/rust_hdl/tree/master/vhdl_libraries) directory will not be installed automatically and  
-will need to be copied into the parent directory of the VHDL_LS binary manually.  
+[vhdl_libraries](https://github.com/VHDL-LS/rust_hdl/tree/master/vhdl_libraries) directory will not be installed
+automatically and  
+will need to be copied into the parent directory of the VHDL_LS binary manually.
 
 ## Trying it out
-A language server is never used directly by the end user and it is integrated into different editor plugins. The ones I know about are listed here.
+
+A language server is never used directly by the end user and it is integrated into different editor plugins. The ones I
+know about are listed here.
 
 ## Use in VSCode
+
 https://github.com/Bochlin/rust_hdl_vscode
 
 ## Use in emacs
+
 VHDL LS has built-in support by emacs `lsp-mode` since 2020-01-04.
 
 It can be set up automatically by installing the package
@@ -61,13 +77,17 @@ following snippet to your config:
 ## Installation for Neovim
 
 ### Automatic Installation
-You can install `rust_hdl` automatically in Neovim using [`:Mason`](https://github.com/williamboman/mason.nvim). Within Mason, the package is called `rust_hdl`. If you don't have `:Mason`, you can simply install the binary as previously described.
+
+You can install `rust_hdl` automatically in Neovim using [`:Mason`](https://github.com/williamboman/mason.nvim). Within
+Mason, the package is called `rust_hdl`. If you don't have `:Mason`, you can simply install the binary as previously
+described.
 
 ### Automatic Configuration using `nvim-lspconfig`
 
-[`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig) has a built in configuration for [`vhdl_ls`](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#vhdl_ls)
+[`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig) has a built in configuration
+for [`vhdl_ls`](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#vhdl_ls)
 
-In order to configure it, simply add 
+In order to configure it, simply add
 
 ```lua
 lspconfig = require('lspconfig')
@@ -78,11 +98,12 @@ lspconfig['vhdl_ls'].setup({
 ```
 
 ### Manual Configuration using Neovim's built in client
+
 Neovim provides an LSP client to the VHDL_LS language server. Download the  
 VHDL_LS release. The binary must be on the path and executable (if you can run  
 "vhdl_ls -h" in the terminal then you're good).
 
-In your Neovim config.lua add the following:  
+In your Neovim config.lua add the following:
 
 ```lua
 function STARTVHDLLS()
@@ -99,9 +120,12 @@ server. There are also other options, like automatically starting it when
 opening a certain file type, see the [Neovim LSP documentation](https://neovim.io/doc/user/lsp.html) for more.
 
 ## Configuration
-The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the [TOML](https://github.com/toml-lang/toml) format named `vhdl_ls.toml`.
+
+The language server needs to know your library mapping to perform full analysis of the code. For this it uses a
+configuration file in the [TOML](https://github.com/toml-lang/toml) format named `vhdl_ls.toml`.
 
 `vhdl_ls` will load configuration files in the following order of priority (first to last):
+
 1. A file named `.vhdl_ls.toml` in the user home folder.
 2. A file name from the `VHDL_LS_CONFIG` environment variable.
 3. A file named `vhdl_ls.toml` in the workspace root.
@@ -114,37 +138,47 @@ Settings in a later files overwrites those from previously loaded files.
 # File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
 [libraries]
 lib2.files = [
-  'pkg2.vhd',
+    'pkg2.vhd',
 ]
 lib1.files = [
-  'pkg1.vhd',
-  'tb_ent.vhd'
+    'pkg1.vhd',
+    'tb_ent.vhd'
 ]
 
 # Wildcards are supported
 lib3.files = [
-  'test/*.vhd',
-  'src/*.vhd',
-  'src/*/*.vhd',
+    'test/*.vhd',
+    'src/*.vhd',
+    'src/*/*.vhd',
 ]
 
 # Libraries can be marked as third-party to disable some analysis warnings, such as unused declarations
 UNISIM.files = [
-  'C:\Xilinx\Vivado\2023.1\data\vhdl\src\unisims\unisim_VCOMP.vhd',
+    'C:\Xilinx\Vivado\2023.1\data\vhdl\src\unisims\unisim_VCOMP.vhd',
 ]
 UNISIM.is_third_party = true
 ```
 
+Paths in the `vhdl_ls.toml` can contain glob patterns (i.e., `.../*/`).
+On Unix machines, they can also contain environment variables using the default `$NAME` or `${NAME}` syntax.
+
 ## As an LSP-client developer how should I integrate VHDL-LS?
-I recommend that the `lsp-client` polls GitHub and downloads the [latest](https://github.com/VHDL-LS/rust_hdl/releases/latest) VHDL-LS release from GitHub.
 
-VHDL-LS has frequent releases and the automatic update ensures minimal maintenance for the `lsp-client` developer as well as ensuring the users are not running and outdated version.
+I recommend that the `lsp-client` polls GitHub and downloads
+the [latest](https://github.com/VHDL-LS/rust_hdl/releases/latest) VHDL-LS release from GitHub.
+
+VHDL-LS has frequent releases and the automatic update ensures minimal maintenance for the `lsp-client` developer as
+well as ensuring the users are not running and outdated version.
 
 ## VHDL Language Frontend
+
 [![vhdl language frontend crate](https://img.shields.io/crates/v/vhdl_lang.svg)](https://crates.io/crates/vhdl_lang)
+
 ### Goals
+
 - This project aims to provide a fully featured open source VHDL frontend that is easy to integrate into other tools.
-- A design goal of the frontend is to be able to recover from syntax errors such that it is useful for building a language server.
+- A design goal of the frontend is to be able to recover from syntax errors such that it is useful for building a
+  language server.
 - Analysis order must be automatically computed such that the user does not have to maintain a compile order.
 - Comments will be part of the AST to support document generation.
 - Separate parsing from semantic analysis to allow code formatting on non-semantically correct code.

README.md

@@ -26,6 +26,7 @@ parking_lot = "0"
 dunce = "1"
 pinned_vec = "0"
 itertools = "0"
+subst = "0.3.0"
 
 [dev-dependencies]
 tempfile = "3"