122 Commits

Author SHA1 Message Date
Martin Etmajer
d8cdb4c07c Add teaser image. 2018-12-02 20:22:13 +01:00
Martin Etmajer
a5a6cd775a Initial commit. 2018-12-02 19:47:29 +01:00
Martin Etmajer
4ef44f28a5 Purge History.md file. 2018-12-02 15:47:32 +01:00
Khosrow Moossavi
6534330b66 Add support for rendering Markdown documents (#81)
* Add support for rendering Markdown content

* Change --markdown-table and --markdown-document flags to corresponding subcommands

* Use import aliases for 'markdown' packages

* Keep functions in alphabetic order

* Remove redundant 'showDefault' variable

* Prettify list and map for 'markdown document' view

* Rename package from 'content' to 'document'

* Fix some wording in README and Usage text

* Improve documentation.

* Improve wording around inputs and outputs.

* Improve code readability and maintainability.

* Rename misnamed function 'printMarkdown' to 'printInput'.

* Remove remark 'optional' from markdown types documentation.

* Refactor fenced code block generation.

* Add JSON language specifier to fenced code block generation.

* Add Markdown document sanitising to soothe linters.

* Minor code beautification.

* Fix gometalinter error
2018-12-02 09:22:57 +01:00
Martin Etmajer
6794a4e1c9 Migrate from github.com/tj/docopt to github.com/docopt/docopt-go (#91) 2018-11-19 20:41:22 +01:00
Khosrow Moossavi
dce8ff77bd Fix authors target in Makefile to get 'Author''s email not 'Committer' (#90) 2018-11-17 20:37:20 +01:00
Martin Etmajer
c4fd0e7bad Add requirement to discuss suitability of a new feature in an issue before submitting a pull request. 2018-11-16 09:30:54 +01:00
Martin Etmajer
97115d8f0b Bump version to 0.5.0. v0.5.0 2018-10-24 18:51:41 +02:00
Stuart Auld
c22e40fbd3 Add support to print Markdown files with underscored variable names escaped (#48) (#63) 2018-10-24 12:36:25 +02:00
Martin Etmajer
c94a100ef1 Add CircleCI badge. 2018-10-10 19:41:04 +02:00
Martin Etmajer
86940f04bd Fix homebrew formula. (#75) 2018-10-09 21:25:20 +02:00
Stuart Auld
0b468e30db Add sort by "required" and then name (#43) 2018-10-09 10:29:09 +02:00
Martin Etmajer
9422d09f73 Add Homebrew formula. (#68) 2018-10-07 23:11:17 +02:00
Martin Etmajer
f695146f1f Bump version to 0.4.5. v0.4.5 2018-10-07 22:58:35 +02:00
beatcracker
c741028408 Allow unquoted item names. Fixes #64 (#70) 2018-10-06 23:36:32 +02:00
Martin Etmajer
ba1154317b Change build dir structure (#74) 2018-10-06 23:19:45 +02:00
Simon Heather
48fdfb5798 Update makefile to fix Windows build filename (#72) 2018-10-03 16:51:20 +02:00
Simon Heather
17842ab9be Remove extra newlines between comments and inputs/outputs to fix MarkDownLint warnings (#66)
* Remove extra blank lines between Comments and Inputs/Outputs

* Update markdown testdata to remove extra blank lines

* Move HasInputs check

* Remove spurious blank line from main.tf example

* Test Commit

* Test commit reversal

* Remove spurious blank line from main.tf

* Fix doc_test.go to remove expected spurious blank lines

* Remove spurious blank lines from json and pretty tests
2018-10-03 15:00:08 +02:00
Simon Heather
cffbab4b21 Fix loading of comments from main.tf on Windows (#65) 2018-09-26 13:39:18 +02:00
Martin Etmajer
13fe912dd5 Bump version to 0.4.0. v0.4.0 2018-09-23 16:31:57 +02:00
Martin Etmajer
721386d799 Add option --with-aggregate-type-defaults to enable printing of default values for types 'list' and 'map'. (#53) 2018-09-23 14:47:00 +02:00
Martin Etmajer
5584170a2c Add option --no-sort to omit sorted rendering of inputs and outputs. (#61) 2018-09-23 00:14:45 +02:00
Martin Etmajer
853dd8fd63 Refactor package 'doc' for better modularity. (#60) 2018-09-22 21:59:19 +02:00
Martin Etmajer
a1c7308818 Refactor package 'print' for better modularity. (#59) 2018-09-22 19:37:21 +02:00
Martin Etmajer
66f8584b43 Complete CircleCI config. Add vendor directory. (#58) 2018-09-21 09:06:32 +02:00
Martin Etmajer
a08729ad67 Update AUTHORS. 2018-09-21 08:54:27 +02:00
Martin Etmajer
181656cbaf Add issue and pull request templates. 2018-09-21 08:49:52 +02:00
Martin Etmajer
60e001af09 Add contributing guidelines. 2018-09-21 08:49:52 +02:00
Martin Etmajer
62ee720ccd Fix indentation. 2018-09-21 08:49:52 +02:00
Martin Etmajer
f0ef879cb4 Update documentation and license to reflect the terraform-docs authors. 2018-09-21 08:49:52 +02:00
Martin Etmajer
8c87c818a2 Update documentation. 2018-09-21 08:49:52 +02:00
Martin Etmajer
988d897a9e Move packages 'doc' and 'print' to internal/pkg. 2018-09-21 08:49:52 +02:00
Martin Etmajer
7c67f1bea0 Add automated tests for package 'print'. 2018-09-21 08:49:52 +02:00
Martin Etmajer
bb6701c0f8 Add automated tests for package 'doc'. 2018-09-21 08:49:52 +02:00
Martin Etmajer
01e5dbc713 Refactor code in main and prepare for tests. 2018-09-21 08:49:52 +02:00
Martin Etmajer
8b165a08a1 Add documentation of --version option. 2018-09-21 08:49:52 +02:00
Martin Etmajer
49dc93e4e9 Add make target to run Go tests. 2018-09-21 08:49:52 +02:00
Martin Etmajer
b443a57db5 Add make target to create and push a Git tag. 2018-09-21 08:49:52 +02:00
Martin Etmajer
f57075e259 Add make target to check Go sources for errors and warnings. Remove unused code. 2018-09-21 08:49:52 +02:00
Martin Etmajer
e02d50084a Add make target to create AUTHORS file from git logs. 2018-09-21 08:49:52 +02:00
Martin Etmajer
73db535cc6 Add make target to clean the workspace. 2018-09-21 08:49:52 +02:00
Martin Etmajer
f9d040ce56 Add dependency management using go deps. 2018-09-21 08:49:52 +02:00
Martin Etmajer
9caa5ecaae Add Makefile header and build target. 2018-09-21 08:49:52 +02:00
John Boggs
c5591f0c44 Add base CI config (#56) 2018-09-18 16:50:43 -07:00
John Boggs
4dff43eaa1 Add Maintenance section to Readme (#55)
* Add Maintenance section to Readme
2018-09-11 12:43:46 -07:00
John Boggs
7110697c09 Update Readme.md 2018-07-26 11:04:32 -07:00
Amir Abu Shareb
0592711269 Merge pull request #44 from coveo/description-before-comments
If there is a description on an output, it should be considered before the preceding comment
2017-12-21 13:31:24 +02:00
Jocelyn Giroux
ff8ae0febe If there is a description on an output, it should be considered before the preceding comment 2017-12-21 06:03:01 -05:00
Amir Abushareb
fd823bda37 Release v0.3.0 v0.3.0 2017-10-22 17:11:06 +03:00
Amir Abushareb
06a3445967 auto version 2017-10-22 17:10:10 +03:00