stotem/README.md

This tool aims to simplify setting up local reproduction environments for writing and testing Sentinel policies.

At present, navigate to your sentinel policy directory (containing the .hcl) and run `main.js` there.

## Build instructions:
### TODO: Remediate required double install. Probably because I'm using `nvm`
### TODO: Fix uninstall
### TODO: Check for dependencies of dependencies. For instance, `aws-functions` requires `tfconfig`
### TODO: Check for duplicates in `sentinel.hcl`. If duplicates are written, sentinel won't run.

Clone the directory locally, then navigate to that directory and run `npm install`.
Next, run `npm run build`
Finally, run `npm install -g` if you want `stotem` in your path

## Current functionality:

Checks the CURRENT DIRECTORY recursively(via vsCode's [ripgrep package](https://github.com/microsoft/vscode-ripgrep)) 
for references to the Hashicorp Sentinel [governance repo](https://github.com/hashicorp/terraform-sentinel-policies) helper functions and 
adds them as http imports to sentinel.hcl if found.

## Planned functionality:

WORKING TESTS

Check for v1 imports and print a warning if they're in use

Provide a command line flag to show what values will be `after_unknown`

TBD:
Considering whether an offline/local mode is worth implementing. This would work by replacing the https heredocs with local copies of repo functions included with an 
npm tarball (or just include it directly in this package)