Please add nomad fmt command

[nahsi]

Please provide command fmt to format nomad jobs analogous to terraform fmt and packer fmt.

Right now I'm using hclfmt from hcl repo.

To install it I use this command go install github.com/hashicorp/hcl/v2/cmd/hclfmt@latest.

[jrasell]

Hi @nahsi and thanks for raising this request. I believe this addition would be very useful!

[rounakdatta]

Hi @jrasell @mikenomitch is the nomad fmt command expected to be just a usage of hclfmt or would we like to re-implement the formatting specifically for the Nomad specification?

[danishprakash]

@jrasell I'm not entirely sure but I guess this should involve using tfexec to invoke hclfmt internally and overwrite the source file? I've seen something similar happen over at terraform-ls for terraform fmt. If that sounds like the right direction, I'd like to work on this.

[mikenomitch]

Hey @rounakdatta, yeah I think just using hclfmt would be fine!

If you base the implementation off of Packer's code, that could be a really good starting point if you'd like to contribute.

@danishprakash, I think anything that relies on TF is going to be a no-go from our perspective. While we of course love TF, we don't want that as a hard dependency for Nomad.

[danishprakash]

@mikenomitch you're right, I think I thought we could do something similar to how we do it in terraform-ls for the formatting even from the client but I now realize, as the name suggests, tfexec is in fact built for executing terraform commands. The link you shared from Packer looks more aligned and reasonable. I'd like to give this a shot if no one else has started working on this already. Thanks

[rounakdatta]

Alright @mikenomitch , I've started looking into Packer's implementation. It's clear, and I think I'll be able to make some progress tonight/tomorrow. @danishprakash I was willing to try my first Nomad contribution through this issue 🙂

[danishprakash]

Sure @rounakdatta, please feel free to take this up!

[sharmaansh21]

@rounakdatta Are you working on this ?

[shantanugadgil]

The hclfmt used to trip up if you have inline bash code for initializing default variable. Does it treat the code properly in the newest version?

I have started using the file() function more and more to avoid inline shell code.

example:

      template = <<EOF
#!/bin/bash

MY_VAR=${MY_VAR:-"0"}
...
...
EOF

}

[Trojan295]

Hello, if there is nobody working on that right now, I would like to implement the nomad fmt.

My idea is to implement it like here in hclfmt.

Do we have any requirements how the input should be passed?
My proposition it to pass the filepaths to the files, which should be formatted as arguments to the fmt, for example:

# format files
nomad fmt ./agent.hcl
nomad fmt /etc/nomad.d/nomad.hcl
nomad fmt /etc/nomad.d/nomad.hcl ./agent.hcl

# show help
nomad fmt

[mikenomitch]

Hey @Trojan295, thanks so much for taking this! This will make a lot of people happy.

I think if you try to roughly match terraform's fmt command that would be ideal.

So if you have no argument (just nomad fmt ) mean "the current directory", and then also read from STDIN with a single dash "-" argument that'd be great. To show help you would enter nomad fmt -h.

I don't think it is necessary to add the -diff flag on the initial PR.

EDIT: If there's further discussion to be had on this interface, lets have it on the PR. Should be cleaner than on this issue. :)

[tgross]

PR is open on this and likely to merge for an early Nomad 1.4.x. I'll track this issue until that's been merged. Thanks, all!

[github-actions]

I'm going to lock this issue because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.