Serenity Code Generator (Sergen)
Serenity code generator (sergen) configuration file
sergen.jsonsergen.*.json*.sergen.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
sergen.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
Extends | string | If specified, the settings in this file extends settings in a base file similar to tsconfig.json You can also use Sergen defaults by specifying this like "defaults@9.0.0" |
RootNamespace | string | The root namespace for the target project. It is recommended to have this in sergen.json. If not there, it will be auto calculated from root namespace in CSPROJ file, or derived from project file name by removing .Web suffix. Generated |
DeclareJoinConstants | boolean | If true, generated code will declare and use jFKTable type of constants for expressions in entities |
EnableGenerateFields | boolean | If true, it allows the use of [GenerateFields] attributes on rows, which automatically generates the fields using a source generator. This should only be used when Serenity.Pro.Coder is enabled in the project |
EnableGenerateInterface | boolean | If true, it allows the use of [GenerateInterface] attributes on handlers, which automatically generates the interface using a source generator. This should only be used when Serenity.Pro.Coder is enabled in the project |
EnableRowTemplates | boolean | If true, enables RowTemplate class generation. This should only be used when Serenity.Pro.Coder is enabled in the project. Has no effect when EnableGenerateFields is true. EnableGenerateFields should be preferred over this as RowTemplate |
EndOfLine | string | End of line character to use in generated files. If not specified, it will be auto detected from the environment. It is recommended to have "lf" for multi platform projects one of: "LF", "CRLF" |
FileScopedNamespaces | boolean | If true, generated code will use file scoped namespaces |
ParseGlobalUsings | boolean | If true, generated code will parse global usings from the current project. Default is true |
IncludeGlobalUsings | array<string> | If specified, generated code will assume these usings are in global using scope |
ExcludeGlobalUsings | array<string> | If specified, generated code will assume these usings are not in global using scope even if they are in global using scope |
OmitDefaultSchema | boolean | If true, the default schema name, e.g. "dbo" for SQL Server won't be emitted in generated field expressions in Row.cs files. This is true by default only for MySql as in MySql schema names are actually database names |
UseOriginAttribute | boolean | If true, instead of using [Expression] attributes for foreign view fields, it will use Origin(nameof(jFK), nameof(FKRow.ViewField)) if the FKRow is already generated in the project. It will also use ForeignKey(typeof(FKRow)) type of |
SaveGeneratedTables | boolean | If true, generated table options like Identity, Module etc. will be saved to the Connections array in sergen.json after code generation. Default is true |
ClientTypes | object | Client types code generation related configuration |
ClientTypes.OutDir | string | The output directory for generated client types .cs files |
ClientTypes.SourceGenerator | boolean | If false, the client types source generator in Serenity.Pro.Coder will be disabled |
MVC | object | MVC (e.g. view locations) related configuration |
MVC.UseRootNamespacedeprecated | boolean | Deprecated, Sergen will always use the root namespace to avoid class name clashes |
MVC.AsNamespace | boolean | If true, use namespace {RootNamespace}.MVC instead of a MVC class inside the RootNamespace. ESM helpers will also be generated in this namespace. Default is false. This is useful if to avoid class name clashes with referenced projects |
MVC.InternalAccess | boolean | If true, Use internal instead of public for generated top level class (MVC/ESM) |
MVC.OutDir | string | The output directory for MVC.cs |
MVC.SearchViewPaths | array<string> | View paths to search for, defaults to "Modules" and "Views". "ProjectName" is used instead of "Modules" if Razor SDK is used for the project, e.g. a Razor class library |
MVC.StripViewPaths | array<string> | Strip view paths from generated files. Defaults to "Modules", "Views". E.g. a subclass for Modules and Views won't be generated |
MVC.SourceGenerator | boolean | If false, the view paths source generator in Serenity.Pro.Coder will be disabled |
ServerTypings | object | Server typings code generation related configuration |
ServerTypings.Assemblies | array<string> | Assemblies for server typings generation. Specify only if Sergen can't auto determine your project output file |
ServerTypings.OutDir | string | The output directory for generated server typings files. Not used for modules |
ServerTypings.LocalTexts | boolean | If true, local texts will be generated |
ServerTypings.ModuleReExports | boolean | If true, module re-exports will be generated. Defaults to true |
ServerTypings.ModuleTypingsdeprecated | boolean | Deprecated as only ES modules style code generation is supported now. If true, module typings will be generated. Defaults to true if you have "module" defined in tsconfig.json |
ServerTypings.NamespaceTypingsdeprecated | boolean | Deprecated as only ES modules style code generation is supported now. If true, namespace typings will be generated. Defaults to true if you don't have "module" defined in tsconfig.json |
ServerTypings.PreferRelativePaths | boolean | If true, generated typings will use relative paths instead of paths from tsconfig.json, e.g. "../ServerTypes/" instead of "@/ServerTypes/" |
ServerTypings.SourceGenerator | boolean | If false, the server typings source generator in Serenity.Pro.Coder will be disabled |
Restoredeprecated | object | Deprecated as Sergen no longer supports restoring static content. Sergen restore command related configuration |
Restore.Include | array<string> | List of files (git ignore like) to include while restoring |
Restore.Exclude | array<string> | List of files (git ignore like) to exclude while restoring |
Restore.Typings | boolean | Set false to disable namespace typings restore to typings/ folder |
TSBuild | object | — |
TSBuild.EntryPoints | array<string> | List of entry point globs, default is "Modules/**/*Page.ts", "Modules/**/*Page.tsx", "Modules/**/ScriptInit.ts", "Modules/**/*.mts" |
TSBuild.SourceGenerator | boolean | Should the list of entry points, e.g. ESM be generated, only available with Serenity.Pro.Coder |
Connections | array | List of connections. It is only needed when it is desired to work / generated code based on a connection string that is not in appsettings.json |
KDiff3Pathdeprecated | string | Deprecated. Path to KDiff3 executable. If not specified, it will be auto detected from the environment |
TSCPathdeprecated | string | Deprecated. Full path to TypeScript compiler. It is assumed to be in path if not specified |
BaseRowClasses | array | List of base row classes to be used instead of Row. They are matched by list of base properties |
ForeignFieldSelection | string | The set of foreign fields to generate, default is NameOnly. None: Don't generate any foreign view fields except the ones explicitly included via IncludeForeignFields All: Generate all the foreign view fields, except ones excluded one of: "None", "All", "NameOnly" |
IncludeForeignFields | array<string> | A list of foreign fields to include in generated code. This could be used to include some additional fields This could be used to include some additional fields. Not so useful if ForeignFieldSelection is All |
RemoveForeignFields | array<string> | A list of foreign fields to omit from generated code. This could be used to disable generating code for join fields like CreatedBy, ModifiedBy etc, so properties like CustomerCreatedBy, CustomerModifiedBy etc. won't be generated in |
CustomTemplates | string | The location of custom templates folder. The files in this folder will override the default scriban templates in Sergen. You may also include additional files to be generated. Their names must match the names at |
CustomGenerate | object | The relative paths of custom generated files |
CustomSettings | object | Custom settings to be passed to and used in custom templates |
AppSettingFiles | array<string> | The list of appsettings.json files in order. Default is appsettings.json, appsettings.machine.json |
UpgradeInfo | object | The upgrade / migration related information used by stargen to determine the base version of template used, and already applied upgrades |
UpgradeInfo.InitialType | string | Initial type of project. Available options are "Community" e.g. Serene, "Premium" e.g. StartSharp one of: "Community", "Premium" |
UpgradeInfo.InitialVersion | string | Version this project is created from. Used to determine which migrations should be applied to project (starting from) |
UpgradeInfo.AppliedUpgrades | array<string> | List of already applied upgrades if any |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 67 properties, 99% carrying a description, max nesting depth 7.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
deprecated | JSON Schema Validation, draft 2020-12 | §9.3 — "deprecated" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
uniqueItems | JSON Schema Validation, draft 2020-12 | §6.4.3 — "uniqueItems" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.