Skip to content

Commit

Permalink
Update changelog and readme.
Browse files Browse the repository at this point in the history
Added a nice GIF image showing of the refresh command.
  • Loading branch information
Codeneos committed Oct 29, 2018
1 parent 6262059 commit 89207a6
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 28 deletions.
19 changes: 14 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Change Log
All notable changes to the "vlocode" extension will be documented in this file.
# Changelog Vlocode

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [0.3.1] - 2018-10-29 (beta)
### Added
- Support for deploying of datapacks from within VSCode
- Preview/framework AngularJS UI for viewing datapacks
- Improved response handling for Vlocity tools results

## [Unreleased]
- Initial release
### Changed
- Build system now uses Webpack for generating extension js files

## [0.2.0] (alpha)
### Changed
- Initial release of Vlocode with support for refreshing datapacks from the context menu.
- Enabled login using SFDX
- Use official Vlocity NPM package
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
<img src="https://raw.githubusercontent.com/Codeneos/vlocode/master/images/logo1.png" height="160px">
<img src="https://raw.githubusercontent.com/Codeneos/vlocode/master/resources/logo1.png" height="160">

# VloCode for Visual Studio Code
# Vlocode for Visual Studio Code

This extension provides an alternate way for developing, extracting and deploying Vlocity data with Visual Studio Code.
It is targeted at Vlocity developers who want a lightweight and fast way to work with Vlocity components and datapacks.
There's no complicated setup process or project configurations, no external apps to keep open, and no jarring errors knocking you out of your flow.
It is targeted at Vlocity developers who want to develop Vlocity components and updated datapacks from an IDE instead of using the web based UI available in Salesforce.
There's no complicated setup process or bothersome project configuration to maintain.

<img src="https://raw.githubusercontent.com/Codeneos/vlocode/master/resources/refreshDatapack.gif" width="600">

## Features

* Uses the standard Vlocity NPM package
* Retrieve/refresh Vlocity datapacks from within Visual Studio Code
* Deploy a single or multiple Vlocity datapacks from within Visual Studio Code
* Support SFDX username or alias to login to Salesforce
> **Tip** Setup SFDX (see Requirements) to avoid storing your Salesforce password and security token as plain text workspace configuration
* Retrieve/refresh Vlocity datapacks from within Visual Studio Code
* (WIP) Deploy single or multiple Vlocity datapacks from within Visual Studio Code
* (WIP) Automaticly update Vlocity templates when edited from Visual Studio Code
## Planned Features

* Automatically deployment of Vlocity datapacks when edited from Visual Studio Code
* Detect datapack parent for related files
* This should enable deployment when working in a related file such as a SASS stylesheet or HTML template that outside of the `_Datapack.json` file
* Recompiling (deactivate -> activate flow) of OmniScripts after changing a template to directly see the effects in your browsers.
* Simple OmniScript editor inside VisualStudio code using Webview API
* GUI for editing datapacks from within VSCode (see preview UI based on angularJS in version 0.3.1)

## Requirements

Vlocode works best with SFDX for authentication with salesforce, download the SFDX CLI tools from <https://developer.salesforce.com/tools/sfdxcli>.
After installing SFDX authorize your development sanbox using the following command:
After installing SFDX authorize your development sandbox using the following command:
```
sfdx force:auth:web:login -r https://test.salesforce.com
```
Expand All @@ -27,23 +36,14 @@ sfdx force:auth:web:login -r https://test.salesforce.com

This extension contributes the following settings:

* `vlocity.projectPath`: Path to the folder comtaining the Vlocity datapacks relative to the workspace's root folder, for example:
* `vlocity.projectPath`: Path to the folder containing the Vlocity datapacks relative to the workspace's root folder, for example:
- `./vlocity`
- `./datapacks`
* `vlocity.verbose`: Enable verbose loging to the output window
* `vlocity.verbose`: Enable verbose logging to the output window
* `vlocity.sfdxUsername`: SFDX username; when this is specified the username, password, loginUrl and instanceUrl are ignored.

## Known Issues

* Deploying of datapacks from VSCode does not yet work
* Onsave handler that detects changes on file level is currently disabled
* Datapacks are not validated on validity before a refresh
* The temp folder used by the Vlocity NPM package is hardcoded

## Release Notes

### Version 0.2.0 (alpha)

* Initial release of VloCode with support for refreshing datapacks from the context menu.
* Enabled login using SFDX
* Use official Vlocity NPM package
* No datapack validation is being done; trying deploy something that isn't a datapack will result in an error
* Datapack folders cannot yet be retrieved or deployed; for now you have to select the datapack master file which is post fixed with `_Datapack.json`
* Custom expand definition overrides are not yet loaded.
File renamed without changes
File renamed without changes
Binary file added resources/refreshDatapack.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89207a6

Please sign in to comment.