@likec4/config 1.47.0 → 1.49.0

package/schema.json

@@ -1,6 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "description": "LikeC4 project configuration",
+  "id": "LikeC4ProjectConfig",
+  "description": "LikeC4 Project Configuration",
   "type": "object",
   "properties": {
     "name": {
@@ -8,6 +9,23 @@
       "type": "string",
       "minLength": 1
     },
+    "extends": {
+      "description": "Extend styles from other config files",
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "minItems": 1,
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      ]
+    },
     "title": {
       "description": "A human readable title for the project",
       "type": "string",
@@ -18,25 +36,31 @@
       "type": "string",
       "minLength": 1
     },
-    "imageAliases": {
-      "description": "Map of image alias prefixes to relative paths (keys must match /^@\\w+$/; values must be relative paths without protocol or leading slash).",
+    "styles": {
+      "description": "Project styles customization",
       "type": "object",
-      "propertyNames": {
-        "type": "string"
+      "properties": {
+        "theme": {
+          "description": "Project theme customization",
+          "$ref": "#/$defs/ThemeCustomization"
+        },
+        "defaults": {
+          "description": "Override default values for style properties\nThese values will be used if such property is not defined",
+          "$ref": "#/$defs/DefaultStyleValues"
+        },
+        "customCss": {
+          "description": "Custom CSS (or list of CSS files) to be included in the generated diagrams",
+          "$ref": "#/$defs/CustomStylesheets"
+        }
       },
-      "additionalProperties": {
-        "type": "string",
-        "minLength": 1,
-        "pattern": "^(?!\\/|[A-Za-z]:[\\\\\\/])(?!.*:\\/\\/).*$"
-      }
+      "additionalProperties": false
+    },
+    "imageAliases": {
+      "$ref": "#/$defs/ImageAliases"
     },
     "include": {
-      "description": "Configuration for including additional LikeC4 source files from other directories.\nExample: { \"paths\": [\"../shared\", \"../common/specs\"], \"maxDepth\": 5, \"fileThreshold\": 50 }",
       "$ref": "#/$defs/include-config"
     },
-    "styles": {
-      "$ref": "#/$defs/StylesConfiguration"
-    },
     "exclude": {
       "description": "List of file patterns to exclude from the project, default is [\"**/node_modules/**\"]",
       "type": "array",
@@ -45,142 +69,68 @@
       }
     },
     "manualLayouts": {
-      "$ref": "#/$defs/manual-layouts-config"
+      "$ref": "#/$defs/ManualLayoutsConfig"
     }
   },
   "required": [
     "name"
   ],
   "$defs": {
-    "include-config": {
-      "id": "include-config",
-      "description": "Configuration for including additional LikeC4 source files",
-      "type": "object",
-      "properties": {
-        "paths": {
-          "description": "Additional relative directory paths to include LikeC4 source files from, searched recursively.\nPaths are relative to the project folder (the folder containing this config file).\nExample: [\"../shared\", \"../common/specs\"]",
-          "minItems": 1,
-          "type": "array",
-          "items": {
-            "type": "string",
-            "minLength": 1,
-            "pattern": "^(?!\\/|[A-Za-z]:[\\\\\\/])(?!.*:\\/\\/).*$"
-          }
-        },
-        "maxDepth": {
-          "description": "Maximum directory depth to scan when searching for .c4 files in include paths.\nPrevents excessive scanning of deeply nested directories.\nDefault: 3",
-          "default": 3,
-          "type": "integer",
-          "minimum": 1,
-          "maximum": 20
-        },
-        "fileThreshold": {
-          "description": "Maximum number of files to load from include paths before warning.\nHelps identify performance issues from accidentally including large directories.\nDefault: 30",
-          "default": 30,
-          "type": "integer",
-          "minimum": 1,
-          "maximum": 9007199254740991
-        }
-      },
-      "required": [
-        "paths"
-      ]
-    },
-    "StylesConfiguration": {
-      "id": "StylesConfiguration",
-      "description": "Project styles customization",
-      "type": "object",
-      "properties": {
-        "theme": {
-          "$ref": "#/$defs/ThemeCustomization"
-        },
-        "defaults": {
-          "$ref": "#/$defs/DefaultStyleValues"
-        }
-      },
-      "additionalProperties": false
-    },
     "ThemeCustomization": {
       "id": "ThemeCustomization",
-      "description": "Theme customization",
+      "description": "Customize theme colors and sizes",
       "type": "object",
       "properties": {
         "colors": {
-          "$ref": "#/$defs/ThemeColors"
-        },
-        "sizes": {
-          "$ref": "#/$defs/ThemeSizes"
-        }
-      },
-      "additionalProperties": false
-    },
-    "ThemeColors": {
-      "id": "ThemeColors",
-      "description": "Override theme colors",
-      "anyOf": [
-        {
+          "description": "Override theme colors",
           "type": "object",
           "propertyNames": {
-            "$ref": "#/$defs/ColorName"
+            "anyOf": [
+              {
+                "$ref": "#/$defs/ColorName"
+              },
+              {
+                "not": {}
+              }
+            ]
           },
           "additionalProperties": {
             "$ref": "#/$defs/ThemeColorValues"
           }
         },
-        {
+        "sizes": {
+          "description": "Override theme sizes",
           "type": "object",
-          "properties": {
-            "amber": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "blue": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "gray": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "slate": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "green": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "indigo": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "muted": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "primary": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "red": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "secondary": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "sky": {
-              "$ref": "#/$defs/ThemeColorValues"
-            }
+          "propertyNames": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/ElementSize"
+              },
+              {
+                "not": {}
+              }
+            ]
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/Dimensions"
           }
         }
-      ]
+      },
+      "additionalProperties": false
     },
     "ColorName": {
       "id": "ColorName",
       "anyOf": [
         {
-          "$ref": "#/$defs/ThemeColor"
+          "$ref": "#/$defs/ThemeColorName"
         },
         {
-          "type": "string",
-          "minLength": 1
+          "$ref": "#/$defs/CustomColorName"
         }
       ]
     },
-    "ThemeColor": {
-      "id": "ThemeColor",
+    "ThemeColorName": {
+      "id": "ThemeColorName",
       "type": "string",
       "enum": [
         "amber",
@@ -196,52 +146,54 @@
         "sky"
       ]
     },
+    "CustomColorName": {
+      "id": "CustomColorName"
+    },
     "ThemeColorValues": {
       "id": "ThemeColorValues",
       "description": "Exact value (hex, rgb, rgba, hsl, hsla ...) or break down of specific color values",
       "anyOf": [
         {
-          "$ref": "#/$defs/ColorLiteral"
+          "$ref": "#/$defs/StrictThemeColorValues"
         },
         {
-          "type": "object",
-          "properties": {
-            "elements": {
-              "description": "Element color value (or a breakdown of specific color values)",
-              "anyOf": [
-                {
-                  "$ref": "#/$defs/ColorLiteral"
-                },
-                {
-                  "$ref": "#/$defs/ElementColorValues"
-                }
-              ]
-            },
-            "relationships": {
-              "description": "Relationship color value (or a breakdown of specific color values)",
-              "anyOf": [
-                {
-                  "$ref": "#/$defs/ColorLiteral"
-                },
-                {
-                  "$ref": "#/$defs/RelationshipColorValues"
-                }
-              ]
-            }
-          },
-          "required": [
-            "elements",
-            "relationships"
-          ],
-          "additionalProperties": false
+          "$ref": "#/$defs/ColorLiteral"
         }
       ]
     },
-    "ColorLiteral": {
-      "id": "ColorLiteral",
-      "description": "Color value in any valid CSS format: hex, rgb, rgba, hsl, hsla ...",
-      "type": "string",
-      "minLength": 1
+    "StrictThemeColorValues": {
+      "id": "StrictThemeColorValues",
+      "description": "Exact color value (hex, rgb, rgba, hsl, hsla ...) or break down of specific color value",
+      "type": "object",
+      "properties": {
+        "elements": {
+          "description": "Exact color value (hex, rgb, rgba, hsl, hsla ...) or break down of specific color values",
+          "anyOf": [
+            {
+              "$ref": "#/$defs/ElementColorValues"
+            },
+            {
+              "$ref": "#/$defs/ColorLiteral"
+            }
+          ]
+        },
+        "relationships": {
+          "description": "Exact color value (hex, rgb, rgba, hsl, hsla ...) or break down of specific color values",
+          "anyOf": [
+            {
+              "$ref": "#/$defs/RelationshipColorValues"
+            },
+            {
+              "$ref": "#/$defs/ColorLiteral"
+            }
+          ]
+        }
+      },
+      "required": [
+        "elements",
+        "relationships"
+      ],
+      "additionalProperties": false
     },
     "ElementColorValues": {
       "id": "ElementColorValues",
@@ -272,6 +224,11 @@
       ],
       "additionalProperties": false
     },
+    "ColorLiteral": {
+      "id": "ColorLiteral",
+      "type": "string",
+      "minLength": 1
+    },
     "RelationshipColorValues": {
       "id": "RelationshipColorValues",
       "type": "object",
@@ -286,6 +243,7 @@
         },
         "labelBg": {
           "description": "Label background color",
+          "default": "rgba(0, 0, 0, 0.5)",
           "$ref": "#/$defs/ColorLiteral"
         }
       },
@@ -295,32 +253,20 @@
       ],
       "additionalProperties": false
     },
-    "ThemeSizes": {
-      "id": "ThemeSizes",
-      "description": "Override theme sizes",
-      "type": "object",
-      "properties": {
-        "xs": {
-          "$ref": "#/$defs/Dimensions"
-        },
-        "sm": {
-          "$ref": "#/$defs/Dimensions"
-        },
-        "md": {
-          "$ref": "#/$defs/Dimensions"
-        },
-        "lg": {
-          "$ref": "#/$defs/Dimensions"
-        },
-        "xl": {
-          "$ref": "#/$defs/Dimensions"
-        }
-      },
-      "additionalProperties": false
+    "ElementSize": {
+      "id": "ElementSize",
+      "type": "string",
+      "enum": [
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl"
+      ]
     },
     "Dimensions": {
       "id": "Dimensions",
-      "description": "Dimensions",
+      "description": "Defines dimensions for theme size",
       "type": "object",
       "properties": {
         "width": {
@@ -340,7 +286,6 @@
     },
     "DefaultStyleValues": {
       "id": "DefaultStyleValues",
-      "description": "Override default values for style properties\nThese values will be used if such property is not defined",
       "type": "object",
       "properties": {
         "color": {
@@ -363,12 +308,16 @@
           "description": "Default shape for elements",
           "$ref": "#/$defs/ElementShape"
         },
+        "iconPosition": {
+          "description": "Default icon position for elements",
+          "$ref": "#/$defs/IconPosition"
+        },
         "group": {
-          "description": "Default style values for groups",
+          "description": "Override default values for group style properties\nThese values will be used if such property is not defined",
           "$ref": "#/$defs/GroupDefaultStyleValues"
         },
         "relationship": {
-          "description": "Default style values for relationships",
+          "description": "Override default values for relationship style properties\nThese values will be used if such property is not defined",
           "$ref": "#/$defs/RelationshipDefaultStyleValues"
         }
       },
@@ -391,17 +340,6 @@
         "none"
       ]
     },
-    "ElementSize": {
-      "id": "ElementSize",
-      "type": "string",
-      "enum": [
-        "xs",
-        "sm",
-        "md",
-        "lg",
-        "xl"
-      ]
-    },
     "ElementShape": {
       "id": "ElementShape",
       "type": "string",
@@ -414,12 +352,22 @@
         "storage",
         "queue",
         "bucket",
-        "document"
+        "document",
+        "component"
+      ]
+    },
+    "IconPosition": {
+      "id": "IconPosition",
+      "type": "string",
+      "enum": [
+        "left",
+        "right",
+        "top",
+        "bottom"
       ]
     },
     "GroupDefaultStyleValues": {
       "id": "GroupDefaultStyleValues",
-      "description": "Override default values for group style properties\nThese values will be used if such property is not defined",
       "type": "object",
       "properties": {
         "color": {
@@ -482,8 +430,73 @@
         "vee"
       ]
     },
-    "manual-layouts-config": {
-      "id": "manual-layouts-config",
+    "CustomStylesheets": {
+      "id": "CustomStylesheets",
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      ]
+    },
+    "ImageAliases": {
+      "id": "ImageAliases",
+      "description": "Map of image alias prefixes to relative paths (keys must match /^@\\w+$/; values must be relative paths without protocol or leading slash).",
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^@[A-Za-z0-9_-]*$"
+      },
+      "additionalProperties": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^(?!\\/|[A-Za-z]:[\\\\\\/])(?!.*:\\/\\/).*$"
+      }
+    },
+    "include-config": {
+      "id": "include-config",
+      "description": "Configuration for including additional LikeC4 source files from other directories.\nExample: { \"paths\": [\"../shared\", \"../common/specs\"], \"maxDepth\": 5, \"fileThreshold\": 50 }",
+      "type": "object",
+      "properties": {
+        "paths": {
+          "description": "Additional relative directory paths to include LikeC4 source files from, searched recursively.\nPaths are relative to the project folder (the folder containing this config file).\nExample: [\"../shared\", \"../common/specs\"]",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^(?!\\/|[A-Za-z]:[\\\\\\/])(?!.*:\\/\\/).*$"
+          }
+        },
+        "maxDepth": {
+          "description": "Maximum directory depth to scan when searching for .c4 files in include paths.\nPrevents excessive scanning of deeply nested directories.\nDefault: 3",
+          "default": 3,
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 20
+        },
+        "fileThreshold": {
+          "description": "Maximum number of files to load from include paths before warning.\nHelps identify performance issues from accidentally including large directories.\nDefault: 30",
+          "default": 30,
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10000
+        }
+      },
+      "required": [
+        "paths"
+      ],
+      "additionalProperties": false
+    },
+    "ManualLayoutsConfig": {
+      "id": "ManualLayoutsConfig",
       "description": "Configuration for manual layouts",
       "type": "object",
       "properties": {
@@ -492,7 +505,8 @@
           "default": ".likec4",
           "type": "string"
         }
-      }
+      },
+      "additionalProperties": false
     }
   }
 }

package/src/define-config.ts

@@ -1,14 +1,8 @@
 import type { LikeC4ProjectStylesConfig, LikeC4ProjectTheme, ThemeColorValues } from '@likec4/core/types'
 import type { GeneratorFn, LikeC4ProjectConfig, LikeC4ProjectConfigInput } from './schema'
 import { GeneratorsSchema, LikeC4ProjectConfigSchema } from './schema'
-import {
-  type LikeC4ConfigThemeInput,
-  type LikeC4StylesConfigInput,
-  type ThemeColorValuesInput,
-  LikeC4Config_Styles_Theme,
-  LikeC4StylesConfigSchema,
-  ThemeColorValuesSchema,
-} from './schema.theme'
+import type { LikeC4ConfigThemeInput, LikeC4StylesConfigInput, ThemeColorValuesInput } from './schema.theme'
+import { LikeC4Config_Styles_Theme, LikeC4StylesConfigSchema, ThemeColorValuesSchema } from './schema.theme'
 
 /**
  * Defines LikeC4 Project, allows custom generators that can be executed using CLI:
@@ -22,9 +16,10 @@ import {
  * export default defineConfig({
  *   name: 'my-project',
  *   title: 'My Project',
+ *
  *   exclude: ['picomatch pattern'],
  *   generators: {
- *     'my-generator': async ({ likec4model, ctx }) => {
+ *     '<generator-name>': async ({ likec4model, ctx }) => {
  *       await ctx.write('my-generator.txt', likec4model.project.id)
  *     }
  *   }

package/src/filenames.ts

@@ -1,13 +1,17 @@
-const configJsonFilenames = [
+import { basename } from 'pathe'
+
+export const configJsonFilenames = [
   '.likec4rc',
   '.likec4.config.json',
   'likec4.config.json',
 ] as const
 
-const configNonJsonFilenames = [
+export const configNonJsonFilenames = [
   'likec4.config.js',
+  'likec4.config.cjs',
   'likec4.config.mjs',
   'likec4.config.ts',
+  'likec4.config.cts',
   'likec4.config.mts',
 ] as const
 
@@ -20,24 +24,14 @@ export const ConfigFilenames = [
  * Checks if the given filename is a LikeC4 JSON config file (JSON, RC).
  */
 export function isLikeC4JsonConfig(filename: string): filename is typeof configJsonFilenames[number] {
-  for (const ext of configJsonFilenames) {
-    if (filename.endsWith(ext)) {
-      return true
-    }
-  }
-  return false
+  return (configJsonFilenames as readonly string[]).includes(basename(filename))
 }
 
 /**
  * Checks if the given filename is a LikeC4 non-JSON config file (JS, MJS, TS, MTS)
  */
 export function isLikeC4NonJsonConfig(filename: string): filename is typeof configNonJsonFilenames[number] {
-  for (const ext of configNonJsonFilenames) {
-    if (filename.endsWith(ext)) {
-      return true
-    }
-  }
-  return false
+  return (configNonJsonFilenames as readonly string[]).includes(basename(filename))
 }
 
 /**

package/src/index.ts

@@ -6,7 +6,10 @@ export type {
   LikeC4ProjectConfigInput,
   LikeC4ProjectJsonConfig,
   LocateResult,
-  ManualLayoutsConfigSchema,
+} from './schema'
+
+export {
+  LikeC4ProjectConfigOps,
 } from './schema'
 
 export type {
@@ -14,14 +17,12 @@ export type {
 } from './schema.include'
 
 export type {
+  LikeC4ConfigThemeInput,
   LikeC4StylesConfig,
   LikeC4StylesConfigInput,
+  ThemeColorValuesInput,
 } from './schema.theme'
 
-export { validateProjectConfig } from './schema'
-
-export { normalizeIncludeConfig, validateIncludePaths } from './schema.include'
-
 export {
   ConfigFilenames,
   isLikeC4Config,

package/src/node/index.ts

@@ -1,2 +1,3 @@
 export * from '../index'
+
 export { loadConfig } from './load-config'