Skip to content

Commit

Permalink
Standardized file names to Kebab case
Browse files Browse the repository at this point in the history
  • Loading branch information
@KindsonTheGenius
KindsonTheGenius committed Apr 20, 2023
1 parent 6980c7d commit d587649
Show file tree
Hide file tree
Showing 27 changed files with 124 additions and 123 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ Morphir consists of a few projects based on the features they provide.
| Introduction & Background | Using Morphir | Applicability |
| :------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
| [Resource Centre](https://resources.finos.org/morphir/) | [What Makes a Good Model](./docs/what-makes-a-good-domain-model.md) | [Sharing Business Logic Across Application Boundaries](./docs/shared_logic_modeling.md) |
| [Background](./docs/background.md) | [Development Automation (Dev Bots)](./docs/dev_bots.md) | [Regulatory Technology](./docs/regtech_modeling.md) |
| [Community](./docs/morphir_community.md) | [Modeling an Application](./docs/application_modeling.md) | |
| [What's it all about?](./docs/whats_it_about.md) | [Modeling Decision Tables](https://github.com/finos/morphir-examples/tree/master/src/Morphir/Sample/Rules) | |
| [Why we use Functional Programming?](./docs/why_functional_programming.md) | [Modeling for database developers](docs/modeling-for-database-developers.md) |
| [Background](./docs/background.md) | [Development Automation (Dev Bots)](./docs/dev-bots.md) | [Regulatory Technology](./docs/regtech-modeling.md) |
| [Community](./docs/morphir-community.md) | [Modeling an Application](./docs/application-modeling.md) | |
| [What's it all about?](./docs/whats-it-about.md) | [Modeling Decision Tables](https://github.com/finos/morphir-examples/tree/master/src/Morphir/Sample/Rules) | |
| [Why we use Functional Programming?](./docs/why-functional-programming.md) | [Modeling for database developers](docs/modeling-for-database-developers.md) |

## Roadmap

Expand Down
0 docs/application_modeling.md → docs/application-modeling.md
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/background.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ that shape is decided, a great deal of the actual coding is very repetative and
practices and team standards and you get a lot of boilerplate code that can be automated for faster production with
fewer errors. Morphir relies heavily on such automation, which we call Dev Bots. As with any automation, smart use can
lead to drastic efficiency improvements, like taking seconds to generate what a developer would take days to
produce. Check out the [Dev Bot post](dev_bots) for more information on this topic.
produce. Check out the [Dev Bot post](dev-bots) for more information on this topic.

### Eliminating Rewrites

Expand Down
22 changes: 11 additions & 11 deletions docs/cadl-doc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ The `maybe` type in morphir represents a type that may or may not exist. The typ
}
```

3. In a Scenario where a field type is `maybe` of another `maybe` type, it is represented as an `optional field` of the `union` type. <br/>
3. In a Scenario where a field type is `maybe` of another `maybe` type, it is represented as an `optional field` of the `union` type.

Elm:
```elm
Expand All @@ -216,7 +216,7 @@ The `maybe` type in morphir represents a type that may or may not exist. The typ
baz ?: string | null
}
```
_<span style="color:red">Note:</span>_ <br/>
_<span style="color:red">Note:</span>_ \
_In the scenario of multiple `maybe` type for a field in a model, it shall be represented as just the type or null_

### Collection Types
Expand Down Expand Up @@ -329,7 +329,7 @@ model FooBarBaz {
```

### [Custom Types](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Type)
##### [General Case]()
##### [General Case](#)
A `custom` type in morphir is a user defined type used to represent a business term or type. This concept is not directly supported in CADL but can be achieved
as tagged `union` of Tuples, where the first element represents type name in string, followed by its arguments.

Expand All @@ -345,7 +345,7 @@ Cadl:
```cadl
alias FooBarBaz = ["Foo", int64] | ["Bar", string] | "Baz";
```
##### [Special Case]()
##### [Special Case](#)
A `custom` type in morphir whose constructors have no arguments would be represented in CADL as an `enum` type.

Elm:
Expand All @@ -369,13 +369,13 @@ enum Currency {

---

| <div style="width:100px"></div> | CADL Type <div style="width:450px"></div> | Morphir Type<div style="width: 350px"></div> | Comment <div style="width:350px"></div> |
|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Namespaces](https://microsoft.github.io/cadl/language-basics/namespaces) | `namespace Petstore` | `module PetStore exposing (...)` | Namespaces in CADL map to [Modules](https://package.elm-lang.org/packages/Morgan-Stanley/morphir-elm/latest/Morphir-IR-Module) in Morphir |
| [Models](https://microsoft.github.io/cadl/language-basics/models) | `model Dog { name: string; age: number}` | `type alias Dog = { name: string, age: int}` | Models in CADL map to [Records](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Value#record) in Morphir |
| [Enums](https://microsoft.github.io/cadl/language-basics/enums) | `enum Direction {East; West; North; South}` | `type Direction `<br/> `= East` &#124; `West` &#124; `North` &#124; `South` | Enums in CADL map to [Union Types](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Type) in Mophir |
| <div style="width:100px"></div> | CADL Type <div style="width:450px"></div> | Morphir Type<div style="width: 350px"></div> | Comment <div style="width:350px"></div> |
|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Namespaces](https://microsoft.github.io/cadl/language-basics/namespaces) | `namespace Petstore` | `module PetStore exposing (...)` | Namespaces in CADL map to [Modules](https://package.elm-lang.org/packages/Morgan-Stanley/morphir-elm/latest/Morphir-IR-Module) in Morphir |
| [Models](https://microsoft.github.io/cadl/language-basics/models) | `model Dog { name: string; age: number}` | `type alias Dog = { name: string, age: int}` | Models in CADL map to [Records](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Value#record) in Morphir |
| [Enums](https://microsoft.github.io/cadl/language-basics/enums) | `enum Direction {East; West; North; South}` | `type Direction `<br/> `= East` &#124; `West` &#124; `North` &#124; `South` | Enums in CADL map to [Union Types](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Type) in Mophir |
| [Union Type](https://package.elm-lang.org/packages/finos/morphir-elm/18.1.0/Morphir-IR-Type) |||
| | -<span style="color: grey; font-style: italic;" > Unnamed Union <br> `alias Breed = Breagle` &#124; `GermanShepherd` &#124; `GoldenRetriever` <br> <span style="color: grey; font-style: italic;" >- Named Union <br> `union Breed {`<br> &ensp; `beagle: Beagle,` <br> &ensp; `shepherd: GermanShepherd.` <br> &ensp; `retiever: GoldenRetriever`<br> `}` |`type Breed` <br> &ensp; `= Beagle Beagle`<br> &ensp; &ensp; &#124; `Shepherd GermanShepherd ` <br> &ensp; &ensp; &#124; `Retriever GoldenRetriever`| Named unions in CADL maps to a Custom Type with a `type parameter` in Morphir. Any other detail of the type is captured in Morphir's `Decorators(Custom Attributes).` <br> <span style="color: red; font-style: italic;" >NB: unnamed Unions are currently not supported in morphir |
| | -<span style="color: grey; font-style: italic;" > Unnamed Union </span> <br /> `alias Breed = Breagle` &#124; `GermanShepherd` &#124; `GoldenRetriever` <br /> <span style="color: grey; font-style: italic;" >- Named Union </span> <br /> `union Breed {`<br /> &ensp; `beagle: Beagle,` <br /> &ensp; `shepherd: GermanShepherd.` <br /> &ensp; `retiever: GoldenRetriever`<br /> `}` | `type Breed` <br /> &ensp; `= Beagle Beagle`<br /> &ensp; &ensp; &#124; `Shepherd GermanShepherd ` <br /> &ensp; &ensp; &#124; `Retriever GoldenRetriever` | Named unions in CADL maps to a Custom Type with a `type parameter` in Morphir. Any other detail of the type is captured in Morphir's `Decorators(Custom Attributes).` <br /> <span style="color: red; font-style: italic;" >NB: unnamed Unions are currently not supported in morphir</span> |


## [Type Relations](https://microsoft.github.io/cadl/language-basics/type-relations)
Expand All @@ -384,7 +384,7 @@ enum Currency {
Boolean in CADL, maps to [`bool`](https://package.elm-lang.org/packages/elm/core/latest/Basics#Bool), a `true` or `false` value in Morphir.

##### Integer
In Morphir, this maps to the type [`int`.](https://package.elm-lang.org/packages/elm/core/latest/Basics#Int) The `integer` type assignment is valid CADL, but <br/>
In Morphir, this maps to the type [`int`.](https://package.elm-lang.org/packages/elm/core/latest/Basics#Int) The `integer` type assignment is valid CADL, but \
<span style="color: red; font-style:italic;"> Things to note :: </span>
1. When dealing with emitters such as OpenApiSpec(OAS) it defaults to an object. To obtain an actual int value, specify a subtype `int64`.

Expand Down
0 docs/CODE_OF_CONDUCT.md → docs/code-of-conduct.md
View file
File renamed without changes.
0 docs/command_line_tools.md → docs/command-line-tools.md
View file
File renamed without changes.
0 docs/CONTRIBUTING.md → docs/contributing.md
View file
File renamed without changes.
0 docs/Custom Attributes.md → docs/custom-attributes.md
View file
File renamed without changes.
0 docs/decorators users guide.md → docs/decorators-users-guide.md
View file
File renamed without changes.
0 docs/dev_bots.md → docs/dev-bots.md
View file
File renamed without changes.
74 changes: 37 additions & 37 deletions docs/developer-guide-index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,48 @@ Finally, it provides a step by step walk-throughs on how various Morphir compone
2. Existing team members intending to improve their abilities on Language Design concepts

##Content
1. [Getting Started with Morphir](README.md) <br>
1. [Getting Started with Morphir](README.md)
2. [Overview of Morphir](#)
3. [The Morphir Architecture](#) <br>
4. [The Morphir SDK](#) <br>
5. [Morphir Commands Processing](Morphir-elm Commands Processing) <br>
1. [morphir-elm make](#) <br>
2. [morphir-elm gen](#) <br>
3. [morphir-elm test](#) <br>
4. [morphir-elm develop](#) <br>
6. [Interoperability With JavaScript](#) <br>
7. [Testing Framework](#) <br>
3. [The Morphir Architecture](#)
4. [The Morphir SDK](#)
5. [Morphir Commands Processing](Morphir-elm Commands Processing)
1. [morphir-elm make](#)
2. [morphir-elm gen](#)
3. [morphir-elm test](#)
4. [morphir-elm develop](#)
6. [Interoperability With JavaScript](#)
7. [Testing Framework](#)
1. [CSV testing guide ](spark-testing-framework.md)
8. [The Morphir IR](#) <br>
1. [Overview of the Morphir IR](#) <br>
2. [Distribution](#) <br>
3. [Package](#) <br>
4. [Module](#) <br>
5. [Types](#) <br>
6. [Values](#) <br>
7. [Names](#) <br>
9. [The Morphir Frontends](#) <br>
1. [Elm Frontend](#) <br>
2. [Elm Incremental Frontend](#) <br>
10. [The Morphir Backends](#) <br>
8. [The Morphir IR](#)
1. [Overview of the Morphir IR](#)
2. [Distribution](#)
3. [Package](#)
4. [Module](#)
5. [Types](#)
6. [Values](#)
7. [Names](#)
9. [The Morphir Frontends](#)
1. [Elm Frontend](#)
2. [Elm Incremental Frontend](#)
10. [The Morphir Backends](#)
1. [Scala Backend](scala-backend.md)
2. [Spark Backend](spark-backend.md)
3. [Relational IR Backends](relational-backend.md)
4. [Scala Json Codecs Backend](scala-backend.md)
5. [Json Schema Backend](json-schema-mappings.md)
11. [Working with CODECS](#) <br>
1. [Introduction to Encoding/Decoding](#) <br>
2. [JSON Decoder Building Blocks](#) <br>
3. [Combining Decoders](#) <br>
4. [JSON Decode Pipeline](#) <br>
5. [Writing Encoders and Decoders in Elm](#) <br>
6. [Standard Codecs in Morphir](#) <br>
12. [NPM and Elm Packages](#) <br>
13. [Introduction to Combinator Parsing in Scala](#) <br>
1. [Overview of Combinator Parsing](#) <br>
2. [Parser or Basic Arithmetic Expression](#) <br>
3. [Implementing Parsers in Scala](#) <br>
4. [Regular Expressions Parser](#) <br>
5. [JSON Parser](#) <br>
6. [Low-Level Pull Parser API](#) <br>
11. [Working with CODECS](#)
1. [Introduction to Encoding/Decoding](#)
2. [JSON Decoder Building Blocks](#)
3. [Combining Decoders](#)
4. [JSON Decode Pipeline](#)
5. [Writing Encoders and Decoders in Elm](#)
6. [Standard Codecs in Morphir](#)
12. [NPM and Elm Packages](#)
13. [Introduction to Combinator Parsing in Scala](#)
1. [Overview of Combinator Parsing](#)
2. [Parser or Basic Arithmetic Expression](#)
3. [Implementing Parsers in Scala](#)
4. [Regular Expressions Parser](#)
5. [JSON Parser](#)
6. [Low-Level Pull Parser API](#)

0 docs/editor_setup.md → docs/editor-setup.md
View file
File renamed without changes.
Loading

0 comments on commit d587649

Please sign in to comment.