diff --git a/docs/constraints/CSharp.md b/docs/constraints/CSharp.md index 32ca6904d7..17e1d5be9e 100644 --- a/docs/constraints/CSharp.md +++ b/docs/constraints/CSharp.md @@ -3,7 +3,7 @@ These are the C# specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For csharp `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/Dart.md b/docs/constraints/Dart.md index dbd317ba41..d545a6f9bd 100644 --- a/docs/constraints/Dart.md +++ b/docs/constraints/Dart.md @@ -3,7 +3,7 @@ These are the Dart specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For dart `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/Go.md b/docs/constraints/Go.md index 9c819fe526..ef693d8383 100644 --- a/docs/constraints/Go.md +++ b/docs/constraints/Go.md @@ -3,7 +3,7 @@ These are the Go specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For go `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/Java.md b/docs/constraints/Java.md index 1a3072f9f4..29f0ff2f82 100644 --- a/docs/constraints/Java.md +++ b/docs/constraints/Java.md @@ -3,7 +3,7 @@ These are the Java specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For java `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/JavaScript.md b/docs/constraints/JavaScript.md index ce3c090fbe..742a580086 100644 --- a/docs/constraints/JavaScript.md +++ b/docs/constraints/JavaScript.md @@ -3,7 +3,7 @@ These are the JavaScript specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For javascript `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/README.md b/docs/constraints/README.md index 9100960a4d..7f3d71c1fa 100644 --- a/docs/constraints/README.md +++ b/docs/constraints/README.md @@ -12,6 +12,8 @@ class &name {} class 1name {} ``` +## Customization + There are many rules as such, but to get the full description about the default constraints here: - [C#](./constraints/CSharp.md) @@ -28,7 +30,7 @@ We define these as two types, either you only want to change part of the logic, - [Overwriting the formatter](../examples/overwrite-naming-formatting) and keep the rest of the constraints as is. - [Overwriting the entire naming constraint logic](../examples/overwrite-default-constraint) keeping none of the existing functionality which handles edge cases. It is recommended to **NOT** use this if it can be avoided, as you will limit yourself to what inputs can be generated to models. So make sure you know what you are doing :laughing: -# Type mapping +## Type mapping To make it easier to use the meta models in presets and generators, we need to figure out the types for each model. This is to enable you to access the types from a property rather then calling a function. This is especially relevant because Modelina cannot fit all use-cases out of the box, and we therefore strive to make it tailorable to what ever your needs may be. The type mapping is one of those things that enable you to fine tune the types for your purpose. Of course it's not all output formats that have a type such as JavaScript, therefore these are only used for strongly typed outputs. diff --git a/docs/constraints/Rust.md b/docs/constraints/Rust.md index e30e88effe..611532c9c5 100644 --- a/docs/constraints/Rust.md +++ b/docs/constraints/Rust.md @@ -3,7 +3,7 @@ These are the Rust specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For Rust `_`, ` ` and `$` are an exception to this rule. | @@ -25,7 +25,7 @@ These are the constraints that is applied to object properties and the naming of |NO_DUPLICATE_PROPERTIES|No duplicate properties|If any of the above constraints changes the property name, we must make sure that no duplicates exist within the same object. If any is encountered `reserved_` is pre-pended. This is done recursively until no duplicates are found.| ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| diff --git a/docs/constraints/TypeScript.md b/docs/constraints/TypeScript.md index 3cc175fa0b..85fc33b9cc 100644 --- a/docs/constraints/TypeScript.md +++ b/docs/constraints/TypeScript.md @@ -3,7 +3,7 @@ These are the TypeScript specific constraints applied to the MetaModel before reaching the presets. [Read here to get a more general idea on the overall process](../input-processing.md) of converting a MetaModel to a ConstrainedMetaModel. ## Model Naming -These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to model naming. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| @@ -14,7 +14,7 @@ These are the constraints that is applied to model naming. The `Rule key` is wha |NAMING_FORMATTER|Must be formatted equally|Model name is formatted using pascal case| ## Property naming -These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to object properties and the naming of them. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---| |NO_SPECIAL_CHAR|No special characters| Special characters are replaced by their name, for example `!` is replaced with `exclamation`. For typescript `_` and `$` are an exception to this rule. | @@ -26,7 +26,7 @@ These are the constraints that is applied to object properties and the naming of ## Enum key constraints -These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](../constraints.md#Customization). +These are the constraints that is applied to enum keys. The `Rule key` is what you can use in the options to overwrite the default behavior. See [constraint customization](./README.md#Customization). |Rule key|Rule|Resolution| |---|---|---|