tfv 3.2.2 → 3.2.4

package/README.md

@@ -1,4 +1,5 @@
-### Use `tfv` to manage multiple versions of terraform with ease.
+# Use `tfv` to manage multiple versions of terraform with ease
+
          _        ________        __
        _| |__   / _____|\ \      / /
       |_  ___\ | |___    \ \    / /
@@ -10,14 +11,49 @@
   ---------------------------------------
 
 ## Installation
+
 > **_NOTE:_** `tfv` should be installed `globally` so that it can be run from anywhere on your computer.
+
 ```sh
 npm install -g tfv
 ```
-or
+
+Run with alias
+
 ```sh
 npm i -g tfv
 ```
+
+## Help
+
+```sh
+tfv --help
+```
+
+Run with alias
+
+```sh
+tfv -h
+```
+
+> **_OUTPUT:_**
+
+```
+tfv <command>
+
+Commands:
+  tfv install <version>  Example: tfv install 1.0.11                [aliases: i]
+  tfv list [option]      Example: tfv list --local                 [aliases: ls]
+  tfv remove <version>   Example: tfv rm 1.0.11                    [aliases: rm]
+  tfv auto-switch        Example: tfv as                           [aliases: as]
+  tfv use <version>      Example: tfv use 1.0.11
+
+Options:
+  -h, --help     Show help                                             [boolean]
+  -v, --version  Show version number                                   [boolean]
+```
+
+
 # Table of Contents
 
 <!--ts-->
@@ -27,22 +63,28 @@ npm i -g tfv
       * [install](#install)
       * [use](#use)
       * [list](#list)
+      * [remove](#remove)
+      * [auto-switch](#auto-switch)
 <!--te-->
 
 ## Usage
 
-https://user-images.githubusercontent.com/25563661/142188036-4f2a8b65-1a3e-4298-95e0-9ed533c66a18.mp4
+https://user-images.githubusercontent.com/25563661/209584148-05a86ee1-f497-4c6d-9894-d9cb464ef5b8.mp4
 
 ### Modules
 
-#### *install*
+- #### _INSTALL_
+
 ```sh
 tfv install <version>
 ```
-or
+
+Run with alias
+
 ```sh
 tfv i <version>
 ```
+
 | Version          | Description                                |
 | ---------------- | ------------------------------------------ |
 | x.x.x            | Installs terraform version x.x.x           |
@@ -50,7 +92,8 @@ tfv i <version>
 | x.x.^            | Installs latest version of release x.x     |
 | latest           | Installs latest version of terraform       |
 
-#### *use*
+- #### _USE_
+
 ```sh
 tfv use <version>
 ```
@@ -62,16 +105,52 @@ tfv use <version>
 
 > **_NOTE:_** If you're using windows OS, you would be prompted for admin privilege. Accept it. This is a one-time request to set terraform location in you system path. Unix machines would also get password prompt, as this requires permission to copy terraform to your bin directory.
 
-#### *list*
+- #### _LIST_
+
 ```sh
 tfv list [option]
 ```
-or
+
+Run with alias
+
 ```sh
 tfv ls [option]
 ```
-| Option         | Option Alias  |                Description                                             |
-| ---------------|---------------|----------------------------------------------------------------------- |
-| `--local`      |  `-l`         |  Lists all terraform versions installed locally                        |
-| `--remote`     |  `-r`         |  Lists all terraform versions available remotely, on terraform server  |
-|                |               |  Defaults to listing terraform versions installed locally              |
+
+| Option         | Option Alias  |                Description                                                     |
+| ---------------|---------------|--------------------------------------------------------------------------------|
+|                |               |  Defaults to listing terraform versions installed locally (in tfv store)       |
+| `--local`      |  `-l`         |  Lists all terraform versions installed locally                                |
+| `--remote`     |  `-r`         |  Lists all terraform versions available remotely, on terraform server          |
+
+- #### _REMOVE_
+
+```sh
+  tfv remove <version>
+```
+
+Run with alias
+
+```sh
+  tfv rm <version>
+```
+
+| Version          | Description                               |
+| ---------------- | ----------------------------------------- |
+| x.x.x            | remove terraform version x.x.x            |
+
+- #### _AUTO-SWITCH_
+
+```sh
+  tfv auto-switch
+```
+
+Run with alias
+
+```sh
+  tfv as
+```
+
+| Description                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------- |
+| auto-detects your project terraform version, downloads it if it's not in tfv store, and switch to the version     |

package/index.js

@@ -6,6 +6,7 @@ const {join} = require('path')
 yargs
 	.commandDir(join(__dirname, 'lib', 'commands'))
 	.alias('help', 'h')
+	.alias('version', 'v')
 	.scriptName('tfv')
 	.demandCommand(1, 'You need at least one command before moving on')
 	.strictOptions()

package/lib/commands/install.js

@@ -2,8 +2,6 @@
 
 const yargs = require('yargs');
 const {install} = require('../modules/install');
-const {fetchAllVersions} = require('../modules/remote');
-const {P_END, P_ERROR, P_OK} = require('../utils/colors');
 
 exports.command = 'install <version>'
 exports.aliases = ['i']
@@ -11,33 +9,13 @@ exports.desc = 'Example: tfv install 1.0.11'
 exports.builder = {
   'verbose': {
     describe: 'Produce detailed output',
-    alias: 'v'
+    alias: 'v',
+    type: 'boolean',
   }
 }
 
 exports.handler = async () => {
-  let [,version] = yargs.argv._;
-  const result = await fetchAllVersions();
-
-  if (version === 'latest') {
-    [version] = result.filter(v => {
-      const [, inTest] = v.split('-');
-      if (!inTest) return v;
-    });
-  }
-
-  if (`${version}`.endsWith('^')) {
-    [version] = result.filter(v => {
-      const [, inTest] = v.split('-');
-      if (v.startsWith(version.replace('^', '')) && !inTest) return v
-    });
-  }
-
-  if (!result.find(v => v === version)) {
-    console.log(`${P_ERROR}Terraform ${version} not found.${P_END}`);
-    console.log(`To view a list of available version, run ${P_OK}tfv list --remote${P_END}`);
-    process.exit(1);
-  }
+  const [,version] = yargs.argv._;
 
   await install(version);
 }

package/lib/commands/remove.js

@@ -5,16 +5,17 @@ const {remove} = require('../modules/remove');
 
 exports.command = 'remove <version>'
 exports.aliases = ['rm']
-exports.desc = 'Example: tfv rm <version>'
+exports.desc = 'Example: tfv rm 1.0.11'
 exports.builder = {
   'verbose': {
     describe: 'Produce detailed output',
-    alias: 'v'
+    alias: 'v',
+    type: 'boolean',
   }
 }
 
 exports.handler = async () => {
-  let [,version] = yargs.argv._;
+  const [,version] = yargs.argv._;
 
   await remove(version);
 }

package/lib/commands/switch.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const {autoSwitch} = require('../modules/switch');
+
+exports.command = 'auto-switch'
+exports.aliases = ['as']
+exports.desc = 'Example: tfv as'
+exports.builder = {
+  'verbose': {
+    describe: 'Produce detailed output',
+    alias: 'v',
+    type: 'boolean'
+  }
+}
+
+exports.handler = async () => {
+  await autoSwitch();
+}

package/lib/commands/use.js

@@ -1,27 +1,20 @@
 'use strict'
 
 const yargs = require('yargs');
-const {existsSync} = require('fs');
-const {join} = require('path');
 const {use} = require('../modules/use');
-const {P_ERROR, P_END, P_OK} = require('../utils/colors');
 
 exports.command = 'use <version>'
 exports.desc = 'Example: tfv use 1.0.11'
 exports.builder = {
   verbose: {
     alias: 'v',
-    describe: 'Produce detailed output'
+    describe: 'Produce detailed output',
+    type: 'boolean',
   }
 }
 
 exports.handler = async () => {
   const [,version] = yargs.argv._;
 
-  if (!existsSync(join(__dirname, '../../', 'store'))) {
-    console.log(`${P_ERROR}You're yet to install terraform with tfv${P_END}`);
-    return console.log(`For guidance, run ${P_OK}tfv -h${P_END}`);
-  }
-
   await use(version);
 }

package/lib/modules/install.js

@@ -4,11 +4,38 @@ const fs = require('fs');
 const {join} = require('path');
 const {arch} = process;
 const unzip = require('decompress');
+const {fetchAllVersions} = require('./remote');
+const {formatVersions} = require('../utils/formatVersions');
 const {P_END, P_ERROR, P_INFO, P_OK, P_WARN} = require('../utils/colors');
 
-exports.install = async (version) => {
+exports.install = async (installVersion) => {
   try {
+    let version = installVersion;
     const store = join(__dirname, '../..', 'store');
+    const data = await fetchAllVersions();
+    const result = formatVersions(data);
+
+    if (version === 'latest') {
+      [version] = result.filter(v => {
+        const [, inTest] = v.split('-');
+        if (!inTest) return v;
+      });
+    }
+
+    if (`${version}`.endsWith('^')) {
+      [version] = result.filter(v => {
+        const [, inTest] = v.split('-');
+        if (v.startsWith(version.replace('^', '')) && !inTest) return v
+      });
+      version = version ? version : installVersion.replace('^', '');
+    }
+
+    if (!result.find(v => v === version)) {
+      console.log(`${P_ERROR}Terraform ${version} not found.${P_END}`);
+      console.log(`To view a list of available version, run ${P_OK}tfv list --remote${P_END}`);
+      process.exit(1);
+    }
+
     const fileName = join(__dirname, '../..', `${version}.zip`);
     const getVersion = os.platform() === 'win32' ? `${version}.exe` : version;
 
@@ -20,38 +47,12 @@ exports.install = async (version) => {
     const sysOs = os.platform() === 'win32' ? 'windows' : os.platform();
     let sysArch = arch === 'x64' ? 'amd64' : arch;
 
-    // if (os.platform() === 'darwin') {
-    //   sysArch = 'amd64'
-    // }
+    if (os.platform() === 'darwin' && version.startsWith('0')) {
+      sysArch = 'amd64'
+    }
 
     const url = `https://releases.hashicorp.com/terraform/${version}/terraform_${version}_${sysOs}_${sysArch}.zip`;
 
-    const req = https.get(url, (res) => {
-      console.log(`${P_INFO}Installing terraform ${version}${P_END}`);
-
-      const fileStream = fs.createWriteStream(fileName);
-      res.pipe(fileStream);
-
-      fileStream.on('error', (err) => {
-        console.log(`${P_ERROR}Error writing stream ${P_END}\n`, err);
-      });
-
-      fileStream.on('close', async () => {
-        await clean(version);
-        makeExecutable(version);
-      });
-
-      fileStream.on('finish', () => {
-        fileStream.close();
-        console.log(`${P_OK}Successful!${P_END}`);
-        console.log(`To use this version Run: ${P_OK}tfv use ${version}${P_END}`);
-      })
-    });
-
-    req.on('error', (err) => {
-      console.log(`${P_ERROR}Error downloading the terraform ${version}${P_END}\n`, err)
-    });
-
     const clean = async (version) => {
       if (fs.existsSync(fileName)) {
         await unzip(fileName, store, {
@@ -71,6 +72,36 @@ exports.install = async (version) => {
         fs.chmodSync(`${store}/${version}`, '755');
       }
     }
+
+    return new Promise((resolve, reject) => {
+      const req = https.get(url, (res) => {
+        console.log(`${P_INFO}Installing terraform ${version}${P_END}`);
+
+        const fileStream = fs.createWriteStream(fileName);
+        res.pipe(fileStream);
+
+        fileStream.on('error', (err) => {
+          console.log(`${P_ERROR}Error writing stream ${P_END}\n`, err);
+        });
+
+        fileStream.on('close', async () => {
+          await clean(version);
+          await makeExecutable(version);
+          resolve(version);
+        });
+
+        fileStream.on('finish', () => {
+          fileStream.close();
+          console.log(`${P_OK}Successful!${P_END}`);
+          console.log(`To use this version Run: ${P_OK}tfv use ${version}${P_END}`);
+        })
+      });
+
+      req.on('error', (err) => {
+        reject(console.log(`${P_ERROR}Error downloading the terraform ${version}${P_END}\n`, err))
+      });
+    });
+
   } catch ({message}) {
     console.log('ERROR:', message)
   }

package/lib/modules/list.js

@@ -2,7 +2,9 @@ const fs = require('fs');
 const {join} = require('path');
 const {spawnSync} = require('child_process')
 const {fetchAllVersions} = require('./remote');
-const {P_END, P_OK, P_ERROR} = require('../utils/colors');
+const {formatVersions} = require('../utils/formatVersions');
+const {P_END, P_OK} = require('../utils/colors');
+const {checkStore} = require('../utils/store');
 
 exports.list = async (local, remote) => {
   try {
@@ -14,7 +16,8 @@ exports.list = async (local, remote) => {
     }
 
     if (remote) {
-      versions = await fetchAllVersions();
+      const data = await fetchAllVersions();
+      versions = formatVersions(data);
 
       return result('List of all available terraform versions', versions)
     }
@@ -22,19 +25,16 @@ exports.list = async (local, remote) => {
     if (local) {
       const store = join(__dirname, '../..', 'store');
 
-      if (!fs.existsSync(store)) {
-        console.log(`${P_ERROR}You're yet to install terraform with tfv${P_END}`);
-        return console.log(`For guidance, run ${P_OK}tfv -h${P_END}`);
-      }
+      checkStore(store);
 
       const tfVersion = spawnSync('terraform', ['version'], {stdio: 'pipe', encoding: 'utf-8'});
-      const pattern = /v\d\..*\d/;
-      const [activeVersion] = tfVersion.stdout.match(pattern);
+      const pattern = /v\d+\.\d+\.\d+/;
+      const versionOutput = tfVersion.stdout.match(pattern);
 
       versions = fs.readdirSync(store).map(f => {
         const versionNumber = f.replace('.exe', '');
 
-        if (versionNumber === activeVersion.replace('v', '')) return `${P_OK}*${P_END}${versionNumber}`;
+        if (versionOutput && versionNumber === versionOutput[0].replace('v', '')) return `${versionNumber} 🚀`;
         else return versionNumber;
       });
 

package/lib/modules/remote.js

@@ -1,29 +1,18 @@
-const client = require('https');
+const https = require('https');
 
-const getAvailableVersions = (url) => {
-	return new Promise((resolve, reject) => {
-		client.get(url, (resp) => {
-			let data = '';
-
-			// A chunk of data has been received.
-			resp.on('data', (chunk) => {
-				data += chunk;
-			});
+exports.fetchAllVersions = async () => {
+	try {
+		return new Promise((resolve, reject) => {
+			https.get('https://releases.hashicorp.com/terraform/', (resp) => {
+				let data = '';
 
-			// The whole response has been received. Print out the result.
-			resp.on('end', () => {
-				resolve(data);
+				resp.on('data', (chunk) => data += chunk);
+				resp.on('end', () => resolve(data));
+			}).on("error", (err) => {
+					reject(err);
 			});
-		}).on("error", (err) => {
-				reject(err);
 		});
-	});
-};
-
-exports.fetchAllVersions = async () => {
-	const content = await getAvailableVersions('https://releases.hashicorp.com/terraform/');
-	const pattern = /(>terraform_).*(?=<\/a>)/g;
-	const versions = content.match(pattern).map(v => v.replace('>terraform_', ''));
-
-	return versions;
+	} catch ({message}) {
+		console.log('ERROR:', message);
+	}
 };

package/lib/modules/switch.js

@@ -0,0 +1,60 @@
+const fs = require('fs');
+const {join} = require('path');
+const {use} = require('./use');
+const {install} = require('./install');
+const {P_END, P_ERROR, P_INFO} = require('../utils/colors');
+const {checkStore} = require('../utils/store');
+
+exports.autoSwitch = async () => {
+  try {
+    let versionFile;
+    let tfVersion;
+    const tfState = `terraform.tfstate`;
+
+    if (fs.existsSync(tfState)) {
+      versionFile = tfState;
+      tfVersion = JSON.parse(fs.readFileSync(tfState, 'utf-8'))['terraform_version'];
+    } else {
+      const getAllFiles = fs.readdirSync(process.cwd());
+      const likelyVersionFiles = ['main.tf', 'provider.tf', 'providers.tf', 'versions.tf', 'version.tf', 'backend.tf', 'terraform.tf'];
+      const existingFiles = getAllFiles.filter(f => likelyVersionFiles.indexOf(f) !== -1);
+      const checkVersionIn = existingFiles.concat(getAllFiles.filter(f => existingFiles.indexOf(f) === -1)).filter(f => f.endsWith('.tf'));
+
+      for (let i = 0; i < checkVersionIn.length; i++) {
+        versionFile = checkVersionIn[i];
+        const requiredVersion = fs.readFileSync(versionFile, 'utf-8');
+        const pattern = /^([\s]{0,}required_version)[\s]{0,}=[\s]{0,}"(>=|=|>|~>)[\s]{0,}\d+.*"/m;
+        const specified = requiredVersion.match(pattern);
+
+        if (specified) {
+          const vPattern = /\d+(\.\d+)?(\.\d+)?/;
+          [tfVersion] = specified[0].trim().match(vPattern);
+          break;
+        }
+      }
+    }
+
+    if (tfVersion) {
+      console.log('required_version was found in:', versionFile);
+      const store = join(__dirname, '../..', 'store');
+
+      checkStore(store);
+
+      const inStore = fs.readdirSync(store).find(v => v.startsWith(tfVersion));
+
+      if (inStore) {
+        await use(inStore);
+      } else {
+        const version = await install(`${tfVersion}^`);
+        await use(version);
+      }
+    } else {
+      console.log(`${P_ERROR}NOT FOUND:${P_END}${P_INFO}required_version${P_END}`);
+      console.log(`${P_INFO}check in your remote state file${P_END}`);
+    }
+
+  } catch ({message}) {
+    console.log('ERROR:', message)
+  }
+}
+

package/lib/modules/use.js

@@ -4,13 +4,18 @@ const {spawnSync} = require('child_process');
 const {readdirSync, mkdirSync, copyFileSync, existsSync} = require('fs');
 const {setWindowsTerraform} = require('./ps1');
 const {P_END, P_OK, P_INFO, P_ERROR} = require('../utils/colors');
+const { checkStore } = require('../utils/store');
 
 exports.use = async (tfVer) => {
   try {
+    const store = join(__dirname, '../..', 'store');
+
+    checkStore(store);
+
     let version = os.platform() === 'win32' ? `${tfVer}.exe` : tfVer;
 
     if (tfVer === 'latest') {
-      [version] = readdirSync(join(__dirname, '../../store')).sort((a, b) => {
+      [version] = readdirSync(store).sort((a, b) => {
         let aVer = a.replace(/(.exe)/g, '');
         let bVer = b.replace(/(.exe)/g, '');
 
@@ -32,9 +37,9 @@ exports.use = async (tfVer) => {
       console.log(`${P_INFO}Your latest installed version is ${version}${P_END}`);
     }
 
-    console.log(`${P_INFO}Switching to terraform ${version}${P_END}`);
+    console.log(`${P_INFO}Switching to terraform ${version.replace('.exe', '')}${P_END}`);
 
-    const source = join(__dirname, '../../store', version);
+    const source = `${store}/${version}`;
 
     if (!existsSync(source)) {
       console.log(`${P_ERROR}terraform ${version} is not installed${P_END}`);

package/lib/utils/formatVersions.js

@@ -0,0 +1,6 @@
+exports.formatVersions = (content) => {
+  const pattern = /(>terraform_).*(?=<\/a>)/g;
+  const versions = content.match(pattern).map(v => v.replace('>terraform_', ''));
+
+  return versions;
+}

package/lib/utils/postInstall.js

@@ -1,4 +1,4 @@
-const {P_END, P_OK, P_INFO, P_ERROR} = require('./colors');
+const {P_END, P_OK} = require('./colors');
 
 const message = `\n\
          _        ________        __\n\

package/lib/utils/store.js

@@ -0,0 +1,10 @@
+const fs = require('fs');
+const {P_END, P_OK, P_ERROR} = require('./colors');
+
+exports.checkStore = (store) => {
+  if (!fs.existsSync(store)) {
+    console.log(`${P_ERROR}You're yet to install terraform with tfv${P_END}`);
+    console.log(`For guidance, run ${P_OK}tfv -h${P_END}`);
+    process.exit(1);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tfv",
-  "version": "3.2.2",
+  "version": "3.2.4",
   "description": "Terraform version manager",
   "main": "index.js",
   "directories": {