Support write to local file instead of post on github

[NikitaCOEUR]

#194

Why

I have also the requirement to obtain the results of the Terraform plan/apply parsed and nicely formatted by tfcmt. So I am trying (for the first time) to contribute to this enhancement with my proposal.
The old method is still fully functional, I have just added a new parameter "output" to specify a file to write the result to.

To use it :

Simply use it same way before but now we can do this :

plan

tfcmt --output plan.md plan -- terraform plan -no-color

apply

tfcmt --output apply.md apply-- terraform apply-no-color

---

I attempted to preserve the essence of what I saw in the code.
I hope it will be useful and accurate... Don't hesitate to provide feedback as this is my first time working with Go.

[suzuki-shunsuke]

Thank you for your contribution!

[suzuki-shunsuke]

The package name localFile isn't good.

https://go.dev/blog/package-names

They are lower case, with no under_scores or mixedCaps.

[suzuki-shunsuke]

It isn't bad to implement Notifier for local file, but I wonder if there is better approach. 🤔
Maintaining both github and local file isn't desirable.

[NikitaCOEUR]

It isn't bad to implement Notifier for local file, but I wonder if there is better approach. 🤔 Maintaining both github and local file isn't desirable.

I also wondered about it, but I wanted to reuse as much existing code as possible without having to refactor everything. In the "controller.go" file, we return "client.Notify", so I wanted to keep that intact. That's why I decided to create a new notifier. Do you have a better suggestion?

[suzuki-shunsuke]

It isn't bad to implement Notifier for local file, but I wonder if there is better approach. 🤔 Maintaining both github and local file isn't desirable.

I also wondered about it, but I wanted to reuse as much existing code as possible without having to refactor everything. In the "controller.go" file, we return "client.Notify", so I wanted to keep that intact. That's why I decided to create a new notifier. Do you have a better suggestion?

I see. Thank you for your explanation. As you said, we shouldn't change existing code as much as possible in this pull request.
We can refactor after merging this pull request.

[suzuki-shunsuke]

Please fix CI. https://github.com/suzuki-shunsuke/tfcmt/actions/runs/4174408268/jobs/7228404508

[NikitaCOEUR]

Please fix CI. https://github.com/suzuki-shunsuke/tfcmt/actions/runs/4174408268/jobs/7228404508

I'm on it.

[NikitaCOEUR]

Using underscores in package names is not allowed, so I renamed "local_file" to "tofile". I find "tofile" to be a more preferable name than "localfile". What is your opinion on this?

[suzuki-shunsuke]

I prefer localfile than tofile because localfile is more consistent with the Notifier package github.

[suzuki-shunsuke]

I'm not sure why GitHub Actions wasn't triggered. 🤔
I couldn't approve the workflow run in UI.

[NikitaCOEUR]

Uh... Maybe my force push ? I've amended a commit yesterday.

[NikitaCOEUR]

Have you try it via actions tab ?

[suzuki-shunsuke]

I added a commit, then I can approve and run.

[suzuki-shunsuke]

Thanks!

[suzuki-shunsuke]

#194 (comment)