Skip to content
Snippets Groups Projects
Commit b409dda6 authored by OZGCloud's avatar OZGCloud
Browse files

OZG-130 create README_PACKAGE_JSON.md

parent 59207339
No related branches found
No related tags found
No related merge requests found
# README zur Package.json
### Anbei eine Liste(unvollständig) der einzelnen Befehle und einer kurzen Erläuterung.
</br>
## Scripts
| Command | Description |
| :------ | :------ |
| `nx` </br> `nx --list` | Zeigt alle verfügbaren, schon von nx **vordefinierten**, commands an
| `start` | Startet den Client mit dem Port **4300** und der **proxy.conf.json**
| `build` | Baut das Projekt(und cached den build)
| `nx test` | Führt alle Test's aus(***app*** + ***libraries***)
| `ng test` | Führt die Test's die unter ***app*** liegen aus
| `lint` | Führt das ***eslint*** für die, von den lokalen Änderungen **direkt** betroffenen, libraries aus
| `dep-graph` | Öffnet ein Fenster zur graphischen Veranschaulichung des Zusammenspielst von app, e2e und der einzelnen libraries
| `cypress:open` | Öffnet ein Fenster mit cpress-runner für die Integrationtest's welche auch gleich da ausgeführt werden können
</br>
</br>
## Affected
Man kann mit Hilfe von `nx --help` eine Liste von Befehlen mit kurzen Erläuterung bekommen.
Hier eine kurze Liste mit den wichtigsten Befehlen:
`affected:*` bezieht sich meistens auf die von den lokalen Änderungen betroffenen Libraries, kann aber auch auf die betroffenen der Projects gehen.
- `affected:libs`
Zeigt eine Liste der Libraries die von den aktuellen Änderungen betroffen sind </br>
(hier kann man zusätzlich auch den `dep-graph` zur Hand nehmen für eine Bessere Übersicht)
- `affected:test`
Führt die Test's für die libraries aus die von den lokalen Änderungen betroffen sind. </br>
(inklusive der app Test's)
- `affected:lint`
Führt das eslint über die betroffenen Libraries aus. </br>
Wenn man library x verändert die auch von y genutzt wird, werden beide genommen. </br>
Man bekommt am Ende eine Zusammenfassung von den Warnings und Errors.
- `affected:dep-graph`
Selektiert die von den lokalen Änderung betroffenen Libraries vor und stellt diese in Rot dar.
`affected:apps`, `affected:e2e`, `affected:build` beziehen sich jeweils auf ganze Projekte/Apps.
</br>
</br>
## NG/NX short explanation
- Angular ClI = **ng**
- Nx Cli = **nx**
Nx Cli baut auf Angular Cli auf ist jedoch wesentlich schneller bspw. durch
- _advanced code analysis_
- _computation caching (reuse previous results)_
Sofern die Commands für das Generieren von Code genutzt werden, so ist der generierte Code immer derselbe!
### `Install NX global`
npm install -g nx
\ No newline at end of file
export class SetDarkModeAction { export class SetDarkModeAction {
static readonly type: string = '[User boolean] Set DarkMode'; static readonly type: string = '[User boolean] Set DarkMode';
constructor(public darkMode: boolean) {} constructor(public darkMode: boolean) {}
} }
export class SetNavigationCollapseAction { export class SetNavigationCollapseAction {
static readonly type: string = '[User boolean] Set NavigationCollapseStatus'; static readonly type: string = '[User boolean] Set NavigationCollapseStatus';
constructor(public collapse: boolean) {} constructor(public collapse: boolean) {}
} }
...@@ -4,9 +4,8 @@ import { TestBed } from '@angular/core/testing'; ...@@ -4,9 +4,8 @@ import { TestBed } from '@angular/core/testing';
describe('VorgangSharedModule', () => { describe('VorgangSharedModule', () => {
beforeEach(async () => { beforeEach(async () => {
await TestBed.configureTestingModule({ await TestBed.configureTestingModule({
imports: [ VorgangSharedModule ] imports: [VorgangSharedModule],
}) }).compileComponents();
.compileComponents();
}); });
it('should create', () => { it('should create', () => {
......
...@@ -14,19 +14,13 @@ describe(VorgangSharedState.name, () => { ...@@ -14,19 +14,13 @@ describe(VorgangSharedState.name, () => {
beforeEach(() => { beforeEach(() => {
TestBed.configureTestingModule({ TestBed.configureTestingModule({
imports: [NgxsModule.forRoot([VorgangSharedState])], imports: [NgxsModule.forRoot([VorgangSharedState])],
providers: [ providers: [VorgangSharedService, ResourceFactory, HttpService, HttpClient, HttpHandler],
VorgangSharedService,
ResourceFactory,
HttpService,
HttpClient,
HttpHandler
]
}); });
store = TestBed.inject(Store); store = TestBed.inject(Store);
store.reset({ store.reset({
...store.snapshot(), ...store.snapshot(),
defaults defaults,
}); });
}); });
...@@ -35,7 +29,7 @@ describe(VorgangSharedState.name, () => { ...@@ -35,7 +29,7 @@ describe(VorgangSharedState.name, () => {
store.dispatch(new SetVorgangAction(vorgang)); store.dispatch(new SetVorgangAction(vorgang));
const stateVorgang = store.selectSnapshot(state => state.vorgangShared.vorgang); const stateVorgang = store.selectSnapshot((state) => state.vorgangShared.vorgang);
expect(stateVorgang).toBe(vorgang); expect(stateVorgang).toBe(vorgang);
}); });
}); });
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment