Implement set profile; update docs for release 0.2.0

Author: rmtuckerphx

CHANGELOG.md

@@ -1,14 +1,26 @@
 # Change Log
-All notable changes to the "aws-cli-configure" extension will be documented in this file.
-
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+All notable changes to the AWS CLI Configure extension will be documented in this file.
 
 ## [Unreleased]
-- TBD
+- Allow copying profiles with keys (role_arn & source_profile) in addition to those with keys (aws_access_key_id & aws_secret_access_key)
+
+## 0.2.0 - (2018-06-09)
+### Added
+- Command: Show [named] profile mapped to [default] in 'credentials'
+- Command: Set 'credentials' [default] profile to...
+- Command: Copy profile name from 'credentials'...
+- Status Bar: Activating extension shows which [named] profile is mapped to [default]
+- Status Bar: Clicking profile name in status bar executes command: Set 'credentials' [default] profile to...
+
+### Updated
+- Rename command to: Open 'credentials' file
+- Rename command to: Open 'config' file
+- Rename command to: Open 'credentials' & 'config' files
+
 
-## [0.0.1] - 2018-06-08
+## 0.0.1 - (2018-06-08)
 ### Added
-- Command: Open `credentials` file
-- Command: Open `config` file
-- Command: Open `credentials` & `config` files
+- Command: Open credentials file
+- Command: Open config file
+- Command: Open credentials & config files
 - Command: Browse online docs

README.md

@@ -6,16 +6,31 @@ The AWS CLI Configure extension allows you to quickly access AWS CLI information
 ## Features
 
 The extension adds commands for the following:
-* Open `credentials` file
-* Open `config` file
-* Open `credentials` & `config` files
+* Open 'credentials' file
+* Open 'config' file
+* Open 'credentials' & 'config' files
 * Browse the online docs
+* Show [named] profile mapped to [default] in 'credentials'
+* Set 'credentials' [default] profile to...
+* Copy profile name from 'credentials'...
 
-For example if there is an image subfolder under your extension project workspace:
+### Commands
 
-\!\[feature commands\]\(./images/commands.png)
+![Command List](images/commands.png)
 
+### Copy profile name
+![Copy Profile](images/copy-profile.png)
+Now the name is on the clipboard. Paste away!
 
+### Show named profile mapped to default
+![Show Mapped Profile](images/statusbar-mapped-profile.png)
+
+- Saving the 'credentials' file from VSCode or setting the default profile updates the status bar. 
+- Click the item in the status bar to set the [default] profile to a [named] profile.
+
+
+### Set default profile
+![Set Default Profile](images/set-default-profile.png)
 
 ## Known Issues
 
@@ -24,3 +39,10 @@ No known issues
 ## Release Notes
 
 See Changelog
+
+## License
+This software is released under [MIT License](http://www.opensource.org/licenses/mit-license.php)
+© [Mark Tucker (@rmtuckerphx)](https://github.com/rmtuckerphx) & Contributors
+
+## Review
+Feedback and contributions welcome. Please leave a [review](https://marketplace.visualstudio.com/items?itemName=mark-tucker.aws-cli-configure#review-details).

extension.js

@@ -8,6 +8,7 @@ const fs = require('fs');
 const profileHandler = require('aws-profile-handler');
 const hash = require('object-hash');
 const copyPaste = require("copy-paste");
+const uniqid = require('uniqid');
 
 const DEFAULT_PROFILE = 'default';
 
@@ -57,10 +58,10 @@ function getTooltipMessage() {
  message = `No [default] profile in 'credentials'`;
  break;
 
- case 'default':
+ case DEFAULT_PROFILE:
  message = `No [named] profile mapped to [default] in 'credentials'`;
  break;
- 
+
  default:
  message = `The [${mappedProfile}] profile is mapped to [default] in 'credentials'`
  break;
@@ -170,15 +171,47 @@ function getDefaultProfileSetTo() {
 
 }
 
-async function setDefaultProfileToCredentials() {
- 
+async function setDefaultProfileToCredentials(status) {
+
  const profiles = getSortedProfilesCredentials(false);
  const newProfile = await vscode.window.showQuickPick(profiles, { placeHolder: `Select the [named] profile to set as the [default] profile in the 'credentials' file.` });
 
  if (newProfile) {
+
  const message = `[default] profile in 'credentials' file set to: '${newProfile}'.`;
  console.log(message);
- // vscode.window.showInformationMessage(message);
+
+ const newProfileData = profileHandler.getProfileCredentials(newProfile);
+
+ const mappedProfile = getDefaultProfileSetTo();
+ 
+
+ if (mappedProfile === '<none>') {
+ //add new [default] profile using values from mappedProfile 
+ profileHandler.addProfile(DEFAULT_PROFILE, newProfileData);
+ }
+ else {
+ const defaultProfileData = profileHandler.getProfileCredentials(DEFAULT_PROFILE);
+
+ if (mappedProfile === DEFAULT_PROFILE) {
+ //add new profile zzz-default-?
+ const generatedName = uniqid('zzz-default-');
+
+ profileHandler.addProfile(generatedName, defaultProfileData);
+
+ const message = `The [default] profile was renamed to ${generatedName}. Rename or delete this profile.`;
+ vscode.window.showInformationMessage(message);
+ }
+
+ //delete default profile
+ profileHandler.deleteProfile(DEFAULT_PROFILE);
+
+ //add new [default] profile using values from mappedProfile
+ profileHandler.addProfile(DEFAULT_PROFILE, newProfileData);
+
+ }
+
+ updateStatus(status);
  }
 
 }
@@ -190,9 +223,8 @@ async function copyProfileNameCredentials() {
 
  if (selectedProfile) {
  copyPaste.copy(selectedProfile, () => {
- //vscode.window.showInformationMessage(`'${selectedProfile}' copied to clipboard.`);
  vscode.window.setStatusBarMessage(`'${selectedProfile}' copied to clipboard.`, 10000);
- }); 
+ });
  }
 
 }
@@ -202,21 +234,22 @@ async function copyProfileNameCredentials() {
 
 function activate(context) {
 
+ const status = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left);
+ status.command = 'aws-cli.set-default-profile.credentials';
+ // status.tooltip = `Set [default] profile in 'credentials' to [named] profile`;
+ status.tooltip = getTooltipMessage();
+ context.subscriptions.push(status);
+
+
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.open.credentials', openCredentialsFile));
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.open.config', openConfigFile));
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.open.both', openBothFiles));
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.browse.docs', openOnlineDocs));
 
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.default.map.credentials', showDefaultProfileMapCredentials));
- context.subscriptions.push(vscode.commands.registerCommand('aws-cli.set-default-profile.credentials', setDefaultProfileToCredentials));
+ context.subscriptions.push(vscode.commands.registerCommand('aws-cli.set-default-profile.credentials', setDefaultProfileToCredentials(status)));
  context.subscriptions.push(vscode.commands.registerCommand('aws-cli.copy.profile.credentials', copyProfileNameCredentials));
 
- const status = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left);
- status.command = 'aws-cli.set-default-profile.credentials';
- // status.tooltip = `Set [default] profile in 'credentials' to [named] profile`;
- status.tooltip = getTooltipMessage();
-
- context.subscriptions.push(status);
 
  context.subscriptions.push(vscode.workspace.onDidSaveTextDocument((doc) => {
  const credentialsFile = path.join(os.homedir(), '.aws', 'credentials').toLowerCase();

images/commands.png

@@ -2,7 +2,7 @@
  "name": "aws-cli-configure",
  "displayName": "AWS CLI Configure",
  "description": "Quickly access the AWS CLI config and credentials files",
- "version": "0.0.2",
+ "version": "0.2.0",
  "publisher": "mark-tucker",
  "license": "SEE LICENSE IN LICENSE.md",
  "icon": "images/icon.png",
@@ -69,7 +69,7 @@
  {
  "command": "aws-cli.copy.profile.credentials",
  "title": "AWS CLI: Copy profile name from 'credentials'..."
- } 
+ }
  ]
  },
  "scripts": {
@@ -87,6 +87,7 @@
  "aws-profile-handler": "^2.0.3",
  "copy-paste": "^1.3.0",
  "object-hash": "^1.3.0",
- "opn": "^5.3.0"
+ "opn": "^5.3.0",
+ "uniqid": "^5.0.2"
  }
 }