Merge pull request #23 from run-at-scale/feat/orrin-update

Feat: support for non-standard docs paths, removal of hardcoded snippet cap, snippets generated

Author: brandonjbjelland

AUTHORS.md

@@ -7,6 +7,7 @@ If you are submitting a change, please add your name or the name of the organiza
 ## Humans
 
 * [Brandon Bjelland](https://github.com/brandonjbjelland) \<brandon at atscale.run\>
+* [Orrin Fiandaca](https://github.com/orrin) \<ofiandaca at gmail.com\>
 
 ## Organizations
 

CHANGELOG.md

@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## Future
 
-- tests added
-- types added
-- placeholders for tabbing through snippet names added to each snippet
+- tests
+- ts types
+- auto-tabbing through common parts of snippets (name of core resource, etc.)
+- configurable override of doc paths per provider repo (see: doc_root_path_overrides).
+
+## [0.6.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.5.0...v0.6.0) (2021-03-04)
+
+### Changed
+
+- pulling 125 providers (all official or partner tier) from the registry and shipping 9341 snippets
+- refactored the core workflow to remove the need for the hard-coded number of total snippets (thanks, @orrin!)
+- regression: dropped async checkout/download of repos, making the snippet generation process a lot longer. Will fix in subsequent releases - this doesn't affect extension users, only snippet generators (devs working on this project).
+- created to specify docs in non-standard paths.
 
 ## [0.5.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.4.0...v0.5.0) (2021-03-01)
 
@@ -20,7 +30,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Changed
 
-- Snippets updated to match latest documentation. Now up to snippets 1719 over 81 providers
+- Snippets updated to match latest documentation. Now up to snippets 1719 over 81 providers.
 
 ## [0.3.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.2.0...v0.3.0) (2018-06-26)
 
@@ -30,9 +40,9 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## [0.2.0](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.1.5...v0.2.0) (2018-05-10)
 
-- override and extra snippets now added through config
-- deprecated resources and data sources manually added for their successor
-- snippets file rebuilt and now has 1491 pulled from docs + a few custom snippets
+- override and extra/common snippets now added through config.
+- deprecated resources and data sources manually added for their successor.
+- snippets file rebuilt totalling 1491.
 
 ## [0.1.5](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.1.4...v0.1.5) (2018-05-04)
 
@@ -41,7 +51,7 @@ All notable changes to this project will be documented in this file. See [standa
 ## [0.1.4](https://github.com/run-at-scale/vscode-terraform-doc-snippets/compare/v0.1.3...v0.1.4) (2018-05-04)
 
 - provider repos now scanned from the terraform-providers organization.
-- snippets added to 1452.
+- snippets total 1452.
 - formatting and beautifying ✨
 - added error handling for missing absent examples.
 

README.md

@@ -6,7 +6,7 @@
 
 ![Terraform](https://github.com/run-at-scale/vscode-terraform-doc-snippets/raw/master/assets/terraform_logo.png "Terraform doc snippets")
 
-A vscode extension that yanks resource and data source documentation from Terraform provider repos and transforms them into structured VS Code snippets. Over 8000 snippets in total.
+A 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.
 
 ## Demo
 
@@ -42,7 +42,6 @@ npm run build:snippets
 ## Known Issues
 
 - 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.
-- 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.
 
 ## Contributing
 

package-lock.json

@@ -1,8 +1,8 @@
 {
   "name": "terraform-doc-snippets",
   "displayName": "Terraform doc snippets",
-  "description": "Terraform code snippets (>5000) straight from documentation for all provider resources and data sources. All providers in the public terraform registry covered.",
-  "version": "0.5.0",
+  "description": "Terraform code snippets (>8000) pulled from examples in the terraform registry provider docs. resources and data sources. All official and partner providers are scraped for examples.",
+  "version": "0.6.0",
   "icon": "assets/terraform_logo.png",
   "publisher": "run-at-scale",
   "license": "MIT",
@@ -63,8 +63,8 @@
     "@octokit/rest": "^15.2.7",
     "async": "^2.6.0",
     "gfm-code-blocks": "^1.0.0",
+    "node-fetch": "^2.6.1",
     "nodegit": "^0.26.1",
-    "request": "^2.88.2",
     "tmp": "0.0.33",
     "underscore": "^1.9.0"
   }