Configuration types

Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.

• Installation
• Usage
  • YAML and JSON
  • JavaScript
• Development
• License

Installation

npm i -D @cloudcannon/configuration-types

Usage

The primary use of this package is to validate your configuration file. You can also use it to autocomplete and read inline documention while editing. Here are some suggested workflows below.

YAML and JSON

We 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/build/cloudcannon-config.json

collections_config:
  posts:
    name: Blog
    icon: event

Or the top-level $schema entry for JSON files:

{
  "$schema": "https://raw.githubusercontent.com/CloudCannon/configuration-types/main/build/cloudcannon-config.json",

  "collections_config": {
    "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/cloudcannon-config.json -d cloudcannon.config.yml

JavaScript

For a CommonJS formatted configuration file (e.g. /cloudcannon.config.cjs), you can use a JSDoc comment to indicate the type of the module export:

/** @type {import("@cloudcannon/configuration-types").Configuration} */
const config = {
  collections_config: {
    posts: {
      name: 'Blog',
      icon: 'event',
    },
  },
};

module.exports = config;

Then use the TypeScript LSP in your supported editor, ensuring it is set up to check JavaScript files. This would provide in-editor validation, autocomplete and tooltips as you modify the file.

You could also/alternatively run tsc over your file to validate there are no issues outside of your editor:

npx tsc test/cloudcannon.config.js --allowJs --checkJs --noEmit

Development

Install dependencies:

npm i

Build JSONSchema files:

npm run build

License

MIT