configuration-types 0.0.23
Install from the command line:
Learn more about npm packages
$ npm install @cloudcannon/configuration-types@0.0.23
Install via package.json:
"@cloudcannon/configuration-types": "0.0.23"
About this version
Contains TypeScript declarations and generates JSON Schema files for the CloudCannon configuration file.
npm i -D @cloudcannon/configuration-typesWe plan to add the configuration schema to JSON Schema Store, which would automatically enable in-editor validation, autocomplete and tooltips with the YAML or JSON LSP enabled.
Alternatively, you can add a comment to the top of your file to use a specific schema for YAML files:
# yaml-language-server: $schema=https://raw.githubusercontent.com/CloudCannon/configuration-types/main/dist/cloudcannon-config.schema.json
collections_config:
posts:
path: content/posts
name: Blog
icon: eventOr the top-level $schema entry for JSON files:
{
"$schema": "https://raw.githubusercontent.com/CloudCannon/configuration-types/main/dist/cloudcannon-config.schema.json",
"collections_config": {
"posts": {
"path": "content/posts",
"name": "Blog",
"icon": "event"
}
}
}You could also/alternatively validate the file on the command line with something like ajv-cli:
npm i @cloudcannon/configuration-types ajv-cli
npm run ajv validate -s node_modules/@cloudcannon/configuration-types/schema/cloudcannon-config.schema.json -d cloudcannon.config.ymlInstall dependencies:
npm iBuild:
npm run buildMIT
