Cascade CMS Developer

Note

THIS EXTENSION IS CURRENTLY IN ALPHA AND ISSUES WILL HAPPEN. THIS IS AN UNOFFICIAL PLUGIN FOR CASCADE CMS.

VS Code extension to sync Velocity formats and Data Definitions with Cascade CMS.

Features

• Pull all sites: downloads formats under _cms/formats and data definitions to _datadefs per site
• Formats are stored as .cms.vm; data definitions as .def.xml
• Submit current file: pushes the active .cms.vm or .def.xml to Cascade
• Auto-submit on save is configurable and applies to both .cms.vm and .def.xml
• Latest-check with safe merge: merges newer server changes into local before submit
• Pull shows a progress notification and finishes with a completion message
• Securely stores API key using VS Code Secret Storage
• Basic Velocity language configuration and snippets for Cascade CMS Velocity

Getting Started

1. Open a new folder in VS Code (an empty workspace works best).
2. Open the Command Palette (default hotkey: F1).
3. Search for CMS and select Cascade CMS: Configure Workspace.
4. Follow the on-screen prompts:
   • Base URL: Use your Cascade CMS API URL.
     • Example: https://example.cascadecms.com/api/v1
     • Replace example with your real Cascade domain.
   • API Key: Generate one from your Cascade account at: https://example.cascadecms.com/user/apiKey.act
5. Once configured, press F1 again, search CMS, and choose: Cascade CMS: Pull Site Formats and Data Definitions.
6. Allow the plugin to sync with your Cascade install.
   • If you run into issues, double-check your API key and URL.

Submitting Files

1. Open the file you want to submit in VS Code.
2. Press F1 and search CMS.
3. Select Cascade CMS: Submit Current File.
4. A notification will appear to say if this action was successful, if a merge and submit needs to happen or an error occured.

Default Settings

This extension includes default configuration options that can be adjusted in your VS Code settings. Open the settings search, type CMS, and you’ll see all available options for this extension.

Settings

• cascadeCmsDeveloper.baseUrl: Base URL for the Cascade CMS API
• cascadeCmsDeveloper.rootPath: Root directory for site folders and _datadefs (defaults to workspace root)
• cascadeCmsDeveloper.autoSubmitOnSave: Automatically submit on save (default: on)

Local Workspace Settings

You can override the above settings per workspace using .vscode/cascade-cms-developer.json in your project root. This enables different baseUrl and API key per workspace.

Example file:

{
  "baseUrl": "https://example.cascadecms.com/api/v1",
  "rootPath": "/absolute/path/to/workspace",
  "autoSubmitOnSave": true
}

The API key is stored securely in VS Code Secret Storage, namespaced per workspace. Use the command below to set it.

Commands

• Cascade CMS: Pull Site Formats and Data Definitions
• Cascade CMS: Pull Current Folder from CMS
• Cascade CMS: Submit Current File
• Cascade CMS: Set API Key
• Cascade CMS: Configure Workspace

Development

• Build: npm run build
• Watch: npm run watch
• Package: npm run package

Notes

• In-process merge using diff-match-patch with local cache as base
• Data Definition XML has field-id attributes stripped locally
• Save/submit triggers only for .cms.vm and .def.xml