Skip to content

Commit baf8c0c

Browse files
snippets updated to latest provider docs
1 parent 12cf087 commit baf8c0c

File tree

7 files changed

+50716
-14009
lines changed

7 files changed

+50716
-14009
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ All notable changes to this project will be documented in this file. See [standa
88
- types added
99
- placeholders for tabbing through snippet names added to each snippet
1010

11+
## [0.4.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.3.0...v0.4.0) (2019-03-27)
12+
13+
### Changed
14+
15+
- Snippets updated to match latest documentation. Now up to snippets 1719 over 81 providers
16+
1117
## [0.3.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.2.0...v0.3.0) (2018-06-26)
1218

1319
### Changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
![Terraform](https://github.com/run-at-scale/vscode-terraform-doc-snippets/raw/master/assets/terraform_logo.png "Terraform doc snippets")
88

9-
A vscode extension that yanks resource and data source documentation from Terraform provider repos and transforms them into structured VS Code snippets. Over 1600 snippets in total.
9+
A vscode extension that yanks resource and data source documentation from Terraform provider repos and transforms them into structured VS Code snippets. Over 3400 snippets in total.
1010

1111
## Demo
1212

@@ -21,6 +21,16 @@ to build a snippet extension that pulls snippets directly from documentation cod
2121
way to continuously provide up to date resource and data source snippets. The examples in documentation often give
2222
excellent context which is important for understanding how infrastructure primitives fit together.
2323

24+
## Getting started
25+
26+
The following commands are used to build the snippets file:
27+
28+
```bash
29+
nvm use lts/dubnium
30+
npm install ---dev
31+
npm run build:snippets
32+
```
33+
2434
## Features
2535

2636
- All resources and data source snippets gathered from documentation. As docs improve, so do the snippets.
@@ -32,6 +42,7 @@ excellent context which is important for understanding how infrastructure primit
3242
## Known Issues
3343

3444
- Issue #1 is probably that this is my first node project and I'm not to be trusted with the language. Help and review wanted! Tests needed.
45+
- The async nature of node means we need to provide a hard stop at the number of snippets collected before cleanup can happen. The stop-gap implementation has this count specified by hand in `config.json`. If a run of `build:snippets` produces more than the value of `total_snippets`, adjust the number up to match.
3546

3647
## Contributing
3748

0 commit comments

Comments
 (0)