Skip to content

Terraform (HCL) (*.tf): new parser #2952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Terraform (HCL) (*.tf): new parser #2952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
616c2d1
add terraform support (preliminary)
antonysouthworth-halter Apr 11, 2021
c78ccef
add terraform c parser
antonysouthworth-halter Apr 11, 2021
c4d902e
add copyright notice and doc
antonysouthworth-halter Apr 11, 2021
ca9d8fe
fix build
antonysouthworth-halter Apr 11, 2021
489c04c
fix newlines
antonysouthworth-halter May 3, 2021
7d58baf
pr fixes
antonysouthworth-halter May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/news.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ The following parsers have been added:
* SystemVerilog
* SVG *libxml*
* TclOO (see :ref:`The new Tcl parser <tcl>`)
* Terraform (HCL) *optlib*
* TTCN
* Txt2tags
* TypeScript
Expand Down
1 change: 1 addition & 0 deletions main/parsers_p.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@
SystemTapParser, \
TclParser, \
TclOOParser, \
TerraformParser, \
TexParser, \
TexBeamerParser, \
TTCNParser, \
Expand Down
1 change: 1 addition & 0 deletions makefiles/optlib2c_input.mak
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ OPTLIB2C_INPUT = \
optlib/puppetManifest.ctags \
optlib/scss.ctags \
optlib/systemtap.ctags \
optlib/terraform.ctags \
\
$(NULL)
83 changes: 83 additions & 0 deletions optlib/terraform.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/*
* Generated by ./misc/optlib2c from optlib/terraform.ctags, Don't edit this manually.
*/
#include "general.h"
#include "parse.h"
#include "routines.h"
#include "field.h"
#include "xtag.h"


static void initializeTerraformParser (const langType language CTAGS_ATTR_UNUSED)
{
}

extern parserDefinition* TerraformParser (void)
{
static const char *const extensions [] = {
"tf",
"tfvars",
NULL
};

static const char *const aliases [] = {
NULL
};

static const char *const patterns [] = {
NULL
};

static kindDefinition TerraformKindTable [] = {
{
true, 'r', "Resource", "Terraform Resource",
},
{
true, 'd', "Data", "Terraform Data",
},
{
true, 'v', "Variable", "Terraform Variable",
},
{
true, 'p', "Provider", "Terraform Provider",
},
{
true, 'm', "Module", "Terraform Module",
},
{
true, 'o', "Output", "Terraform Output",
},
};
static tagRegexTable TerraformTagRegexTable [] = {
{"^[[:space:]]*resource[[:space:]]*\"([^\"]*)\"[[:space:]]*\"([^\"]*)\"", "\\2",
"r,Resource", NULL, NULL, false},
{"^[[:space:]]*data[[:space:]]*\"([^\"]*)\"[[:space:]]*\"([^\"]*)\"", "\\2",
"d,Data", NULL, NULL, false},
{"^[[:space:]]*variable[[:space:]]*\"([^\"]*)\"", "\\1",
"v,Variable", NULL, NULL, false},
{"^[[:space:]]*provider[[:space:]]*\"([^\"]*)\"", "\\1",
"p,Provider", NULL, NULL, false},
{"^[[:space:]]*module[[:space:]]*\"([^\"]*)\"", "\\1",
"m,Module", NULL, NULL, false},
{"^[[:space:]]*output[[:space:]]*\"([^\"]*)\"", "\\1",
"o,Output", NULL, NULL, false},
{"^([a-z0-9_]+)[[:space:]]*=", "\\1",
"f,TFVar", NULL, NULL, false},
};


parserDefinition* const def = parserNew ("terraform");

def->enabled = true;
def->extensions = extensions;
def->patterns = patterns;
def->aliases = aliases;
def->method = METHOD_NOT_CRAFTED|METHOD_REGEX;
def->kindTable = TerraformKindTable;
def->kindCount = ARRAY_SIZE(TerraformKindTable);
def->tagRegexTable = TerraformTagRegexTable;
def->tagRegexCount = ARRAY_SIZE(TerraformTagRegexTable);
def->initialize = initializeTerraformParser;

return def;
}
35 changes: 35 additions & 0 deletions optlib/terraform.ctags
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#
# terraform.ctags: regex parse for Terraform (HCL).
#
# Author: Antony Southworth <https://github.com/antonysouthworth-halter>
#
# This source code is released for free distribution under the terms of the
# GNU General Public License version 2 or (at your option) any later version.
#
# Derived from `vim-terraform-completion`:
# - https://github.com/juliosueiras/vim-terraform-completion/blob/master/ctags/terraform.ctags
Copy link
Member

@masatake masatake Apr 11, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you reuse the regex patterns of @juliosueiras's work, ask @juliosueiras to allow to use one's .ctags in GPLv2 or later. Copy & paste the evidence of alowing to use here as comments.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what would I need to paste?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you fill and paste it at the head of your .ctags?

#
#  Copyright (c) 2021, <YOUR NAME HERE>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.
#

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

#
# Changed the name from `terraform` to `tf` so vim will recognise it properly based
# on file extension (*.tf).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean the name of the parser must be "tf"?

#
# A notable abscence is `local`, because `locals` are defined inside a block and
# it's way harder to write a good regex for that.
# - https://www.terraform.io/docs/language/values/locals.html

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you put a URL for the language reference?

--langdef=terraform
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I forgot writing one thing. A parser that is part of ctags should have Capitalized name.
Please, do s/terraform/Terraform/g.

--map-terraform=+.tf
--map-terraform=+.tfvars
--kinddef-terraform=r,Resource,Terraform Resource
--kinddef-terraform=d,Data,Terraform Data
--kinddef-terraform=v,Variable,Terraform Variable
--kinddef-terraform=p,Provider,Terraform Provider
--kinddef-terraform=m,Module,Terraform Module
--kinddef-terraform=o,Output,Terraform Output
--regex-terraform=/^[[:space:]]*resource[[:space:]]*"([^"]*)"[[:space:]]*"([^"]*)"/\2/r,Resource/
--regex-terraform=/^[[:space:]]*data[[:space:]]*"([^"]*)"[[:space:]]*"([^"]*)"/\2/d,Data/
--regex-terraform=/^[[:space:]]*variable[[:space:]]*"([^"]*)"/\1/v,Variable/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v is already defined with --kinddef-.... So you don't have to specify v,Variable. Just v is enough:

--regex-Terraform=/^[[:space:]]*variable[[:space:]]*"([^"]*)"/\1/v/

I don't know well about the syntax of Terraforms. However, I guess a whitespace may be needed after variable keyword. We don't record a variable having an empty string as name. So + is better than *.

--regex-Terraform=/^[[:space:]]*variable[[:space:]]+"([^"]+)"/\1/v/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is applicable to other lines of --regex-....

--regex-terraform=/^[[:space:]]*provider[[:space:]]*"([^"]*)"/\1/p,Provider/
--regex-terraform=/^[[:space:]]*module[[:space:]]*"([^"]*)"/\1/m,Module/
--regex-terraform=/^[[:space:]]*output[[:space:]]*"([^"]*)"/\1/o,Output/
--regex-terraform=/^([a-z0-9_]+)[[:space:]]*=/\1/f,TFVar/

1 change: 1 addition & 0 deletions win32/ctags_vs2013.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,7 @@
<ClCompile Include="..\parsers\systemdunit.c" />
<ClCompile Include="..\parsers\tcl.c" />
<ClCompile Include="..\parsers\tcloo.c" />
<ClCompile Include="..\parsers\terraform.c" />
<ClCompile Include="..\parsers\tex.c" />
<ClCompile Include="..\parsers\tex-beamer.c" />
<ClCompile Include="..\parsers\ttcn.c" />
Expand Down
3 changes: 3 additions & 0 deletions win32/ctags_vs2013.vcxproj.filters
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,9 @@
<ClCompile Include="..\parsers\tcloo.c">
<Filter>Source Files\Parsers</Filter>
</ClCompile>
<ClCompile Include="..\parsers\terraform.c">
<Filter>Source Files\Parsers</Filter>
</ClCompile>
<ClCompile Include="..\parsers\tex.c">
<Filter>Source Files\Parsers</Filter>
</ClCompile>
Expand Down