Disabling --lockfile for terraform_docs

[nitrocode]

I'm using the latest terraform-docs 0.15.0 which adds a way to disable reading the lockfile.

Locally this works

$ terraform-docs --version
terraform-docs version v0.15.0 darwin/amd64
$ terraform-docs md --lockfile=false .

I tried setting the following

repos:
  - repo: git:/antonbabenko/pre-commit-terraform
    rev: v1.50.0
    hooks:
      - id: terraform_docs
        args: ['--lockfile=false']

When the pre-commit hook runs, I get the following error

✗ git commit -m 'test'
Terraform docs...........................................................Failed
- hook id: terraform_docs
- exit code: 1

getopt: unrecognized option '--lockfile=false'

How do I set this correctly ?

I also tried setting a .terraform.docs.yml in the root of my repo but this doesn't seem to be consumed by the pre-commit.

settings:
  lockfile: false

[antonbabenko]

Hi,

I have not tried it myself yet but you can try it like it is described for terraform_tflint:

repos:
  - repo: git:/antonbabenko/pre-commit-terraform
    rev: v1.50.0
    hooks:
      - id: terraform_docs
        args: ['--args=--lockfile=false']

[nitrocode]

Ah brilliant, that worked.

[adamantike]

@antonbabenko, should I file a separate issue to bring this option to the terraform_docs_replace hook? At the moment, whitelisting it will require some changes to the entrypoint:

$ pre-commit run --all-files terraform_docs_replace
Terraform docs (overwrite README.md).....................................Failed
- hook id: terraform_docs_replace
- exit code: 2

usage: terraform_docs_replace
       [-h]
       [--dest DEST]
       [--sort-inputs-by-required]
       [--sort-by-required]
       [--with-aggregate-type-defaults]
       [filenames ...]
terraform_docs_replace: error: unrecognized arguments: --args=--lockfile=false

[MaxymVlasov]

terraform_docs_replace is deprecated and its functional will be moved to terraform_docs in the next few months

See #248

[adamantike]

Thanks for the heads up. As soon as I went deeper on why this argument wasn't working for terraform_docs_replace, it was evident that many other flags from terraform-docs shouldn't be working right now, so I'm glad the idea to reduce complexity is being considered!