Skip to content

chore: unified annotation keywords #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ivan-m-dev merged 2 commits into from
Feb 26, 2026
Merged

chore: unified annotation keywords #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37140dc
chore: unified annotation keywords
chulanovskyi-bs Feb 26, 2026
e07c965
chore: moved to a shared place
chulanovskyi-bs Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 4 additions & 52 deletions forward_engineering/ddlProvider/ddlHelpers/tableHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
const _ = require('lodash');
const { getAnnotationsString } = require('../../utils/getAnnotationsString');

module.exports = ({
getColumnsList,
checkAllKeysDeactivated,
commentIfDeactivated,
prepareName,
assignTemplates,
wrapComment,
}) => {
const getTableType = ({
duplicated,
external,
immutable,
sharded,
temporary,
temporaryType,
blockchain_table_clauses,
}) => {
module.exports = ({ getColumnsList, checkAllKeysDeactivated, commentIfDeactivated, prepareName }) => {
const getTableType = ({ duplicated, immutable, sharded, temporary, temporaryType, blockchain_table_clauses }) => {
const blockchain = !_.isEmpty(blockchain_table_clauses);
switch (true) {
case temporary:
Expand All @@ -43,7 +29,7 @@ module.exports = ({
{ key: 'partitioning', getValue: getPartitioning },
{ key: 'selectStatement', getValue: getBasicValue('AS') },
{ key: 'tableProperties', getValue: value => _.trim(value) },
{ key: 'tableAnnotations', getValue: getAnnotationsString },
{ key: 'tableAnnotations', getValue: getAnnotationsString(prepareName) },
]
.map(config => (tableData[config.key] ? wrap(config.getValue(tableData[config.key], tableData)) : ''))
.filter(Boolean)
Expand Down Expand Up @@ -303,40 +289,6 @@ module.exports = ({
return { foreignOnDelete };
};

/**
* Generates annotations string.
* @param {Array} tableAnnotations - tableAnnotations array.
* @returns {string} - Annotation string (e.g: "\nANNOTATIONS (...)") or ''.
*/
const getAnnotationsString = tableAnnotations => {
if (!Array.isArray(tableAnnotations) || tableAnnotations.length === 0) {
return '';
}

const wrapValue = value => wrapComment(value);

const annotationsItems = tableAnnotations
.filter(annotation => annotation?.tableAnnotationName?.trim())
.map(annotation => {
const name = prepareName(annotation.tableAnnotationName.trim());

let finalValue = '';
const annotationValue = annotation?.tableAnnotationValue;

if (annotationValue !== undefined && String(annotationValue).trim() !== '') {
finalValue = ' ' + wrapValue(String(annotationValue).trim());
}

return `${name}${finalValue}`;
});

if (annotationsItems.length > 0) {
return `ANNOTATIONS (${annotationsItems.join(', ')})`;
}

return '';
};

return {
getTableOptions,
getTableType,
Expand Down
44 changes: 44 additions & 0 deletions forward_engineering/utils/getAnnotationsString.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
const { wrapComment } = require('./general');

/**
* @typedef {{
* annotationName?: string
* annotationValue?: string
* }} Annotation
*/

/**
* Generates annotations string.
* @param {function} prepareName
* @returns {(annotations: Annotation[]) => string} - returns Annotations string (e.g: "\nANNOTATIONS (...)") or ''.
*/
const getAnnotationsString = prepareName => annotations => {
if (!Array.isArray(annotations) || annotations.length === 0) {
return '';
}

const wrapValue = value => wrapComment(value);

const annotationsItems = annotations
.filter(annotation => annotation?.annotationName?.trim())
.map(annotation => {
const { annotationName, annotationValue } = annotation;
const name = prepareName(annotationName.trim());

let finalValue = '';

if (annotationValue !== undefined && annotationValue.trim() !== '') {
finalValue = ' ' + wrapValue(annotationValue.trim());
}

return `${name}${finalValue}`;
});

if (annotationsItems.length > 0) {
return `ANNOTATIONS (${annotationsItems.join(', ')})`;
}

return '';
};

module.exports = { getAnnotationsString };
8 changes: 4 additions & 4 deletions properties_pane/entity_level/entityLevelConfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,7 +912,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "tableAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -921,7 +921,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "tableAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -1234,7 +1234,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "indexAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -1243,7 +1243,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "indexAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down
48 changes: 24 additions & 24 deletions properties_pane/field_level/fieldLevelConfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2128,7 +2128,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -2137,7 +2137,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -4162,7 +4162,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -4171,7 +4171,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -5948,7 +5948,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -5957,7 +5957,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -6777,7 +6777,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -6786,7 +6786,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -8007,7 +8007,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -8016,7 +8016,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -9435,7 +9435,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -9444,7 +9444,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -11106,7 +11106,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -11115,7 +11115,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -11283,7 +11283,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -11292,7 +11292,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -12157,7 +12157,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -12166,7 +12166,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -12699,7 +12699,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -12708,7 +12708,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -13485,7 +13485,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -13494,7 +13494,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down Expand Up @@ -14039,7 +14039,7 @@ making sure that you maintain a proper JSON format.
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "columnAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -14048,7 +14048,7 @@ making sure that you maintain a proper JSON format.
},
{
"propertyName": "Value",
"propertyKeyword": "columnAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down
4 changes: 2 additions & 2 deletions properties_pane/view_level/viewLevelConfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,7 +703,7 @@
"structure": [
{
"propertyName": "Name",
"propertyKeyword": "viewAnnotationName",
"propertyKeyword": "annotationName",
"propertyTooltip": "An identifier that can have up to 1024 characters. If the annotation name is a reserved word it must be provided in double quotes. When a double quoted identifier is used, the identifier can also contain whitespace characters",
"propertyType": "text",
"validation": {
Expand All @@ -712,7 +712,7 @@
},
{
"propertyName": "Value",
"propertyKeyword": "viewAnnotationValue",
"propertyKeyword": "annotationValue",
"propertyTooltip": "The value of the annotation is optionsal. Value can have a maximum of 4000 characters.",
"propertyType": "details",
"template": "textarea",
Expand Down