Improve library snippet generation

[dominiksalvet]

Hello,
The current library generation based on ieee prefix is pretty weak and inflexible. It would be great if it could respect either vhdl.suggestLibraryCase settings or current typing case - e.g., writing it without capitals would generate following:

library ieee;
use ieee.std_logic_1164.all;
use ieee.numeric_std.all;

... instead of ...

library IEEE;
use IEEE.std_logic_1164.all;
use IEEE.numeric_std.all;

It may be somewhat connected with #6 but this particular case was not covered in the proposed changes.

What do you think about this suggestion?

[richjyoung]

Interesting. Libraries are handled as a completion rather than a snippet, see src/completions/std_packages.ts.

The reason these are defined programatically rather than as snippets is to enable the configuration of the casing, however following the convention of the previous word is not catered for as you rightly point out.

I think my preference here would be to add extra configuration options in as per #32 rather than try and guess what the user prefers based on the current case. I have worked in places that use a different case for library and package names, so as it stands I don't want to change behaviour people are used to.

I'll keep this open for you to respond, but will probably close this in favour of the other request.

[dominiksalvet]

Interesting. Libraries are handled as a completion rather than a snippet, see src/completions/std_packages.ts.

I though it is handled rather here.

I think my preference here would be to add extra configuration options in as per #32 rather than try and guess what the user prefers based on the current case. I have worked in places that use a different case for library and package names, so as it stands I don't want to change behaviour people are used to.

What is wrong on the vhdl.suggestLibraryCase settings then? Package name case is defined by the vhdl.suggestPackageCase settings, isn't it? If all generation mechanisms respect those and the vhdl.suggestAttributeCase settings, that would only make sense. Or am I missing something?

[richjyoung]

Right I misunderstood, I thought your request pertained to the completion behaviour of typing all these out manually, rather than the snippet to insert the two standard IEEE packages.

So, as this is a snippet there is no mechanism to respect the settings at all. Snippets are statically defined excerpts, rather than dynamically generated according to the local environment.

In terms of following the entered case, the current IEEE snippet uppercases the library and use keywords, and the ieee snippet inserts the text you provided. I understand this is user preference, but it cannot be changed without breaking the existing behaviour for users of this extension.

[richjyoung]

I've just realised the uppercase snippet was never merged. See https://github.com/richjyoung/vscode-modern-vhdl/tree/feature/ucase-snippets/snippets

[dominiksalvet]

Understood. 😞 And there is really no way to do it similarly like in #6 but actually lowercase the IEEE as well — something like this?

IEEE_imports:
  prefix: IEEE
  description: IEEE Standard Packages
  scope: source.vhdl
  body:
    - library IEEE;
    - use IEEE.std_logic_1164.all;
    - use IEEE.numeric_std.all;

ieee_imports:
  prefix: ieee
  description: IEEE Standard Packages
  scope: source.vhdl
  body:
    - library ieee;
    - use ieee.std_logic_1164.all;
    - use ieee.numeric_std.all;

If this is what users want, then I respect it and let it be this way. In that case, you can freely close this issue.

[dominiksalvet]

I've just realised the uppercase snippet was never merged. See https://github.com/richjyoung/vscode-modern-vhdl/tree/feature/ucase-snippets/snippets

I know. I was just mentioning it to provide kind of reference what I would expect... 😄

[richjyoung]

The intention of the branch was to just copy snippets, and the corresponding uppercase prefix would give uppercase keywords. In this case, there are even more permutations to consider with the case of the library name.

Let me look into this, as I think it should be possible to offer multiple snippets for the same prefix.