fix: clean up beta (#48)

.gitignore

@@ -1,3 +1,3 @@
 node_modules
 .idea
-logs/*
+packages/cli/lib/logs/*

README.md

@@ -1,85 +1,10 @@
 # TFVM - Terraform Version Manager
+*A NodeJS-based CLI tool to manage terraform versions without needing admin access.*
 
-### A NodeJS-based CLI tool to manage terraform versions without admin access
-
-**This currently works for windows but mac/linux compatibility is a work in progress.**
-
-**TODO: host in the BYU npm registry**
-
-## Setup
-
-### Step 1: Installation
-In order to use tfvm on windows, you must be able to run powershell scripts.
-To enable powershell scripts to run on your machine, **run the following command in a powershell window**. (You do *not* need admin access to run this command)
-```shell
-Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
-```
-
-Next, install tfvm. You will need to have node installed.
-
-**TODO: add official installation instructions after publishing to npm.** (for now, `npm i -g tfvm-windows` works)
-
-> If you frequently change versions of node and you wish to use tfvm in other node versions, you will need to re-install tfvm in this way for each version.
->
-> Fortunately, any installed terraform versions and your selected terraform version will be maintained for each node version that you switch to, as they are stored on your system and not in node's files.
-
-### Step 2: Delete existing terraform setup
-tfvm will auto-create directories and a variable in your 'Path' system environment variable for terraform setup. This will conflict with anything you already have.
-1. If you already have terraform set up on your computer, delete your entry for your terraform directory in your system path.
-2. You could leave your terraform.exe file(s), but you might as well delete them. tfvm will download its own files.
-
-### Step 3: Run tfvm for the first time
-1. Open up any command line
-2. Run any tfvm command. If you know what version you want to use first, you can run `tfvm install <that version>` and then `tfvm use <that version>`.
-   If you don't have a version in mind, you could run something like `tfvm install latest`. 
-    > You should see some lines appear saying that tfvm has automatically added a directory pointing to its terraform installation folder to your Path. This means it is working correctly
-3. Restart your terminal(s) where you want to use terraform so that your system path can be refreshed and your CLI can actually find terraform.
-   Any terminals (including those built into IDEs) that were open before you installed tfvm will have to be restarted to use the versions of terraform that tfvm install.
-   This may require you to also restart your IDE if you are using a terminal from within your IDE.
-4. In your new terminal, run `terraform --version` to verify that you are using the version of terraform that you installed with tfvm.
-
-## Usage
-Run `tfvm` in any command line, followed by one of these commands:
-- `install` or `i`: installs terraform version and sets up folder inside your tfvm folder.
-  - Ex: `tfvm install 1.0.3` or `tfvm install latest`
-- `list` or `ls`: lists all versions of terraform you have saved in your tfvm folder.
-  - Ex: `tfvm list`
-- `uninstall`: Deletes terraform executable and folder inside your tfvm folder.
-  - Ex: `tfvm uninstall 1.0.3`
-- `use` or `u`: sets specified terraform version to being the actively used version.
-  - Ex: `tfvm use 1.0.3`
-  - If you attempt to use a version that you haven't installed, you will be prompted to install it.
-- `current`: displays the terraform version you are using.
-  - Ex: `tfvm current`
-- `tfvm config <setting>=true/false`: allows the user to change tfvm settings.
-  - `tfvm config disableErrors=true` - disables configuration warnings.
-  - `tfvm config disableAWSWarnings=true` - disables AWS warnings that appear when using older terraform versions.
-  - `tfvm config disableSettingPrompts=true` - disables prompts that show how to hide some error messages.
-- `help`: prints usage information. Run `tfvm help <command>` to see information about the other tfvm commands.
-
-## FAQ
-**Q:** Why use this app instead of one of the other terrform version managers you can find?
-<br>
-**A:** It is the simplest to use for Windows and is fully cross-compatible. Most don't support windows, and those that do are unintuitive. This one is simple and works, especially for beginners to terraform.
-
-**Q:** I'm getting this error when running tfvm in powershell: `File C:\Program Files\nodejs\tfvm.ps1 cannot be loaded because running scripts is disabled on this system.`
-<br>
-**A:** Most custom CLI apps will throw this error in Powershell. Run this command to update your powershell execution policy:
-  ```shell
-  Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
-  ```
-
-**Q:** What terraform versions are supported?
-<br>
-**A:** tfvm will install and use any major version that is available in the [Hashicorp Terraform Releases archive](https://releases.hashicorp.com/terraform/).
-At this time, tfvm will not allow you to select alpha, beta, or rc releases.
-
-**Q:** I'm seeing weird behavior or errors. Where can I view tfvm's logs for debugging?
-<br>
-**A:** The logs are stored in the same directory as tfvm's other source files.
-Go to your node folder (or nvm folder, if applicable) and go to 'node_modules/tfvm-windows/logs'.
-
-> <sup>To generate more detailed logs, run tfvm with the `LOG_LEVEL` environment variable set to `debug` or `trace`.
-Alternatively, you can also use the `--log-level <level>` or `-l <level>` argument.
-The CLI argument will take precedence over the environment variable if set.</sup>
+This tool exists despite the existence of [tfswitch](https://tfswitch.warrensbox.com/) and similar tools because we
+needed a tool for managing Terraform versions on Windows that worked without needing
+Administrator-level access. For convenience, we are working on making this tool work
+for Mac and Linux as well so that our trainings and documentation can expect the user
+to use this tool instead of one of the many different tools that are available.
 
+***See [the cli package README.md file](./packages/cli/README.md) for installation, usage, and troubleshooting information:***

packages/cli/README.md

@@ -0,0 +1,82 @@
+# @byu-oit/tfvm
+
+*A NodeJS-based CLI tool to manage terraform versions without needing admin access.*
+
+**This currently works for Windows but Mac/Linux compatibility is a work-in-progress.**
+
+## Setup
+
+### Step 1: Installation
+In order to use tfvm on windows, you must be able to run powershell scripts.
+To enable powershell scripts to run on your machine, **run the following command in a powershell window**. (You do *not* need admin access to run this command)
+```shell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+```
+
+Next, install tfvm. You will need to have node installed.
+
+**TODO: add official installation instructions after publishing to npm.** (for now, `npm i -g tfvm-windows` works)
+
+> If you frequently change versions of node and you wish to use tfvm in other node versions, you will need to re-install tfvm in this way for each version.
+>
+> Fortunately, any installed terraform versions and your selected terraform version will be maintained for each node version that you switch to, as they are stored on your system and not in node's files.
+
+### Step 2: Delete existing terraform setup
+tfvm will auto-create directories and a variable in your 'Path' system environment variable for terraform setup. This will conflict with anything you already have.
+1. If you already have terraform set up on your computer, delete your entry for your terraform directory in your system path.
+2. You could leave your terraform.exe file(s), but you might as well delete them. tfvm will download its own files.
+
+### Step 3: Run tfvm for the first time
+1. Open up any command line
+2. Run any tfvm command. If you know what version you want to use first, you can run `tfvm install <that version>` and then `tfvm use <that version>`.
+   If you don't have a version in mind, you could run something like `tfvm install latest`.
+   > You should see some lines appear saying that tfvm has automatically added a directory pointing to its terraform installation folder to your Path. This means it is working correctly
+3. Restart your terminal(s) where you want to use terraform so that your system path can be refreshed and your CLI can actually find terraform.
+   Any terminals (including those built into IDEs) that were open before you installed tfvm will have to be restarted to use the versions of terraform that tfvm install.
+   This may require you to also restart your IDE if you are using a terminal from within your IDE.
+4. In your new terminal, run `terraform --version` to verify that you are using the version of terraform that you installed with tfvm.
+
+## Usage
+Run `tfvm` in any command line, followed by one of these commands:
+- `install` or `i`: installs terraform version and sets up folder inside your tfvm folder.
+    - Ex: `tfvm install 1.0.3` or `tfvm install latest`
+- `list` or `ls`: lists all versions of terraform you have saved in your tfvm folder.
+    - Ex: `tfvm list`
+- `uninstall`: Deletes terraform executable and folder inside your tfvm folder.
+    - Ex: `tfvm uninstall 1.0.3`
+- `use` or `u`: sets specified terraform version to being the actively used version.
+    - Ex: `tfvm use 1.0.3`
+    - If you attempt to use a version that you haven't installed, you will be prompted to install it.
+- `current`: displays the terraform version you are using.
+    - Ex: `tfvm current`
+- `tfvm config <setting>=true/false`: allows the user to change tfvm settings.
+    - `tfvm config disableErrors=true` - disables configuration warnings.
+    - `tfvm config disableAWSWarnings=true` - disables AWS warnings that appear when using older terraform versions.
+    - `tfvm config disableSettingPrompts=true` - disables prompts that show how to hide some error messages.
+- `help`: prints usage information. Run `tfvm help <command>` to see information about the other tfvm commands.
+
+## FAQ
+**Q:** Why use this app instead of one of the other terrform version managers you can find?
+<br>
+**A:** It is the simplest to use for Windows and is fully cross-compatible. Most don't support windows, and those that do are unintuitive. This one is simple and works, especially for beginners to terraform.
+
+**Q:** I'm getting this error when running tfvm in powershell: `File C:\Program Files\nodejs\tfvm.ps1 cannot be loaded because running scripts is disabled on this system.`
+<br>
+**A:** Most custom CLI apps will throw this error in Powershell. Run this command to update your powershell execution policy:
+  ```shell
+  Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+  ```
+
+**Q:** What terraform versions are supported?
+<br>
+**A:** tfvm will install and use any major version that is available in the [Hashicorp Terraform Releases archive](https://releases.hashicorp.com/terraform/).
+At this time, tfvm will not allow you to select alpha, beta, or rc releases.
+
+**Q:** I'm seeing weird behavior or errors. Where can I view tfvm's logs for debugging?
+<br>
+**A:** The logs are stored in the same directory as tfvm's other source files.
+Go to your node folder (or nvm folder, if applicable) and go to 'node_modules/tfvm-windows/logs'.
+
+> <sup>To generate more detailed logs, run tfvm with the `LOG_LEVEL` environment variable set to `debug` or `trace`.
+Alternatively, you can also use the `--log-level <level>` or `-l <level>` argument.
+The CLI argument will take precedence over the environment variable if set.</sup>

packages/cli/lib/util/getTFVMVersion.js

@@ -4,6 +4,6 @@ import { fileURLToPath } from 'url'
 
 export default async function () {
   const __dirname = dirname(fileURLToPath(import.meta.url))
-  const data = JSON.parse(await fs.readFile(resolve(__dirname, './../package.json'), { encoding: 'utf8' }))
+  const data = JSON.parse(await fs.readFile(resolve(__dirname, './../../package.json'), { encoding: 'utf8' }))
   return data.version
 }