Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hcl-tech-software/voltscript-json-converter
Conversion between VoltScript objects and JSON
https://github.com/hcl-tech-software/voltscript-json-converter
volt-mx-go voltscript
Last synced: 10 days ago
JSON representation
Conversion between VoltScript objects and JSON
- Host: GitHub
- URL: https://github.com/hcl-tech-software/voltscript-json-converter
- Owner: HCL-TECH-SOFTWARE
- License: apache-2.0
- Created: 2023-09-19T12:32:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-03T12:27:13.000Z (3 months ago)
- Last Synced: 2024-12-20T12:15:47.297Z (17 days ago)
- Topics: volt-mx-go, voltscript
- Homepage: https://opensource.hcltechsw.com/voltscript-json-converter
- Size: 2.29 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VoltScript JSON Converter
VoltScript JSON Converter manages the conversion of data from JSON to VoltScript objects and back to JSON.
## How it Works
As a compiled language, VoltScript cannot leverage reflection to convert the data. However, the `Execute` function in VoltScript can be leveraged with global variables. A string can be built for the code that needs to be run, and `Execute` can perform that code.
This just leaves a few complications:
- Classes that require a custom constructor.
- Custom converters to convert to / from specific data types
- Custom converters that require different property names to JSON labels
- Custom converters that need to call subs or functions instead of writing directly to properties
## Using dependency management
Dependency management is available in the documentation for each project, but also aggregated here:
### Authentication
You'll need a [Personal Access Token](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#github-personal-access-token) to use GitHub REST APIs. You'll then need to add this to the JSON object in your [atlas-settings.json](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
```json
"hcl-github": {
"type": "github",
"token": "${env.TOKEN}"
}
```
For JsonVSE downstream dependency, you'll need to sign up for the Volt MX Marketplace. Instructions are in the [how-to-guide](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.html#volt-mx-marketplace-credentials). **NOTE:** Ensure you log into the Volt MX Marketplace via a browser after confirming your account, to ensure the account is properly activated. Otherwise authentication to gain an access token will fail.
You'll then need to add this to the JSON object in your [atlas-settings.json](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
```json
"volt-mx-marketplace": {
"type": "marketplace",
"username": "YOUR_USERNAME",
"password": "YOUR_PASSWORD",
"authUrl": "https://accounts.auth.hclvoltmx.net/login"
}
```
### Repository
You'll need to add to your **repositories** object in the atlas.json of your project:
```json
{
"id": "hcl-github",
"type": "github",
"url": "https://api.github.com/repos/HCL-TECH-SOFTWARE"
}
```
### Dependency
You'll need the relevant dependency to add to your **dependencies** or **testDependencies** object in the atlas.json of your project:
```json
{
"library": "voltscript-json-converter",
"version": "1.0.4",
"module": "VoltScriptJsonConverter.vss",
"repository": "hcl-github"
}
```
## Contributing
See [CONTRIBUTING.md](contributing.md).
## Code of Conduct
See [CODE_OF_CONDUCT.md](code_of_conduct.md).
## Issues and discussions
Let's chat on [OpenNTF Discord](https://openntf.org/discord).
For long-running discussions, use Discussions area in GitHub. For bugs and feature requests **specific to VoltScript Testing Framework** use, Issues area.