Skip to content

HCL-TECH-SOFTWARE/voltscript-collections

Repository files navigation

VoltScript Collections

Collections and Map classes for LotusScript and VoltScript.

Aims:

  • Provide simple, flexible, extensible collections and maps.
  • Allow a collection to be instantiated from values immediately. This is not possible if you do Dim foo() as String.
  • Provide unsorted, sorted, unique, sorted unique collections and maps.
  • Make the sorting method a property of the collection, to minimise the number of collections required.
  • Hide the complexity of optimising sorting from the end user.
  • Reuse collections for the keys in a Map.

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 to use GitHub REST APIs. You'll then need to add this to the JSON object in your atlas-settings.json, in the .vss directory of your user home directory:

    "hcl-github": {
        "type": "github",
        "token": "YOUR_TOKEN"
    }

For JsonVSE downstream dependency, you'll need to sign up for the Volt MX Marketplace. Instructions are in the how-to-guide. 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, in the .vss directory of your user home directory:

    "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:

        {
            "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:

        {
            "library": "voltscript-collections",
            "version": "1.0.4",
            "module": "VoltScriptCollections.vss",
            "repository": "hcl-github"
        }

Contributing

See CONTRIBUTING.md.

## Code of Conduct

See CODE_OF_CONDUCT.md.

Issues and discussions

Let's chat on OpenNTF Discord.

For long-running discussions, use Discussions area in GitHub. For bugs and feature requests specific to VoltScript Testing Framework use, Issues area.