diff --git a/README.md b/README.md index efecff2e2d..71329d22f0 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ Your one-stop tool for generating accurate and well-tested models for representi - [Installing Modelina](#installing-modelina) - [AsyncAPI CLI](#asyncapi-cli) - [Features](#features) -- [Roadmap](#roadmap) - [Requirements](#requirements) - [Documentation](#documentation) - [Examples](#examples) @@ -266,13 +265,12 @@ The following table provides a short summary of available features for supported PHP Class and enum generation: custom indentation type and size, descriptions, etc + + Scala + Class and enum generation: custom indentation type and size, descriptions, etc + -## Roadmap -This is the roadmap that is currently in focus by the [CODEOWNERS](./CODEOWNERS) - -- [1 year roadmap](https://github.com/asyncapi/modelina/milestone/4) - ## Requirements The following are a requirement in order to use Modelina. diff --git a/docs/integration.md b/docs/integration.md index 786995da29..d3aaa071a1 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -64,7 +64,7 @@ There are at least two ways you can integrate Modelina into your build process f - DO work with other inputs then AsyncAPI - DO work when needing extensive build options and configurations -Checkout the Maven example here: [Integrate Modelina into Maven](../examples/integrate-modelina-into-maven) +Checkout the Maven example here: [Integrate Modelina into Maven](../examples/integrate-with-maven) **AsyncAPI CLI** diff --git a/docs/languages/Java.md b/docs/languages/Java.md index d16a820e39..6b5197a490 100644 --- a/docs/languages/Java.md +++ b/docs/languages/Java.md @@ -95,4 +95,4 @@ Currently not supported, [let everyone know you need it](https://github.com/asyn Currently not supported, [let everyone know you need it](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md)! ## Integrate Modelina into Maven -We have created an example Maven project to show you how to generate AsyncAPI payload models from your AsyncAPI file and integrate it into the build process. [You can find the integration example here](../integration.md#integrate-modelina-into-maven). \ No newline at end of file +We have created an example Maven project to show you how to generate AsyncAPI payload models from your AsyncAPI file and integrate it into the build process. [You can find the integration example here](../integration.md#integrate-with-maven). \ No newline at end of file diff --git a/docs/languages/Scala.md b/docs/languages/Scala.md new file mode 100644 index 0000000000..249be7b0df --- /dev/null +++ b/docs/languages/Scala.md @@ -0,0 +1,36 @@ +# Scala + +There are special use-cases that each language supports; this document pertains to **Scala models**. + + + + + +- [Description Present](#description-present) +- [Generate serializer and deserializer functionality](#generate-serializer-and-deserializer-functionality) + * [To and from JSON](#to-and-from-json) + * [To and from XML](#to-and-from-xml) + * [To and from binary](#to-and-from-binary) + + + +## Description Present + +By default, descriptions are not rendered for the model; you can change that by applying `SCALA_DESCRIPTION_PRESET`. + +Check out this [example for a live demonstration](../../examples/php-generate-documentation-preset). + +## Generate serializer and deserializer functionality + +The most widely used usecase for Modelina is to generate models that include serilization and deserialization functionality to convert the models into payload data. This payload data can of course be many different kinds, JSON, XML, raw binary, you name it. + +As you normally only need one library to do this, we developers can never get enough with creating new stuff, therefore there might be one specific library you need or want to integrate with. Therefore there is not one specific preset that offers everything. Below is a list of all the supported serialization presets. + +### To and from JSON +Currently not supported, [let everyone know you need it](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md)! + +### To and from XML +Currently not supported, [let everyone know you need it](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md)! + +### To and from binary +Currently not supported, [let everyone know you need it](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md)! diff --git a/docs/usage.md b/docs/usage.md index 247faf4a9e..4862187807 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -35,6 +35,7 @@ For more specific integration options, please check out the [integration documen - [Generate Kotlin models](#generate-kotlin-models) - [Generate C++ (cplusplus) models](#generate-c-cplusplus-models) - [Generate PHP models](#generate-php-models) +- [Generate Scala models](#generate-scala-models) @@ -201,4 +202,8 @@ C++ is one of the many output languages we support. Check out this [basic exampl ## Generate PHP models -PHP is one of the many output languages we support. Check out this [basic example for a live demonstration](../examples/php-generate-models/) and the following [PHP documentation for more advanced use-cases](./languages/Php.md). \ No newline at end of file +PHP is one of the many output languages we support. Check out this [basic example for a live demonstration](../examples/generate-php-models/) and the following [PHP documentation for more advanced use-cases](./languages/Php.md). + +## Generate Scala models + +Scala is one of the many output languages we support. Check out this [basic example for a live demonstration](../examples/generate-scala-models/) and the following [Scala documentation for more advanced use-cases](./languages/Scala.md). \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 67911e0fc1..41d24576c4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -16,13 +16,19 @@ We love contributions and new examples that does not already exist, you can foll - [General examples](#general-examples) - [Simple generator examples](#simple-generator-examples) - [Integrations](#integrations) -- [Python](#python) -- [JavaScript](#javascript) -- [Java](#java) -- [C#](#c%23) -- [TypeScript](#typescript) -- [Kotlin](#kotlin) -- [PHP](#php) +- [Language examples](#language-examples) + * [Python](#python) + * [JavaScript](#javascript) + * [Java](#java) + * [C#](#c%23) + * [TypeScript](#typescript) + * [Kotlin](#kotlin) + * [PHP](#php) + * [Scala](#scala) + * [Rust](#rust) + * [Dart](#dart) + * [Go](#go) + * [C++](#c) - [Other examples](#other-examples) @@ -65,27 +71,37 @@ These are all the basic generator examples that shows a bare minimal example of - [generate-javascript-models](./generate-javascript-models) - A basic example to generate JavaScript data models - [generate-kotlin-models](./generate-kotlin-models) - A basic example to generate Kotlin data models - [generate-cplusplus-models](./generate-cplusplus-models) - A basic example to generate C++ data models +- [generate-php-models](./generate-cplusplus-models) - A basic example to generate PHP data models +- [generate-scala-models](./generate-cplusplus-models) - A basic example to generate Scala data models ## Integrations These are examples of how you can integrate Modelina into a specific scenario: - [integrate-with-react](./integrate-with-react) - A basic example that shows how you can integrate Modelina with React. - [integrate-with-next](./integrate-with-next) - A basic example that shows how you can integrate Modelina with Next. -- [integrate-modelina-into-maven](./integrate-modelina-into-maven) - A basic example that shows how you can integrate Modelina into the Java Maven build process. +- [integrate-with-maven](./integrate-with-maven) - A basic example that shows how you can integrate Modelina into the Java Maven build process. -## Python +## Language examples +These are all the examples for each language; + +### Python These are all specific examples only relevant to the Python generator: +- [generate-python-models](./generate-python-models) - A basic example showing how to generate Python models. +- [generate-python-complete-models](./generate-python-complete-models) - A basic example showing how to generate complete Python models. - [generate-python-pydantic-models](./generate-python-pydantic-models) - An example showing how to generate Python pydantic models. - [python-generate-json-serializer-and-deseriazlier](./python-generate-json-serializer-and-deserializer) - An example that shows how to generate the models with JSON serializer and deserializer. -## JavaScript +### JavaScript These are all specific examples only relevant to the JavaScript generator: +- [generate-javascript-models](./generate-javascript-models) - A basic example to generate JavaScript data models - [javascript-use-esm](./javascript-use-esm) - A basic example that generate the models to use ESM module system. - [javascript-use-cjs](./javascript-use-cjs) - A basic example that generate the models to use CJS module system. - [javascript-generate-marshalling](./javascript-generate-marshalling) - A basic example of how to use the un/marshalling functionality of the javascript class. - [javascript-generate-example](./javascript-generate-example) - A basic example of how to use Modelina and output a JavaScript class with an example function. -## Java +### Java These are all specific examples only relevant to the Java generator: + +- [generate-java-models](./generate-java-models) - A basic example to generate Java data models. - [java-generate-tostring](./java-generate-tostring) - A basic example that shows how to generate models that overwrite the `toString` method - [java-change-collection-type](./java-change-collection-type) - An example to render collections as List in Java. - [java-generate-hashcode](./java-generate-hashcode) - A basic example that shows how to generate models that overwrite the `hashCode` method @@ -95,10 +111,12 @@ These are all specific examples only relevant to the Java generator: - [java-generate-equals](./java-generate-equals) - A basic example that shows how to generate models that overwrite the `equal` method - [java-generate-javax-constraint-annotation](./java-generate-javax-constraint-annotation) - A basic example that shows how Java data models having `javax.validation.constraints` annotations can be generated. - [java-generate-javadoc](./java-generate-javadoc) - A basic example of how to generate Java models including JavaDocs. -- [integrate-modelina-into-maven](./integrate-modelina-into-maven/) - A basic example that shows how you can integrate Modelina into the Java Maven build process. +- [integrate-into-maven](./integrate-with-maven/) - A basic example that shows how you can integrate Modelina into the Java Maven build process. -## C# +### C# These are all specific examples only relevant to the C# generator: + +- [generate-csharp-models](./generate-csharp-models) - A basic example to generate C# data models - [csharp-generate-equals-and-hashcode](./csharp-generate-equals-and-hashcode) - A basic example on how to generate models that overwrite the `Equal` and `GetHashCode` methods - [csharp-generate-json-serializer](./csharp-generate-json-serializer) - A basic example on how to generate models that include function to serialize the data models to and from JSON with System.Text.Json. - [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. @@ -107,8 +125,10 @@ These are all specific examples only relevant to the C# generator: - [csharp-generate-records](./csharp-generate-records) - A basic example that shows how to change C# model type from class to record. - [csharp-generate-handle-nullable](./csharp-generate-handle-nullable) - A basic example that shows how generate code than handles nullable mode and prevent warnings. -## TypeScript +### TypeScript These are all specific examples only relevant to the TypeScript generator: + +- [generate-typescript-models](./generate-typescript-models) - A basic example to generate TypeScript data models - [typescript-interface](./typescript-interface) - A basic TypeScript generator that outputs interfaces. - [typescript-enum-type](./typescript-enum-type) - A basic example of how to use Modelina can output different types of enums in TypeScript. - [typescript-generate-example](./typescript-generate-example) - A basic example of how to use Modelina and output a TypeScript class with an example function. @@ -118,19 +138,46 @@ These are all specific examples only relevant to the TypeScript generator: - [typescript-use-cjs](./typescript-use-cjs) - A basic example that generate the models to use CJS module system. - [typescript-generate-jsonbinpack](./typescript-generate-jsonbinpack) - A basic example showing how to generate models that include [jsonbinpack](https://github.com/sourcemeta/jsonbinpack) functionality. -## Kotlin +### Kotlin These are all specific examples only relevant to the Kotlin generator: + +- [generate-kotlin-models](./generate-kotlin-models) - A basic example to generate Kotlin data models - [generate-kotlin-enums](./generate-kotlin-enums) - [kotlin-generate-kdoc](./kotlin-generate-kdoc) - [kotlin-generate-javax-constraint-annotations](./kotlin-generate-javax-constraint-annotation) - [kotlin-change-collection-type](./kotlin-change-collection-type) -## PHP +### PHP These are all specific examples only relevant to the PHP generator: -- [php-generate-models](./php-generate-models) - A basic example of how to use Modelina and output a PHP class. + +- [generate-php-models](./generate-cplusplus-models) - A basic example to generate PHP data models - [php-generate-complete-models](./php-generate-complete-models) - An example that will output PHP complete class with dependencies and headers. - [php-generate-documentation-preset](./php-generate-documentation-preset) - An example that will output PHP complete class with documentation. +### Scala +These are all specific examples only relevant to the Scala generator: +- [generate-scala-models](./generate-scala-models) - A basic example to generate Scala data models +- [generate-scala-enums](./generate-scala-enums) - A basic example of how to use Modelina and output a Scala enums. +- [scala-generate-documentation](./scala-generate-documentation) - A basic example of how to use Modelina and output a Scala models that include descriptions. + +### Rust +These are all specific examples only relevant to the Rust generator; +- [rust-generate-crate](./rust-generate-crate) - A basic example showing how to generate a Rust package. + +### Dart +These are all specific examples only relevant to the Dart generator: +- [generate-dart-models](./generate-dart-models) - A basic example showing how to generate Python models. +- [dart-generate-json-annotation](./dart-generate-json-annotation) - A basic example of how to use Modelina and output Dart models that include JSON annotations. + +### Go +These are all specific examples only relevant to the Go generator; +- [generate-go-enums](./generate-go-enums) - A basic example showing how to generate a Go enums. +- [generate-go-models](./generate-go-models) - A basic example showing how to generate a Go models. + +### C++ +These are all specific examples only relevant to the C++ generator; +- [generate-cplusplus-models](./generate-cplusplus-models) - A basic example showing how to generate a C++ models. + ## Other examples Miscellaneous examples that do not fit into the otherwise grouping. - [TEMPLATE](./TEMPLATE) - A basic template used to create new examples. diff --git a/examples/dart-generate-json-annotation/README.md b/examples/dart-generate-json-annotation/README.md index c4eb09990d..a6a0d256cb 100644 --- a/examples/dart-generate-json-annotation/README.md +++ b/examples/dart-generate-json-annotation/README.md @@ -1,6 +1,6 @@ # Dart Data Models with json_annotation -A basic example of how to use Modelina and output a Go data model. +A basic example of how to use Modelina and output Dart models that include JSON annotations. ## How to run this example diff --git a/examples/dart-generate-json-annotation/package-lock.json b/examples/dart-generate-json-annotation/package-lock.json new file mode 100644 index 0000000000..ddc523b671 --- /dev/null +++ b/examples/dart-generate-json-annotation/package-lock.json @@ -0,0 +1,10 @@ +{ + "name": "dart-generate-json-annotation", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "hasInstallScript": true + } + } +} diff --git a/examples/dart-generate-json-annotation/package.json b/examples/dart-generate-json-annotation/package.json new file mode 100644 index 0000000000..b835668f31 --- /dev/null +++ b/examples/dart-generate-json-annotation/package.json @@ -0,0 +1,9 @@ +{ + "config" : { "example_name" : "dart-generate-json-annotation" }, "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/examples/php-generate-models/README.md b/examples/generate-php-models/README.md similarity index 100% rename from examples/php-generate-models/README.md rename to examples/generate-php-models/README.md diff --git a/examples/php-generate-models/__snapshots__/index.spec.ts.snap b/examples/generate-php-models/__snapshots__/index.spec.ts.snap similarity index 100% rename from examples/php-generate-models/__snapshots__/index.spec.ts.snap rename to examples/generate-php-models/__snapshots__/index.spec.ts.snap diff --git a/examples/php-generate-models/index.spec.ts b/examples/generate-php-models/index.spec.ts similarity index 100% rename from examples/php-generate-models/index.spec.ts rename to examples/generate-php-models/index.spec.ts diff --git a/examples/php-generate-models/index.ts b/examples/generate-php-models/index.ts similarity index 100% rename from examples/php-generate-models/index.ts rename to examples/generate-php-models/index.ts diff --git a/examples/php-generate-models/package-lock.json b/examples/generate-php-models/package-lock.json similarity index 100% rename from examples/php-generate-models/package-lock.json rename to examples/generate-php-models/package-lock.json diff --git a/examples/php-generate-models/package.json b/examples/generate-php-models/package.json similarity index 100% rename from examples/php-generate-models/package.json rename to examples/generate-php-models/package.json diff --git a/examples/generate-scala-enums/__snapshots__/index.spec.ts.snap b/examples/generate-scala-enums/__snapshots__/index.spec.ts.snap new file mode 100644 index 0000000000..bb22915bf8 --- /dev/null +++ b/examples/generate-scala-enums/__snapshots__/index.spec.ts.snap @@ -0,0 +1,14 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Should be able to render Kotlin Enums and should log expected output to console 1`] = ` +Array [ + "object Protocol extends Enumeration { + type Protocol = Value + + val Http: Protocol.Value = Value(\\"HTTP\\") + val Number_1: Protocol.Value = Value(1) + val Https: Protocol.Value = Value(\\"HTTPS\\") + val ReservedTrue: Protocol.Value = Value(\\"true\\") +}", +] +`; diff --git a/examples/generate-scala-enums/index.ts b/examples/generate-scala-enums/index.ts index 458cc94c8d..f7a97fd1c3 100644 --- a/examples/generate-scala-enums/index.ts +++ b/examples/generate-scala-enums/index.ts @@ -1,4 +1,4 @@ -import { ScalaGenerator } from '../../src/generators/scala'; +import { ScalaGenerator } from '../../src'; const generator = new ScalaGenerator(); const jsonSchemaDraft7 = { diff --git a/examples/generate-scala-models/__snapshots__/index.spec.ts.snap b/examples/generate-scala-models/__snapshots__/index.spec.ts.snap new file mode 100644 index 0000000000..ec03215492 --- /dev/null +++ b/examples/generate-scala-models/__snapshots__/index.spec.ts.snap @@ -0,0 +1,11 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Should be able to render Kotlin Models and should log expected output to console 1`] = ` +Array [ + "case class Root( + email: Option[String], + cache: Option[Int], + website: Option[Website], +)", +] +`; diff --git a/examples/generate-scala-models/index.ts b/examples/generate-scala-models/index.ts index 74cde5421c..37ce750028 100644 --- a/examples/generate-scala-models/index.ts +++ b/examples/generate-scala-models/index.ts @@ -1,4 +1,4 @@ -import { ScalaGenerator } from '../../src/generators/scala'; +import { ScalaGenerator } from '../../src'; const generator = new ScalaGenerator(); const jsonSchemaDraft7 = { diff --git a/examples/integrate-modelina-into-maven/README.md b/examples/integrate-with-maven/README.md similarity index 100% rename from examples/integrate-modelina-into-maven/README.md rename to examples/integrate-with-maven/README.md diff --git a/examples/integrate-modelina-into-maven/maven-project/.gitignore b/examples/integrate-with-maven/maven-project/.gitignore similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/.gitignore rename to examples/integrate-with-maven/maven-project/.gitignore diff --git a/examples/integrate-modelina-into-maven/maven-project/README.md b/examples/integrate-with-maven/maven-project/README.md similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/README.md rename to examples/integrate-with-maven/maven-project/README.md diff --git a/examples/integrate-modelina-into-maven/maven-project/asyncapi.json b/examples/integrate-with-maven/maven-project/asyncapi.json similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/asyncapi.json rename to examples/integrate-with-maven/maven-project/asyncapi.json diff --git a/examples/integrate-modelina-into-maven/maven-project/pom.xml b/examples/integrate-with-maven/maven-project/pom.xml similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/pom.xml rename to examples/integrate-with-maven/maven-project/pom.xml diff --git a/examples/integrate-modelina-into-maven/maven-project/scripts/modelina/generate.ts b/examples/integrate-with-maven/maven-project/scripts/modelina/generate.ts similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/scripts/modelina/generate.ts rename to examples/integrate-with-maven/maven-project/scripts/modelina/generate.ts diff --git a/examples/integrate-modelina-into-maven/maven-project/scripts/modelina/package-lock.json b/examples/integrate-with-maven/maven-project/scripts/modelina/package-lock.json similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/scripts/modelina/package-lock.json rename to examples/integrate-with-maven/maven-project/scripts/modelina/package-lock.json diff --git a/examples/integrate-modelina-into-maven/maven-project/scripts/modelina/package.json b/examples/integrate-with-maven/maven-project/scripts/modelina/package.json similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/scripts/modelina/package.json rename to examples/integrate-with-maven/maven-project/scripts/modelina/package.json diff --git a/examples/integrate-modelina-into-maven/maven-project/src/main/java/com/mycompany/app/AnonymousSchema_1.java b/examples/integrate-with-maven/maven-project/src/main/java/com/mycompany/app/AnonymousSchema_1.java similarity index 100% rename from examples/integrate-modelina-into-maven/maven-project/src/main/java/com/mycompany/app/AnonymousSchema_1.java rename to examples/integrate-with-maven/maven-project/src/main/java/com/mycompany/app/AnonymousSchema_1.java diff --git a/examples/integrate-modelina-into-maven/package-lock.json b/examples/integrate-with-maven/package-lock.json similarity index 72% rename from examples/integrate-modelina-into-maven/package-lock.json rename to examples/integrate-with-maven/package-lock.json index 925777425c..1caacfbbed 100644 --- a/examples/integrate-modelina-into-maven/package-lock.json +++ b/examples/integrate-with-maven/package-lock.json @@ -1,5 +1,5 @@ { - "name": "integrate-modelina-into-maven", + "name": "integrate-with-maven", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/examples/integrate-modelina-into-maven/package.json b/examples/integrate-with-maven/package.json similarity index 87% rename from examples/integrate-modelina-into-maven/package.json rename to examples/integrate-with-maven/package.json index 1425f5cf7d..6e1edf3e3b 100644 --- a/examples/integrate-modelina-into-maven/package.json +++ b/examples/integrate-with-maven/package.json @@ -1,6 +1,6 @@ { "config": { - "example_name": "integrate-modelina-into-maven" + "example_name": "integrate-with-maven" }, "scripts": { "install": "(cd ../.. && npm i) && cd maven-project/scripts/modelina && npm i", diff --git a/examples/scala-generate-documentation/README.md b/examples/scala-generate-documentation/README.md new file mode 100644 index 0000000000..82893d8e30 --- /dev/null +++ b/examples/scala-generate-documentation/README.md @@ -0,0 +1,15 @@ +# Scala Generate Models With Documentation Preset + +## 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/scala-generate-documentation/__snapshots__/index.spec.ts.snap b/examples/scala-generate-documentation/__snapshots__/index.spec.ts.snap new file mode 100644 index 0000000000..e1acc66d66 --- /dev/null +++ b/examples/scala-generate-documentation/__snapshots__/index.spec.ts.snap @@ -0,0 +1,14 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Should be able to render Scala models that include documentation and should log expected output to console 1`] = ` +Array [ + "/** + * Description for class + * + * @property email Description for the email property + */ +case class Root( + email: Option[String], +)", +] +`; diff --git a/examples/scala-generate-documentation/index.spec.ts b/examples/scala-generate-documentation/index.spec.ts new file mode 100644 index 0000000000..62cc087f01 --- /dev/null +++ b/examples/scala-generate-documentation/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 Scala models that include documentation', () => { + 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/scala-generate-documentation/index.ts b/examples/scala-generate-documentation/index.ts new file mode 100644 index 0000000000..a5ddc6c493 --- /dev/null +++ b/examples/scala-generate-documentation/index.ts @@ -0,0 +1,28 @@ +import { SCALA_DESCRIPTION_PRESET, ScalaGenerator } from '../../src'; + +const generator = new ScalaGenerator({ + presets: [SCALA_DESCRIPTION_PRESET] +}); +const jsonSchemaDraft7 = { + $schema: 'http://json-schema.org/draft-07/schema#', + type: 'object', + additionalProperties: false, + description: 'Description for class', + properties: { + email: { + type: 'string', + format: 'email', + description: 'Description for the email property' + } + } +}; + +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/scala-generate-documentation/package-lock.json b/examples/scala-generate-documentation/package-lock.json new file mode 100644 index 0000000000..35603bba82 --- /dev/null +++ b/examples/scala-generate-documentation/package-lock.json @@ -0,0 +1,10 @@ +{ + "name": "scala-generate-documentation", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "hasInstallScript": true + } + } +} diff --git a/examples/scala-generate-documentation/package.json b/examples/scala-generate-documentation/package.json new file mode 100644 index 0000000000..8d3eaa0b00 --- /dev/null +++ b/examples/scala-generate-documentation/package.json @@ -0,0 +1,10 @@ +{ + "config" : { "example_name" : "scala-generate-documentation" }, + "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/jest.config.js b/jest.config.js index 78d5ad22d0..4e6ff5d0a0 100644 --- a/jest.config.js +++ b/jest.config.js @@ -11,7 +11,7 @@ module.exports = { // Test spec file resolution pattern // Matches parent folder `__tests__` and filename // should contain `test` or `spec`. - testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.[jt]sx?$', + testRegex: '((\\.|/)(test|spec))\\.[jt]sx?$', // Module file extensions for importing moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'], testTimeout: 10000, diff --git a/modelina-website/scripts/build-examples.js b/modelina-website/scripts/build-examples.js index 1caa89c799..8097bea769 100644 --- a/modelina-website/scripts/build-examples.js +++ b/modelina-website/scripts/build-examples.js @@ -31,7 +31,7 @@ const nameMapping = [ const examplesToIgnore = [ 'integrate-with-react', 'integrate-with-next', - 'integrate-modelina-into-maven', + 'integrate-with-maven', 'TEMPLATE' ] diff --git a/package.json b/package.json index 533b73147a..32f587c203 100644 --- a/package.json +++ b/package.json @@ -82,7 +82,7 @@ "docker:test:blackbox": "docker compose run modelina npm run test:blackbox", "test": "npm run test:library && npm run test:examples", "test:update": "npm run test:library -- -u && npm run test:examples:update", - "test:library": "cross-env CI=true jest --coverage --testPathIgnorePatterns ./test/blackbox --testPathIgnorePatterns ./test/runtime --testPathIgnorePatterns ./examples", + "test:library": "cross-env CI=true jest --coverage --testPathIgnorePatterns ./test/blackbox --testPathIgnorePatterns ./modelina-website --testPathIgnorePatterns ./test/runtime --testPathIgnorePatterns ./examples", "test:examples": "npm run test:examples:regular && npm run test:examples:websites", "test:examples:update": "npm run test:examples:regular -- -u && npm run test:examples:websites -- -u", "test:examples:regular": "cross-env CI=true jest ./examples --testPathIgnorePatterns ./examples/integrate-with-react --testPathIgnorePatterns ./examples/integrate-with-next", @@ -123,7 +123,7 @@ "lint": "eslint --max-warnings 0 --config .eslintrc .", "lint:fix": "eslint --max-warnings 0 --config .eslintrc . --fix", "release": "semantic-release", - "generate:readme:toc": "markdown-toc -i README.md && markdown-toc -i ./docs/other-tools.md && markdown-toc -i ./docs/languages/Php.md && markdown-toc -i ./docs/languages/Cplusplus.md && markdown-toc -i ./examples/README.md && markdown-toc -i ./docs/languages/Python.md && markdown-toc -i ./docs/usage.md && markdown-toc -i ./docs/integration.md && markdown-toc -i ./docs/advanced.md && markdown-toc -i ./docs/languages/Dart.md && markdown-toc -i ./docs/languages/TypeScript.md && markdown-toc -i ./docs/languages/Java.md && markdown-toc -i ./docs/languages/JavaScript.md && markdown-toc -i ./docs/languages/Csharp.md && markdown-toc -i ./docs/README.md && markdown-toc -i ./docs/generators.md && markdown-toc -i ./docs/presets.md", + "generate:readme:toc": "markdown-toc -i README.md && markdown-toc -i ./docs/other-tools.md && markdown-toc -i ./docs/languages/Scala.md && markdown-toc -i ./docs/languages/Php.md && markdown-toc -i ./docs/languages/Cplusplus.md && markdown-toc -i ./examples/README.md && markdown-toc -i ./docs/languages/Python.md && markdown-toc -i ./docs/usage.md && markdown-toc -i ./docs/integration.md && markdown-toc -i ./docs/advanced.md && markdown-toc -i ./docs/languages/Dart.md && markdown-toc -i ./docs/languages/TypeScript.md && markdown-toc -i ./docs/languages/Java.md && markdown-toc -i ./docs/languages/JavaScript.md && markdown-toc -i ./docs/languages/Csharp.md && markdown-toc -i ./docs/README.md && markdown-toc -i ./docs/generators.md && markdown-toc -i ./docs/presets.md", "generate:assets": "npm run build:prod && npm run docs && npm run generate:readme:toc && npm run format", "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION", "prepublishOnly": "npm run build:prod && npm run generate:readme:toc && npm run format", diff --git a/src/generators/index.ts b/src/generators/index.ts index 9a76050899..3cad3a112a 100644 --- a/src/generators/index.ts +++ b/src/generators/index.ts @@ -11,4 +11,5 @@ export * from './go'; export * from './rust'; export * from './kotlin'; export * from './cplusplus'; +export * from './scala'; export * from './AbstractFileGenerator';