.appsemblerc.yaml

Appsemble RC file

Type object
File match .appsemblerc.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/appsemblerc-yaml/latest.json
Source https://gitlab.com/appsemble/appsemble/-/raw/HEAD/packages/cli/assets/appsemblerc.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A .appsemblerc.yaml file may be used to configure either an app or a block.

Properties

name string

The name of a block. By default the name in package.json is used.

pattern=^@([0-9a-z](?:(?!.*--)[0-9a-z-]*[0-9a-z])?)/([0-9a-z](?:(?!.*--)[0-9a-z-]*[0-9a-z])?)$
description

A short description of the block. By default the description in package.json is used.

maxLength=160
version

A semantic version of the block representation of the block version. By default the version in package.json is used.

longDescription string

The long description of the block. Markdown is supported. By default the content of README.md is used.

layout enum

The type of layout to be used for the block.

Default: "static"
Values: "float" "grow" "hidden" "static" null
output string

Where to read build output from.

Default: "dist"
webpack string

The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.

events object

An object describing the names of the events the block can listen and emit to. By default this is extracted from the block’s TypeScript module augmentations.

2 nested properties
listen Record<string, object>

The events the block listens on.

emit Record<string, object>

The events the block may emit.

actions object

An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block’s TypeScript module augmentations.

parameters

A JSON schema which describes the block parameters. By default this is extracted from the block’s TypeScript module augmentations.

iconBackground string

The background color to use for maskable icons.

pattern=^#[a-zA-Z0-9]{6}$
wildcardActions boolean

Whether action validation for wildcard action is skipped.

If true, ignore unused actions that fall under '$any'.

context Record<string, object>

A context which can be specified using the --context command line parameter.