/ts-es-mapping-plugin

StApps mapping generation WebStorm plugin

Primary LanguageKotlinMIT LicenseMIT

StApps Elasticsearch Mapping Plugin

Build Version Downloads

Plugin to assist with annotating interfaces that are parsed by the ES Mapping generator from the StApps Core-tools

Features

Supported tags

Annotation Description Parameters
@aggregatable used for generating of aggregations of the field if the core schema is used to put data into a database/key-value store whether the property is being used on the top type or across all types: global
@float number field is interpreted as float
@indexable marks the type as indexable if the core schema is used to put data into a database/key-value store
@integer number field is interpreted as integer
@keyword string field is interpreted as keyword
@sortable field is sortable if the core schema is used to put data into a database/key-value store sort method to be used: ducet, price, distance
@text string field is interpreted as text
@filterable non-object/nested field is filterable if the core schema is used to put data into a database/key-value store
@inheritTags inherit all tags from another field [SCThingType]::[field]
  • @integer and @float only applies to number
  • @text and @keyword only applies to string
  • @sortable ducet only applies to string
  • @sortable price only applies to number
  • Interfaces only accept @indexable
  • Fields accept everything else except @indexable

Arrays are ignored and their element type is used

Installation

  • Using IDE built-in plugin system:

    Preferences > Plugins > Marketplace > Search for "ts-es-mapping-plugin" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Preferences > Plugins > ⚙️ > Install plugin from disk...


Plugin based on the IntelliJ Platform Plugin Template.