club.syntax.content.files

syntax.club

Documentation

A collection of embedded files forming a multi-file code snap.

main object

A collection of embedded files forming a multi-file code snap.

Properties

files array of ref#file Required

Ordered list of files defining display and traversal order.

maxLength: 4 itemsminLength: 1 items
primaryId string Required

Identifier of the primary file. Must match the `id` of one of the items.

maxLength: 64 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "files",
    "primaryId"
  ],
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "ref": "#file",
        "type": "ref"
      },
      "maxLength": 4,
      "minLength": 1,
      "description": "Ordered list of files defining display and traversal order."
    },
    "primaryId": {
      "type": "string",
      "maxLength": 64,
      "description": "Identifier of the primary file. Must match the `id` of one of the items."
    }
  },
  "description": "A collection of embedded files forming a multi-file code snap."
}
file object

No description available.

Properties

content string Required

Raw file content.

maxLength: 5000 bytesminLength: 1 bytes
description string Optional

Optional description or context.

maxGraphemes: 500 graphemes
id string Required

Stable identifier unique within the snap (e.g. TID, UUID).

maxLength: 64 bytesminLength: 1 bytes
language string Required

Canonical programming language identifier.

maxLength: 32 bytesminLength: 1 bytes
name string Optional

Optional file name including extension.

maxGraphemes: 140 graphemes
variant string Optional

Optional language variant (e.g. jsx, tsx, vue).

maxLength: 32 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "language",
    "content"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "Stable identifier unique within the snap (e.g. TID, UUID)."
    },
    "name": {
      "type": "string",
      "description": "Optional file name including extension.",
      "maxGraphemes": 140
    },
    "content": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "Raw file content."
    },
    "variant": {
      "type": "string",
      "maxLength": 32,
      "description": "Optional language variant (e.g. jsx, tsx, vue)."
    },
    "language": {
      "type": "string",
      "maxLength": 32,
      "minLength": 1,
      "description": "Canonical programming language identifier."
    },
    "description": {
      "type": "string",
      "description": "Optional description or context.",
      "maxGraphemes": 500
    }
  }
}

Lexicon Garden

@