Skip to content

Commit edb931c

Browse files
added demo gif
1 parent 7d61651 commit edb931c

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,23 @@
88

99
A vscode extension that yanks resource and data source documentation from Terraform provider repos and transforms them into structured vscode snippets - 1452 snippets in total!
1010

11+
## Demo
12+
13+
![Demo](https://raw.githubusercontent.com/run-at-scale/vscode-terraform-doc-snippets/master/assets/demo.gif)
14+
15+
## Motivation
16+
17+
The existing Terraform snippet extensions offer a set of user-defined snippets. Some of them are good but many
18+
lack the context to really be useful and only about 1/3 of the resources and data sources in the public providers
19+
are covered. Terraform documentation is largely good and continues to evolve alongside the providers so it makes sense
20+
to build a snippet extension that pulls snippets directly from documentation code examples. This makes for a scalable
21+
way to continuously provide up to date resource and data source snippets. The examples in documentation often give
22+
excellent context which is important for understanding how infrastructure primitives fit together.
23+
1124
## Features
1225

1326
* All resources and data source snippets gathered from documentation. As docs improve, so do the snippets.
14-
* All snippets are delivered as a precompiled bundle - your editor stays speedy.
27+
* All snippets are delivered as a precompiled bundle - no dynamic lookups so your editor stays speedy.
1528
* Resource and data source name collisions avoided by including `data` or `resource` in each snippet prefix.
1629
* All providers listed in the terraform-providers organization are covered.
1730

assets/demo.gif

3.8 MB
Loading

package.json

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"name": "terraform-doc-snippets",
33
"displayName": "Terraform doc snippets",
4-
"description": "Get Terraform code snippets from provider documentation for all resources and data sources. All providers soon to be covered!",
4+
"description":
5+
"Terraform code snippets (>1400) straight from documentation for all provider resources and data sources. All providers in the terraform-providers org covered.",
56
"version": "0.1.4",
67
"icon": "assets/terraform_logo.png",
78
"publisher": "run-at-scale",
@@ -14,9 +15,7 @@
1415
"email": "brandon@atscale.run",
1516
"url": "https://github.com/run-at-scale"
1617
},
17-
"categories": [
18-
"Snippets"
19-
],
18+
"categories": ["Snippets"],
2019
"keywords": [
2120
"Terraform",
2221
"devops",
@@ -42,19 +41,15 @@
4241
"test": "npm run compile && node ./node_modules/vscode/bin/test",
4342
"postinstall": "node ./node_modules/vscode/bin/install",
4443
"build:snippets": "ts-node ./src/main.ts",
45-
"build:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -a",
4644
"publish:vsce": "vsce publish",
4745
"release": "standard-version"
4846
},
4947
"devDependencies": {
5048
"@types/fs-extra": "^5.0.2",
51-
"@types/lockfile": "^1.0.0",
5249
"@types/tmp": "0.0.33",
5350
"@types/underscore": "^1.8.8",
5451
"@types/mocha": "^2.2.42",
5552
"@types/node": "^7.0.43",
56-
"conventional-changelog": "^1.1.24",
57-
"conventional-github-releaser": "^2.0.2",
5853
"eslint": "^4.19.1",
5954
"standard-version": "^4.3.0",
6055
"tslint": "^5.9.1",

0 commit comments

Comments
 (0)