@realm/babel-plugin
Version:
Babel plugin making it easier to declare your Realm schema
79 lines (64 loc) • 2.29 kB
Markdown
# Test Generator for the `@realm/babel-plugin` package
```mermaid
flowchart TD
classDef data text-align:left;
subgraph Generate
nodePropertyTest["
<code>type PropertySuiteOptions = {
type: string;
objectType: string[];
default: ({ source: string } | undefined | unknown)[];
optional: boolean[];
}
</code>
"]
nodePropertySchema["
<code>type PropertyTestOptions = {
type: string;
objectType?: string;
default?: { source: string } | unknown;
optional?: true;
}
</code>
"]
nodePropertyVariant["
<code>type PropertyVariant = {
type?: string;
typeArgument?: string;
initializer?: string;
questionMark: boolean;
}
</code>
"]
nodePropertyCode["
Property source code:
<code>prop?: Realm.Types.Decimal128 = new Realm.Types.Decimal128();</code>
"]
nodePropertyTest -->|<code>describeProperty</code>: Generates combinations of array elements| nodePropertySchema
nodePropertySchema -->|<code>generatePropertyVariants</code>: Generates different ways of expressing the property| nodePropertyVariant
nodePropertyVariant -->|<code>generatePropertyCode</code>: Generates source code to for every variant| nodePropertyCode
class nodePropertyTest,nodePropertySchema,nodePropertyVariant,nodeSourceCode data;
end
nodePropertyCode -->|<code>transformProperty</code>: Wraps property source code in a class and calls the babel transform plugin| nodeTransformedCode
subgraph Verify
nodeTransformedCode["
<code>import Realm, { Object, ... } from #quot;realm#quot;;
class Foo {
#nbsp;#nbsp;static schema = { ... };
}
</code>
"]
nodeStaticSchema["
Parsed static schema property
"]
nodeExpectedSchema["
Inferred generated schema
"]
nodeTransformedCode -->|<code>extractSchema</code>: Extracts & parses transformed schema| nodeStaticSchema
nodePropertySchema -->|<code>inferSchema</code>: Infers the expected schema| nodeExpectedSchema
nodeAssert{Assert equals?}
nodeStaticSchema --> nodeAssert
nodeExpectedSchema --> nodeAssert
class nodeTransformedCode data;
end
```