Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matii96/nodiator
Flexible mediator pattern implementation for Node.js.
https://github.com/matii96/nodiator
cqrs mediator nestjs nodejs typescript
Last synced: 2 months ago
JSON representation
Flexible mediator pattern implementation for Node.js.
- Host: GitHub
- URL: https://github.com/matii96/nodiator
- Owner: Matii96
- License: mit
- Created: 2022-07-22T09:58:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-10T18:41:35.000Z (almost 2 years ago)
- Last Synced: 2024-11-05T21:29:39.156Z (2 months ago)
- Topics: cqrs, mediator, nestjs, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.84 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Nodiator
Flexible [mediator](https://refactoring.guru/design-patterns/mediator) pattern implementation for [TypeScript](https://www.typescriptlang.org).
[](/LICENSE)
[](https://www.npmjs.com/package/@nodiator/core)
[](http://commitizen.github.io/cz-cli)
[](https://codecov.io/gh/Matii96/nodiator)
[](https://github.com/Matii96/nodiator/actions?workflow=main-build)
## Table of contents
- [Idea](#idea)
- [Packages](#packages)
- [Examples](#examples)
- [Local development](#local_development)
- [Building packages](#local_development_building_packages)
- [Testing](#local_development_testing)
- [Committing](#local_development_committing)
- [Authors](#authors)
- [License](#license)
## 💡 Idea
When application grows in size it becomes more and more complicated to control dataflow between objects / modules. Modifying one of them may lead to unwanted "shotgun surgery" resulting in breaking other features of the application.
Other problem are extra intermediate actions like logging or caching moved directly to eg. business parts of code effectively preventing us from easily unplugging any of the middle actions from application.
Nodiator aims to address this problem by providing configurable mediator object serving as a communication hub.
## Packages
- [Core](https://github.com/Matii96/nodiator/tree/main/packages/core) - project implementation for vanilla typescript
- [Logger](https://github.com/Matii96/nodiator/tree/main/packages/extension-logger) - extension supporting explicit logging
- [Nest](https://github.com/Matii96/nodiator/tree/main/packages/nest) - nestjs integration
## Examples
- [Express + typescript](examples/01-express/README.md)
## Local development
Project uses [yarn workspaces](https://yarnpkg.com/features/workspaces) in combination with [lerna](https://lerna.js.org). To initialize the project run
```bash
yarn
```
### Building packages
As project uses typescript for the package to be seen as other packages dependency they need to be built first.
```bash
yarn build
```
### Testing
```bash
yarn lint:staged # linting staged files
yarn test # running unit tests for packages changed since HEAD
yarn test:cov # running unit tests for whole repo with coverage report
yarn test:e2e # running e2e tests for packages changed since HEAD with packages dependent on them
yarn test:all # combining test and test:e2e
```
### Committing
The project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) standard. To conveniently create commit message use [commitizen](https://commitizen-tools.github.io/commitizen) by typing
```bash
yarn cz
```
## Authors
**Mateusz Fonfara**
- Github: [@Matii96](https://github.com/Matii96)
- Medium: [@Matii96](https://medium.com/@matii96)
See also the full list of [contributors](https://github.com/Matii96/nodiator/contributors).
## License
This project is licensed under the MIT License - see the [LICENSE file](https://github.com/Matii96/nodiator/tree/main/LICENSE) for details.