github/pre-commit-opentofu
1
0
Fork 1
mirror of https://github.com/tofuutils/pre-commit-opentofu.git synced 2025-10-15 17:38:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat: spport .tofu files (#6)

Browse source 
Signed-off-by: T. Hinrichsmeyer <t.hinrichsmeyer@ndr.de>
This commit is contained in:
T. Hinrichsmeyer 2024-10-02 15:05:21 +02:00
commit e059c5859b
No known key found for this signature in database
GPG key ID: 984B6DEB69D24B71
4 changed files with 53 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

41
hooks/tofu_docs_replace.py
View file

@ -7,30 +7,41 @@ import sys
def main(argv=None):
parser = argparse.ArgumentParser(
description="""Run terraform-docs on a set of files. Follows the standard convention of
pulling the documentation from main.tf in order to replace the entire
pulling the documentation from main.(tf|tofu) in order to replace the entire
README.md file each time."""
)
parser.add_argument(
'--dest', dest='dest', default='README.md',
"--dest",
dest="dest",
default="README.md",
)
parser.add_argument(
'--sort-inputs-by-required', dest='sort', action='store_true',
help='[deprecated] use --sort-by-required instead',
"--sort-inputs-by-required",
dest="sort",
action="store_true",
help="[deprecated] use --sort-by-required instead",
)
parser.add_argument(
'--sort-by-required', dest='sort', action='store_true',
"--sort-by-required",
dest="sort",
action="store_true",
)
parser.add_argument(
'--with-aggregate-type-defaults', dest='aggregate', action='store_true',
help='[deprecated]',
"--with-aggregate-type-defaults",
dest="aggregate",
action="store_true",
help="[deprecated]",
)
parser.add_argument('filenames', nargs='*', help='Filenames to check.')
parser.add_argument("filenames", nargs="*", help="Filenames to check.")
args = parser.parse_args(argv)
dirs = []
for filename in args.filenames:
if (os.path.realpath(filename) not in dirs and
(filename.endswith(".tf") or filename.endswith(".tfvars"))):
if os.path.realpath(filename) not in dirs and (
filename.endswith(".tf")
or filename.endswith(".tofu")
or filename.endswith(".tfvars")
):
dirs.append(os.path.dirname(filename))
retval = 0
@ -38,12 +49,12 @@ def main(argv=None):
for dir in dirs:
try:
procArgs = []
procArgs.append('terraform-docs')
procArgs.append("terraform-docs")
if args.sort:
procArgs.append('--sort-by-required')
procArgs.append('md')
procArgs.append("--sort-by-required")
procArgs.append("md")
procArgs.append("./{dir}".format(dir=dir))
procArgs.append('>')
procArgs.append(">")
procArgs.append("./{dir}/{dest}".format(dir=dir, dest=args.dest))
subprocess.check_call(" ".join(procArgs), shell=True)
except subprocess.CalledProcessError as e:
@ -52,5 +63,5 @@ def main(argv=None):
return retval
if __name__ == '__main__':
if __name__ == "__main__":
sys.exit(main())