idea-spec v0.1.1

💡 Idea Spec

Maps made for idea plugins.

Install

$ npm i idea-spec

Usage

In your plugin you can populate the maps like the following.

import type { PluginWithCLIProps } from '@ossph/idea';
import { Model, Fieldset, Enum } from 'idea-spec';

export default function transform({ config, schema, cli }: PluginWithCLIProps) {
  //populate model cache
  for (const name in schema.model) {
    Model.add(schema.model[name]);
  }
  //populate fieldset cache
  for (const name in schema.type) {
    Fieldset.add(schema.type[name]);
  }
  //populate enum cach
  for (const name in schema.enum) {
    Enum.add(name, schema.enum[name]);
  }

  //.. your plugin logic
}

Then, you can make new constructs like the following.

const model = new Model('profile');
const fieldset = new Fieldset('address');
const roles = Enum.get('roles');

Enum

The following methods are available for enums.

Enum.add(name: string, options: Record<string, Data>)

Adds a schema to the static enum cache.

Enum.has(name: string)

Returns true if the name is in the enum cache.

Enum.get(name: string)

Returns the enum options from the enum cache given the name.

Fieldset

Fieldsets have the following properties.

The following methods are available for fieldsets.

Fieldset.add(name: string, options: Record<string, Data>)

Adds a schema to the static fieldset cache.

Fieldset.has(name: string)

Returns true if the name is in the fieldset cache.

Fieldset.get(name: string)

Returns the fieldset options from the fieldset cache given the name.

const fieldset = new Fieldset('address');
fieldset.column('city');

Returns the column information given the column name.

Model

Models have the following properties

The following methods are available for models.

Model.add(name: string, options: Record<string, Data>)

Adds a schema to the static model cache.

Model.has(name: string)

Returns true if the name is in the model cache.

Model.get(name: string)

Returns the model options from the models cache given the name.

const model = new Model('user');
model.column('name');

Returns the column information given the column name.

Column

Columns have the following properties