Comments (2)
Interesting issue. One that I came across before. The npm-ini package has a similar issue related to generating INI files (npm/ini@6a3cb38).
Their solution was to use define line endings based upon detecting of the OS, but allow the override if required.
Is that a "better" option? If you are on a Windows environment, it is pretty much a standard thing that the files will be made with CRLF, and so, having to set an option for the expected default behaviour would seem a bit odd.
As the binaries are built for different operating systems, is it acceptable to have the default value for line endings based upon the target OS?
I'm not a go expert, and so whilst this idea may be fine for npm-ini, it may not be "how things are done" in Go apps.
from terraform-docs.
That would require that everyone executing terraform-docs does so from the same OS as well as having the same vcs client configurations, right? Any contributor for my terraform project who used windows when we're on *nix or vice-versa would generate docs that flip the line endings. Plus, you can only run terraform docs --output-check as part of your CI process with one OS, so flipping between them isn't nice either. And that's not really backward compatible, since however many windows clients would suddenly start using CRLF line endings with little explanation.
from terraform-docs.
Related Issues (20)
- Asking for more maintainers HOT 4
- Discrepancies in the AWS Provider Version in README Documentation when utilizing terraform-docs between ARM and AMD Architectures HOT 3
- Make use of text/template blocks in templates for easier overriding
- Ability to add custom functions
- Remove OS-specific test cases HOT 2
- `tfvars --output-file terraform.tfvars` inserts comments which make output file invalid
- create ARM based container
- Config file from `$HOME/.tfdocs.d/` is not picked up
- Concatenate output in single file
- Auto add Changed files in pre commit hook HOT 1
- [FEATURE] Add possibility to create infrastructure summary docs in README
- Various Vulnerabilities High and Medium scores. HOT 8
- False reports that an output file was updated successfully when the file write failed
- Inconsistent behaviour for Provider version numbers when root module only calls modules. HOT 1
- zero content from terraform-docs if i run it with docker HOT 1
- releases folder with binaries missing
- docs: instructions for configuring `terraform-docs` using `ohmyzsh` shell HOT 1
- Support outputting closed ATX headers in Markdown output
- `panic: runtime error` if terraform output contains null.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from terraform-docs.