Blue marlin

a code-first component editor for Makaira

Features

• JSON schema validation
• snippet support
• auto completion

Usage

The schema will automatically match all files ending with *.component.json, e.g. banner.component.json or discovery-image.component.json. Once you're done, copy the whole JSON, open the components editor and import your component there.

Snippets

Blue marlin comes with several builtin snippets. In order to use them, you need to hit Ctrl+Space all the time. Therefore it is recommended to enable tab-completion and set "editor.tabCompletion: on" in your user or workspace settings. This enables you to type a snippet prefix and press Tab to insert a snippet.

Field snippets

• text
• richtext
• number
• file
• checkbox
• select
• multiselect
• object
• array
• documents
• stream
• colorpicker
• hotspot

Property snippets

• uuid: generates an UUIDv4 (required)
• id: kebab-case, lowercase identifier
• label
• type
• description
• option: a single option for select and multiselect fields
• options
• properties
• defaultValue
• documentType

Release Notes

1.0.0

Initial release of Blue marlin.

Happy coding!

Roadmap

• field migrations
• variants.js generation
• component tree view
• component notebooks with preview renderer
• an interactive drag & drop component builder
• use JWTs to authenticate with your Makaira account to push & pull components

Trivia

The Atlantic blue marlin (Makaira nigricans) is a species of marlin endemic to the Atlantic Ocean. It is closely related to, and usually considered conspecific with, the Indo-Pacific blue marlin, then simply called blue marlin. Some authorities still consider both species distinct.