00d8e551db
- refactor array equality check and add tests - remove OperatingSystem.Unknown causing extra logic, return undefined instead - refactor enum validation to share same logic - refactor scripting language factories to share same logic - refactor too many args in runCodeAsync - refactor ScriptCode constructor to reduce complexity - fix writing useless write to member object since another property write always override it
45 lines
2.9 KiB
Markdown
45 lines
2.9 KiB
Markdown
# Application
|
|
|
|
- It's mainly responsible for
|
|
- creating and event based [application state](#application-state)
|
|
- [parsing](#parsing) and [compiling](#compiling) [application data](#application-data)
|
|
- Consumed by [presentation layer](./presentation.md)
|
|
|
|
## Structure
|
|
|
|
- [`/src/` **`application/`**](./../src/application/): Contains all application related code.
|
|
- [**`collections/`**](./../src/application/collections/): Holds [collection files](./collection-files.md)
|
|
- [**`Common/`**](./../src/application/Common/): Contains common functionality that is shared in application layer.
|
|
- `..`: other classes are categorized using folders-by-feature structure
|
|
|
|
## Application state
|
|
|
|
- [ApplicationContext.ts](./../src/application/Context/ApplicationContext.ts) holds the [CategoryCollectionState](./../src/application/Context/State/CategoryCollectionState.ts) for each OS
|
|
- Uses [state pattern](https://en.wikipedia.org/wiki/State_pattern)
|
|
- Same instance is shared throughout the application to ensure consistent state
|
|
- 📖 See [Application State | Presentation layer](./presentation.md#application-state) to read more about how the state should be managed by the presentation layer.
|
|
- 📖 See [ApplicationContext.ts](./../src/application/Context/ApplicationContext.ts) to start diving into the state code.
|
|
|
|
## Application data
|
|
|
|
- Compiled to [`Application`](./../src/domain/Application.ts) domain object.
|
|
- The scripts are defined and controlled in different data files per OS
|
|
- Enables [data-driven programming](https://en.wikipedia.org/wiki/Data-driven_programming) and easier contributions
|
|
- Application data is defined in collection files and
|
|
- 📖 See [Application data | Presentation layer](./presentation.md#application-data) to read how the application data is read by the presentation layer.
|
|
- 📖 See [collection files documentation](./collection-files.md) to read more about how the data files are structured/defined and see [collection yaml files](./../src/application/collections/) to directly check the code.
|
|
|
|
## Parsing
|
|
|
|
- Application data is parsed to domain object [`Application.ts`](./../src/domain/Application.ts)
|
|
- Steps
|
|
1. (Compile time) Load application data from [collection yaml files](./../src/application/collections/) using webpack loader
|
|
2. (Runtime) Parse and compile application and make it available to presentation layer by [`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)
|
|
|
|
### Compiling
|
|
|
|
- Parsing the application files includes compiling scripts using [collection file defined functions](./collection-files.md#function)
|
|
- To extend the syntax:
|
|
1. Add a new parser under [SyntaxParsers](./../src/application/Parser/Script/Compiler/Expressions/SyntaxParsers) where you can look at other parsers to understand more.
|
|
2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts)
|