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 (.cms.vm) formats and Data Definitions (.def.xml) with Cascade CMS via API.
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
.cms.vm always auto-submits on save; .def.xml auto-submit is configurable
- Latest-check with safe merge: merges newer server changes into local before submit (diff-match-patch)
- Pull shows a progress notification and finishes with a completion message
- Securely stores API key using VS Code Secret Storage
- Basic Velocity language configuration for
.cms.vm
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 for .def.xml . .cms.vm always auto-submits
Commands
- Cascade CMS: Pull Site Formats and Data Definitions
- Cascade CMS: Submit Current File
- Cascade CMS: Set API Key
Usage
- Run "Cascade CMS: Set API Key" and paste your key.
- Set
cascadeCmsDeveloper.baseUrl in settings.
- Optionally set
cascadeCmsDeveloper.rootPath .
- Run "Cascade CMS: Pull Site Formats and Data Definitions" to bootstrap local files.
- Edit files and submit with the command or enable auto-submit on save.
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
| |