diff --git a/docker-compose.yaml b/docker-compose.yaml
new file mode 100644
index 0000000000..081beeb7af
--- /dev/null
+++ b/docker-compose.yaml
@@ -0,0 +1,8 @@
+services:
+ modelina:
+ working_dir: /app/
+ build:
+ context: .
+ dockerfile: Dockerfile
+ volumes:
+ - ./:/app:delegated
diff --git a/docs/languages/Csharp.md b/docs/languages/Csharp.md
index 63f081220b..21b83973b7 100644
--- a/docs/languages/Csharp.md
+++ b/docs/languages/Csharp.md
@@ -17,6 +17,7 @@ There are special use-cases that each language supports; this document pertains
* [Change the collection type for arrays](#change-the-collection-type-for-arrays)
* [Generate custom enum value names](#generate-custom-enum-value-names)
* [Generate models with inheritance](#generate-models-with-inheritance)
+ * [Generate models as records](#generate-models-as-records)
- [FAQ](#faq)
+ [Why is the type `dynamic` or `dynamic[]` when it should be `X`?](#why-is-the-type-dynamic-or-dynamic-when-it-should-be-x)
@@ -85,7 +86,12 @@ Check out this [example for a live demonstration](../../examples/csharp-overwrit
If you want the generated models to inherit from a custom class, you can overwrite the existing rendering behavior and create your own class setup.
-Check out this [example for a live demonstration](../../examples/csharp-use-inheritance).
+## Generate models as records
+
+Since C# 9 the language now supports records as an alternative to classes suitable for roles like DTO's. Modelina can generate records by setting the `modelType: record` option. Note that this renderer does not support the `autoImplementedProperties` option as this is default with records.
+
+Check out this [example for a live demonstration](../../examples/csharp-generate-records).
+
# FAQ
This is the most asked questions and answers which should be your GOTO list to check before asking anywhere else. Cause it might already have been answered!
diff --git a/docs/other-tools.md b/docs/other-tools.md
index c653bfdaf3..38e1f51ff9 100644
--- a/docs/other-tools.md
+++ b/docs/other-tools.md
@@ -7,6 +7,7 @@ This document is to help you keep an overview of of the differences between Mode
- [jsonschema2pojo (v1)](#jsonschema2pojo-v1)
+- [QuickType](#quicktype)
diff --git a/examples/README.md b/examples/README.md
index b142529989..3d66d0bb02 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -100,6 +100,7 @@ These are all specific examples only relevant to the C# generator:
- [csharp-generate-newtonsoft-serializer](./csharp-generate-newtonsoft-serializer) - A basic example on how to generate models that include function to serialize the data models to and form JSON with Newtonsoft.
- [csharp-overwrite-enum-naming](./csharp-overwrite-enum-naming) - A basic example on how to generate enum value names.
- [csharp-use-inheritance](./csharp-use-inheritance) - A basic example that shows how to introduce inheritance to classes
+- [csharp-generate-records](./csharp-generate-records) - A basic example that shows how to change C# model type from class to record.
## TypeScript
These are all specific examples only relevant to the TypeScript generator:
diff --git a/examples/csharp-generate-records/README.md b/examples/csharp-generate-records/README.md
new file mode 100644
index 0000000000..d20b3f5715
--- /dev/null
+++ b/examples/csharp-generate-records/README.md
@@ -0,0 +1,17 @@
+# TODO: Your example title
+
+TODO: Your example description
+
+## How to run this example
+
+Run this example using:
+
+```sh
+npm i && npm run start
+```
+
+If you are on Windows, use the `start:windows` script instead:
+
+```sh
+npm i && npm run start:windows
+```
diff --git a/examples/csharp-generate-records/__snapshots__/index.spec.ts.snap b/examples/csharp-generate-records/__snapshots__/index.spec.ts.snap
new file mode 100644
index 0000000000..18b2fa46fb
--- /dev/null
+++ b/examples/csharp-generate-records/__snapshots__/index.spec.ts.snap
@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Should be able to render a C# record instead of a class using the modelType option and should log expected output to console 1`] = `
+Array [
+ "public record Root
+{
+ public IEnumerable? Email { get; init; }
+ public required string Name { get; init; }
+}",
+]
+`;
diff --git a/examples/csharp-generate-records/index.spec.ts b/examples/csharp-generate-records/index.spec.ts
new file mode 100644
index 0000000000..dc0877efac
--- /dev/null
+++ b/examples/csharp-generate-records/index.spec.ts
@@ -0,0 +1,15 @@
+const spy = jest.spyOn(global.console, 'log').mockImplementation(() => {
+ return;
+});
+import { generate } from './index';
+
+describe('Should be able to render a C# record instead of a class using the modelType option', () => {
+ afterAll(() => {
+ jest.restoreAllMocks();
+ });
+ test('and should log expected output to console', async () => {
+ await generate();
+ expect(spy.mock.calls.length).toEqual(1);
+ expect(spy.mock.calls[0]).toMatchSnapshot();
+ });
+});
diff --git a/examples/csharp-generate-records/index.ts b/examples/csharp-generate-records/index.ts
new file mode 100644
index 0000000000..331128990d
--- /dev/null
+++ b/examples/csharp-generate-records/index.ts
@@ -0,0 +1,34 @@
+import { CSharpGenerator } from '../../src';
+
+const generator = new CSharpGenerator({
+ modelType: 'record',
+ collectionType: 'List'
+});
+const jsonSchemaDraft7 = {
+ $schema: 'http://json-schema.org/draft-07/schema#',
+ type: 'object',
+ additionalProperties: false,
+ required: ['name'],
+ properties: {
+ email: {
+ type: 'array',
+ items: {
+ type: 'string',
+ format: 'email'
+ }
+ },
+ name: {
+ type: 'string'
+ }
+ }
+};
+
+export async function generate(): Promise {
+ const models = await generator.generate(jsonSchemaDraft7);
+ for (const model of models) {
+ console.log(model.result);
+ }
+}
+if (require.main === module) {
+ generate();
+}
diff --git a/examples/csharp-generate-records/package-lock.json b/examples/csharp-generate-records/package-lock.json
new file mode 100644
index 0000000000..0ec3d2109c
--- /dev/null
+++ b/examples/csharp-generate-records/package-lock.json
@@ -0,0 +1,10 @@
+{
+ "name": "csharp-generate-records",
+ "lockfileVersion": 2,
+ "requires": true,
+ "packages": {
+ "": {
+ "hasInstallScript": true
+ }
+ }
+}
diff --git a/examples/csharp-generate-records/package.json b/examples/csharp-generate-records/package.json
new file mode 100644
index 0000000000..f8fec61bcc
--- /dev/null
+++ b/examples/csharp-generate-records/package.json
@@ -0,0 +1,10 @@
+{
+ "config" : { "example_name" : "csharp-generate-records" },
+ "scripts": {
+ "install": "cd ../.. && npm i",
+ "start": "../../node_modules/.bin/ts-node --cwd ../../ ./examples/$npm_package_config_example_name/index.ts",
+ "start:windows": "..\\..\\node_modules\\.bin\\ts-node --cwd ..\\..\\ .\\examples\\%npm_package_config_example_name%\\index.ts",
+ "test": "../../node_modules/.bin/jest --config=../../jest.config.js ./examples/$npm_package_config_example_name/index.spec.ts",
+ "test:windows": "..\\..\\node_modules\\.bin\\jest --config=..\\..\\jest.config.js examples/%npm_package_config_example_name%/index.spec.ts"
+ }
+}
diff --git a/modelina-website/src/components/icons/AsyncAPILogo.tsx b/modelina-website/src/components/icons/AsyncAPILogo.tsx
deleted file mode 100644
index 0b9309d92d..0000000000
--- a/modelina-website/src/components/icons/AsyncAPILogo.tsx
+++ /dev/null
@@ -1,138 +0,0 @@
-export default function AsyncAPILogo({
- className = 'h-10 w-auto mt-0.5'
-}: any) {
- return (
-
- );
-}
diff --git a/modelina-website/src/components/icons/ModelinaLogo.tsx b/modelina-website/src/components/icons/ModelinaLogo.tsx
new file mode 100644
index 0000000000..be29c5e5e6
--- /dev/null
+++ b/modelina-website/src/components/icons/ModelinaLogo.tsx
@@ -0,0 +1,46 @@
+export default function ModelinaLogo({
+ className = 'h-10 w-auto mt-0.5'
+ }: any) {
+ return (
+
+
+ );
+ }
\ No newline at end of file
diff --git a/modelina-website/src/components/layouts/MobileNavMenu.tsx b/modelina-website/src/components/layouts/MobileNavMenu.tsx
index 5e40dc27a9..d403f9c5c7 100644
--- a/modelina-website/src/components/layouts/MobileNavMenu.tsx
+++ b/modelina-website/src/components/layouts/MobileNavMenu.tsx
@@ -1,4 +1,4 @@
-import AsyncAPILogo from '../icons/AsyncAPILogo';
+import ModelinaLogo from '../icons/ModelinaLogo';
import Link from 'next/link';
export default function MobileNavMenu({ onClickClose = () => {} }) {
@@ -9,7 +9,7 @@ export default function MobileNavMenu({ onClickClose = () => {} }) {
-
+
diff --git a/modelina-website/src/components/playground/Playground.tsx b/modelina-website/src/components/playground/Playground.tsx
index eda7f872a5..30f20df9b5 100644
--- a/modelina-website/src/components/playground/Playground.tsx
+++ b/modelina-website/src/components/playground/Playground.tsx
@@ -66,7 +66,9 @@ class Playground extends React.Component<
tsMarshalling: false,
tsModelType: 'class',
tsEnumType: 'enum',
- csharpArrayType: 'Array'
+ tsIncludeDescriptions: false,
+ csharpArrayType: 'Array',
+ csharpAutoImplemented: false,
};
hasLoadedQuery: boolean = false;
constructor(props: ModelinaPlaygroundProps) {
@@ -183,17 +185,25 @@ class Playground extends React.Component<
if (query.tsEnumType !== undefined) {
this.config.tsEnumType = query.tsEnumType as any;
}
+ if (query.tsIncludeDescriptions !== undefined) {
+ this.config.tsIncludeDescriptions =
+ query.tsIncludeDescriptions === 'true';
+ }
if (query.language !== undefined) {
this.config.language = query.language as any;
}
if (query.csharpArrayType !== undefined) {
this.config.csharpArrayType = query.csharpArrayType as any;
}
+ if (query.csharpAutoImplemented !== undefined) {
+ this.config.csharpAutoImplemented =
+ query.csharpAutoImplemented === 'true';
+ }
if (this.props.router.isReady && !this.hasLoadedQuery) {
this.hasLoadedQuery = true;
this.generateNewCode(this.state.input);
}
-
+
let loader;
if (!isHardLoaded) {
loader = (
@@ -220,7 +230,7 @@ class Playground extends React.Component<
library instead.