Fix code to open Terraform resource documentation #67
Conversation
when provider source cannot be found in current buffer or in terraform files
| # blah blah | ||
| terraform { | ||
| required_providers { | ||
| aws = { | ||
| source = \"hashicorp/aws\" | ||
| version = \"~> 5\" | ||
| } | ||
| azurerm = { | ||
| source = \"hashicorp/azurerm\" | ||
| version = \"~> 3.47\" | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Here we should probably put some different content so it really loads the data from the file and not from the buffer (as a fallback).
There was a problem hiding this comment.
Loading provider source from this file is done in test command--terraform--get-resource-provider-source-provider-in-file line 201.
terraform-mode.el
Outdated
| (defun terraform--get-resource-provider-source (provider &optional dir) | ||
| "Return provider source for PROVIDER located in DIR." | ||
| (goto-char (point-min)) | ||
| (let ((source) (file) (file_path) (tf_files)) |
There was a problem hiding this comment.
Elisp never uses the underscore, traditional style is to use a dash to separate words.
Further, if you are only declaring variables, they can be written in a single paren, (let (a b c d) ... ). They will all be set to nil.
But it's better to try to always declare and initialize at the same time rather than use setq later (kind of pretending we have immutability)
There was a problem hiding this comment.
ok for the first 2 points.
Originally, I did set source with (let ...). But the other *file* variables can only be set if there are some files to read, which is not the case if the user has just started to write the terraform file and has not yet saved his buffer.
All in all, I found awkward to set source in (let...), because it would be the only variable set this way, and it could be overridden later on.
There was a problem hiding this comment.
On 2nd thought, I've improved the code following your suggestion. Only tf-files is not setup in let
terraform-mode.el
Outdated
| @@ -252,18 +252,54 @@ | |||
| (when (re-search-forward (concat "/\\(.*?\\)/" provider "\\]") nil t) | |||
| (match-string 1))))) | |||
|
|
|||
| (defun terraform--get-resource-provider-source (provider &optional dir) | |||
| "Return provider source for PROVIDER located in DIR." | |||
There was a problem hiding this comment.
It's not clear what the source is. Is it buffers, files, file names?
There was a problem hiding this comment.
ok, I'll add these details in the doc.
terraform-mode.el
Outdated
| (if (= (length provider-source) 0) | ||
| ;; fallback to old method with terraform providers command | ||
| (setq provider-source | ||
| (concat | ||
| (terraform--get-resource-provider-namespace provider) | ||
| "/" provider))) | ||
| (if (> (length provider-source) 0) | ||
| (format "https://registry.terraform.io/providers/%s/latest/docs/%s/%s" | ||
| provider-source | ||
| doc-dir | ||
| resource-name) | ||
| (user-error "Can not determine the provider namespace for %s" provider)))) | ||
| (user-error "Can not determine the provider source for %s" provider)))) |
There was a problem hiding this comment.
This code is a bit too complicated. It's preferable not to re-assign variables in elisp if possible.
When using only the then of the if, use when that will make the intent a bit clearer.
There was a problem hiding this comment.
Since there's 3 ways to set provider-source which are attempted, I don't know how to avoid re-assigning it. Any suggestion ?
|
@Fuco1 Any news ? |
This function used to fail when a buffer is not saved. The message was something like: let*: Opening input file: Aucun fichier ou dossier de ce type, /home/domi/private/freelance/seira/repos/infra-terraform/modules/terragrunt/azure-config/.#cluster.tf With this patch, terraform files name must be made with alphanum - space and _ and finish with .tf
|
Thank you @dod38fr for following up on all my suggestions. I am very grateful for your contribution and I'm sorry it took me so long to review and merge this. |
|
No worry. I'm glad it's been merged. All the best |
Currently the feature to open documentation is not always working. It relies on the output of
terraform providerscommand. With AWS, this command works only with a valid token. This is a PITA when the token has a short life.With this PR, the provider source is found by parsing current buffer and all terraform files for a
required_providersdeclaration to find the provider source and build the documentation URL.If the provider source is not found, this PR falls back on calling
terraform providerslike before.One caveat: the
required_providersdeclaration is searched with some regexps, so it's not bulletproof. Using a HCL parser or lsp would be better, but it's beyond my current skill set.