{"id":13647976,"url":"https://github.com/run-at-scale/vscode-terraform-doc-snippets","last_synced_at":"2025-04-22T06:32:35.672Z","repository":{"id":51740847,"uuid":"130663796","full_name":"run-at-scale/vscode-terraform-doc-snippets","owner":"run-at-scale","description":"Snippets in vscode for all resources and data sources, as yanked directly from provider docs.","archived":false,"fork":false,"pushed_at":"2023-07-19T01:38:56.000Z","size":5534,"stargazers_count":36,"open_issues_count":9,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-09T22:36:35.293Z","etag":null,"topics":["docs-as-code","snippets","terraform","visual-studio-code","visual-studio-code-extension","vscode"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=run-at-scale.terraform-doc-snippets","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/run-at-scale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md"}},"created_at":"2018-04-23T08:20:16.000Z","updated_at":"2024-04-10T03:28:11.000Z","dependencies_parsed_at":"2024-01-14T10:17:07.903Z","dependency_job_id":"84887132-5997-4f93-b383-a92343c386f0","html_url":"https://github.com/run-at-scale/vscode-terraform-doc-snippets","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/run-at-scale%2Fvscode-terraform-doc-snippets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/run-at-scale%2Fvscode-terraform-doc-snippets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/run-at-scale%2Fvscode-terraform-doc-snippets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/run-at-scale%2Fvscode-terraform-doc-snippets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/run-at-scale","download_url":"https://codeload.github.com/run-at-scale/vscode-terraform-doc-snippets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250183375,"owners_count":21388707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs-as-code","snippets","terraform","visual-studio-code","visual-studio-code-extension","vscode"],"created_at":"2024-08-02T01:03:52.468Z","updated_at":"2025-04-22T06:32:32.008Z","avatar_url":"https://github.com/run-at-scale.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# vscode-terraform-doc-snippets\n\n[![Version](https://vsmarketplacebadge.apphb.com/version/run-at-scale.terraform-doc-snippets.svg)](https://vsmarketplacebadge.apphb.com/version-short/run-at-scale.terraform-doc-snippets.svg)\n[![Install](https://vsmarketplacebadge.apphb.com/installs/run-at-scale.terraform-doc-snippets.svg)](https://vsmarketplacebadge.apphb.com/installs-short/run-at-scale.terraform-doc-snippets.svg)\n[![Ratings](https://vsmarketplacebadge.apphb.com/rating-short/run-at-scale.terraform-doc-snippets.svg)](https://vsmarketplacebadge.apphb.com/rating-short/run-at-scale.terraform-doc-snippets.svg)\n\n![Terraform](https://github.com/run-at-scale/vscode-terraform-doc-snippets/raw/master/assets/terraform_logo.png \"Terraform doc snippets\")\n\nA vscode extension that yanks resource and data source documentation from Terraform provider repos and transforms them into structured VS Code snippets. Over 9000 snippets included.\n\n## Demo\n\n![Demo](https://raw.githubusercontent.com/run-at-scale/vscode-terraform-doc-snippets/master/assets/demo.gif)\n\n## Motivation\n\nThe existing Terraform snippet extensions offer a set of user-defined snippets. Some of them are good but many\nlack the context to really be useful and only about 1/3 of the resources and data sources in the public providers\nare covered. Terraform documentation is largely good and continues to evolve alongside the providers so it makes sense\nto build a snippet extension that pulls snippets directly from documentation code examples. This makes for a scalable\nway to continuously provide up to date resource and data source snippets. The examples in documentation often give\nexcellent context which is important for understanding how infrastructure primitives fit together.\n\n## Getting started\n\nThe following commands are used to build the snippets file:\n\n```bash\nnvm use lts/dubnium\nnpm install ---dev\nnpm run build:snippets\n```\n\n## Features\n\n- All resources and data source snippets gathered from documentation. As docs improve, so do the snippets.\n- All snippets are delivered as a pre-compiled bundle - no dynamic lookups so your editor stays speedy.\n- Resource and data source name collisions avoided by including `data` or `resource` in each snippet prefix.\n- All providers listed in the terraform-providers organization are covered.\n- Ability to override or add additional snippets through configuration.\n\n## Known Issues\n\n- 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.\n\n## Contributing\n\nReport issues/questions/feature requests on in the [issues](https://github.com/run-at-scale/vscode-terraform-doc-snippets/issues/new) section.\n\nFull contributing [guidelines are covered here](https://github.com/run-at-scale/vscode-terraform-doc-snippets/blob/master/CONTRIBUTING.md).\n\n## Changelog\n\nThe [changelog](https://github.com/run-at-scale/vscode-terraform-doc-snippets/blob/master/CHANGELOG.md) captures all important release notes.\n\n## Authors\n\nCreated and maintained by [Brandon Bjelland](https://github.com/brandonjbjelland) - brandon@atscale.run.\n\n## License\n\nMIT Licensed. See [LICENSE](https://github.com/run-at-scale/vscode-terraform-doc-snippets/blob/master/LICENSE) for full details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frun-at-scale%2Fvscode-terraform-doc-snippets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frun-at-scale%2Fvscode-terraform-doc-snippets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frun-at-scale%2Fvscode-terraform-doc-snippets/lists"}