You can install the Chrome extension from the store.
When the page loads the extension will try and parse the sources of your modules in your terraform file from an ssh to a clickable uri. The extension supports parsing .tf and .hcl file types. You must grant the extensions permission to have access to github. See the Devloping Locally Section
Navigate to a GitHub page where there is Terraform code and click on the extension. If no modules are found then No Moduels found will be displayed on the pop-up.
If a modules is found then a table displaying the module name and source type will be shown. The module name is a hyperlink to the github page of that module.
I would love for you to contribute to the source code and make the extension even better.
Before you submit your pull request consider the following guidelines:
- Make sure you have signed commits enabled. You can do that by following GitHubs guide here
- Please write a summary of what your change does.
- Your PR must be reviewed by one of the code owners before you can merge into main.
Clone this repository and run.
cd Github-SSH-To-URI-Chrome-Extension
yarn install
yarn build
This will generate a dist folder where the javascript is exported to.
Then open up chrome and paste chrome://extensions/ in the search bar. Once the page has loaded click Load unpacked Extension.
Navigate to the dist folder and click okay. To see the extension you must also enable dev mode.
You must also allow the Extension to have access to github found in the Site access setting on the chrome://extensions page.
Alternatively the extension will flash white in the corner when you navigate to github click the Icon to allow the extension to have access to your page.
Note you must do this each time you run yarn build and update the extension.
This project uses jest and cypress.
yarn tests
yarn cypress:run
To see cypress running instead run yarn cypress:open
- This icon was created with the assistance of DALL·E 2.
- Thanks to bec-uk for his work on hcl2-parser.