Skip to content

Commit

Permalink
🎨 #52: Prettier angewendet
Browse files Browse the repository at this point in the history
  • Loading branch information
Hirschfuchs committed Nov 4, 2023
1 parent ebc9763 commit 8f395e0
Show file tree
Hide file tree
Showing 25 changed files with 233 additions and 231 deletions.
16 changes: 4 additions & 12 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
{
"root": true,
"ignorePatterns": [
"projects/**/*"
],
"ignorePatterns": ["projects/**/*"],
"overrides": [
{
"files": [
"*.ts"
],
"files": ["*.ts"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
Expand All @@ -34,12 +30,8 @@
}
},
{
"files": [
"*.html"
],
"extends": [
"plugin:@angular-eslint/template/recommended"
],
"files": ["*.html"],
"extends": ["plugin:@angular-eslint/template/recommended"],
"rules": {}
}
]
Expand Down
10 changes: 5 additions & 5 deletions .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Das Projekt ist eine Single-Page Angular-Applikation, die im Web ([buntnis-ilmen

### Sprache

Das Projekt wird in der deutschen Sprache aufgesetzt. Internationalisierung könnte nochmal interessant werden, aber nicht in Code und Doku.
Das Projekt wird in der deutschen Sprache aufgesetzt. Internationalisierung könnte nochmal interessant werden, aber nicht in Code und Doku.

## Inhaltliche Voraussetzungen

Expand All @@ -25,11 +25,11 @@ Trotz allem - wir sind alle nur Menschen. Bestes Bemühen heißt auch, dass nich
Kein Code ist fehlerfrei. Stimmt. Trotzdem wollen wir versuchen, eine möglichst fehlerfreie Codebasis zu wahren. Was heißt das in der Praxis?

- Jeder Code soll ausführbar sein
- ein Commit soll funktionierenden Code bereitstellen. Ich möchte grundlegend zu jedem Commit zurücksetzen können, ohne dass die Applikation bricht
- jeder PR (& eigentlich auch Commit) soll die Tests fehlerfrei ausführen können. Die Deaktivierung einzelner Tests muss sinnvoll begründet und nicht dauerhaft sein (Issue bereits angelegt)
- ein Commit soll funktionierenden Code bereitstellen. Ich möchte grundlegend zu jedem Commit zurücksetzen können, ohne dass die Applikation bricht
- jeder PR (& eigentlich auch Commit) soll die Tests fehlerfrei ausführen können. Die Deaktivierung einzelner Tests muss sinnvoll begründet und nicht dauerhaft sein (Issue bereits angelegt)
- Lint-Checks erfüllt
- wenn Sonar (oder ein anderer Linter) Bugs, Vulnerabilities oder Security Hotspots erkennt, müssen diese vor dem Einbau behoben werden
- weniger drastische Probleme, wie Code Smells sollten nach Möglichkeit auch entfernt oder so gering wie möglich gehalten werden. 10 Code Smells in einem kleinen Commit sind definitiv zu viel, aber auch 5 in einem großen Commit nicht schön. So wenig wie möglich - für die Wartbarkeit!
- wenn Sonar (oder ein anderer Linter) Bugs, Vulnerabilities oder Security Hotspots erkennt, müssen diese vor dem Einbau behoben werden
- weniger drastische Probleme, wie Code Smells sollten nach Möglichkeit auch entfernt oder so gering wie möglich gehalten werden. 10 Code Smells in einem kleinen Commit sind definitiv zu viel, aber auch 5 in einem großen Commit nicht schön. So wenig wie möglich - für die Wartbarkeit!

### TDD

Expand Down
10 changes: 5 additions & 5 deletions .github/setup.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Konfiguration für die Entwicklung

Hier beschrieben ist der grundlegende Prozess, der für die Arbeit am Projekt notwendig ist.
Hier beschrieben ist der grundlegende Prozess, der für die Arbeit am Projekt notwendig ist.

## IDE

Das Repository muss in der Entwicklungsumgebung der Wahl eingebunden werden. Eine für die Webentwicklung geeignete IDE, wie Webstorm oder VS Code mit entsprechenden Erweiterungen, ist empfehlenswert.
Das Repository muss in der Entwicklungsumgebung der Wahl eingebunden werden. Eine für die Webentwicklung geeignete IDE, wie Webstorm oder VS Code mit entsprechenden Erweiterungen, ist empfehlenswert.

Für die Arbeit wird npm benötigt. Nach dem Checkout eines Branches sollte ein `npm install` ausgeführt werden.
Für die Arbeit wird npm benötigt. Nach dem Checkout eines Branches sollte ein `npm install` ausgeführt werden.

## Entwicklung

Danach ist man grundsätzlich bereit für die Entwicklung. Die lokale Ausführung der Seite kann mit `ng serve` und die der Tests mit `npm run tests` gestartet werden.
Danach ist man grundsätzlich bereit für die Entwicklung. Die lokale Ausführung der Seite kann mit `ng serve` und die der Tests mit `npm run tests` gestartet werden.

Für den Stil ist die `contributing.md` zu beachten.
Für den Stil ist die `contributing.md` zu beachten.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ Dieses Repository beinhaltet den Quellcode für die Webpräsenz des Buntnis Ilme

Der aktuelle Entwicklungsstand kann auf `test.buntnis.de` betrachtet werden. Die Produktivversionen können auf `buntnis-ilmenau.de` (und `buntnis.de`) gefunden werden.




## Badges

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
Expand All @@ -16,13 +13,13 @@ Der aktuelle Entwicklungsstand kann auf `test.buntnis.de` betrachtet werden. Die
![Build](https://img.shields.io/github/actions/workflow/status/Hirschfuchs/buntnis-ilmenau.de/deploy-test.yml)
![Website-Zustand](https://img.shields.io/website?down_color=red&down_message=offline&up_color=green&up_message=online&url=https%3A%2F%2Fbuntnis-ilmenau.de)
![Coverage](https://img.shields.io/codecov/c/github/Hirschfuchs/buntnis-ilmenau.de)

## Roadmap

- einfache Startseite
- Erweiterung mit Unterpunkten
- Verknüpfung zu anderen Projekten, wie [stolpersteine-ilmenau.de](https://stolpersteine-ilmenau.de)


## Tech Stack

**Client:** Angular
Expand Down
36 changes: 8 additions & 28 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,11 @@
"outputPath": "dist/buntnis-ilmenau-de",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": [
"zone.js"
],
"polyfills": ["zone.js"],
"tsConfig": "tsconfig.app.json",
"inlineStyleLanguage": "scss",
"assets": [
"src/favicon.ico",
"src/assets"
],
"styles": [
"src/styles.scss"
],
"assets": ["src/favicon.ico", "src/assets"],
"styles": ["src/styles.scss"],
"scripts": []
},
"configurations": {
Expand Down Expand Up @@ -82,38 +75,25 @@
"test": {
"builder": "@angular-devkit/build-angular:karma",
"options": {
"polyfills": [
"zone.js",
"zone.js/testing"
],
"polyfills": ["zone.js", "zone.js/testing"],
"tsConfig": "tsconfig.spec.json",
"inlineStyleLanguage": "scss",
"assets": [
"src/favicon.ico",
"src/assets"
],
"styles": [
"src/styles.scss"
],
"assets": ["src/favicon.ico", "src/assets"],
"styles": ["src/styles.scss"],
"scripts": [],
"karmaConfig": "karma.conf.js"
}
},
"lint": {
"builder": "@angular-eslint/builder:lint",
"options": {
"lintFilePatterns": [
"src/**/*.ts",
"src/**/*.html"
]
"lintFilePatterns": ["src/**/*.ts", "src/**/*.html"]
}
}
}
}
},
"cli": {
"schematicCollections": [
"@angular-eslint/schematics"
]
"schematicCollections": ["@angular-eslint/schematics"]
}
}
42 changes: 21 additions & 21 deletions karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@

module.exports = function (config) {
config.set({
basePath: '',
frameworks: ['jasmine', '@angular-devkit/build-angular'],
basePath: "",
frameworks: ["jasmine", "@angular-devkit/build-angular"],
plugins: [
require('karma-jasmine'),
require('karma-chrome-launcher'),
require('karma-jasmine-html-reporter'),
require('karma-coverage'),
require('@angular-devkit/build-angular/plugins/karma')
require("karma-jasmine"),
require("karma-chrome-launcher"),
require("karma-jasmine-html-reporter"),
require("karma-coverage"),
require("@angular-devkit/build-angular/plugins/karma"),
],
client: {
jasmine: {
Expand All @@ -19,28 +19,28 @@ module.exports = function (config) {
// for example, you can disable the random execution with `random: false`
// or set a specific seed with `seed: 4321`
},
clearContext: false // leave Jasmine Spec Runner output visible in browser
clearContext: false, // leave Jasmine Spec Runner output visible in browser
},
jasmineHtmlReporter: {
suppressAll: true // removes the duplicated traces
suppressAll: true, // removes the duplicated traces
},
coverageReporter: {
dir: require('path').join(__dirname, './coverage/buntnis-ilmenau-de'),
subdir: '.',
dir: require("path").join(__dirname, "./coverage/buntnis-ilmenau-de"),
subdir: ".",
reporters: [
{type: 'html'},
{type: 'text-summary'},
{type: 'lcovonly'},
]
{ type: "html" },
{ type: "text-summary" },
{ type: "lcovonly" },
],
},
reporters: ['progress', 'kjhtml'],
browsers: ['Chrome', 'ChromeHeadless', 'ChromeHeadlessCI'],
reporters: ["progress", "kjhtml"],
browsers: ["Chrome", "ChromeHeadless", "ChromeHeadlessCI"],
customLaunchers: {
ChromeHeadlessCI: {
base: 'ChromeHeadless',
flags: ['--no-sandbox']
}
base: "ChromeHeadless",
flags: ["--no-sandbox"],
},
},
restartOnFileChange: true
restartOnFileChange: true,
});
};
4 changes: 1 addition & 3 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
],
"extends": ["config:base"],
"description": "Renovate-Konfiguration für die Buntnis-Seite",
"labels": ["👷 renovate"],
"prHourlyLimit": 20,
Expand Down
4 changes: 2 additions & 2 deletions src/app/app-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ const routes: Routes = [];

@NgModule({
imports: [RouterModule.forRoot(routes)],
exports: [RouterModule]
exports: [RouterModule],
})
export class AppRoutingModule { }
export class AppRoutingModule {}
4 changes: 3 additions & 1 deletion src/app/app.component.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ describe('AppComponent', () => {
const fixture = TestBed.createComponent(AppComponent);
fixture.detectChanges();
const compiled = fixture.nativeElement as HTMLElement;
expect(compiled.querySelector('h1')?.textContent).toContain('Buntnis Ilmenau');
expect(compiled.querySelector('h1')?.textContent).toContain(
'Buntnis Ilmenau',
);
});
});

Expand Down
2 changes: 1 addition & 1 deletion src/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Component } from '@angular/core';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
styleUrls: ['./app.component.scss'],
})
export class AppComponent {
title = 'buntnis-ilmenau-de';
Expand Down
47 changes: 22 additions & 25 deletions src/app/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,32 @@ import { BrowserModule } from '@angular/platform-browser';

import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import {ComingSoonComponent} from "./wartung/coming-soon/coming-soon.component";
import {NgOptimizedImage} from "@angular/common";
import { ComingSoonComponent } from './wartung/coming-soon/coming-soon.component';
import { NgOptimizedImage } from '@angular/common';
import { SharedComponentsModule } from './shared/components/shared-components.module';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
import {MatProgressBarModule} from "@angular/material/progress-bar";
import {MatListModule} from "@angular/material/list";
import {MatCheckboxModule} from "@angular/material/checkbox";
import {FormsModule} from "@angular/forms";
import { MatProgressBarModule } from '@angular/material/progress-bar';
import { MatListModule } from '@angular/material/list';
import { MatCheckboxModule } from '@angular/material/checkbox';
import { FormsModule } from '@angular/forms';

@NgModule({
declarations: [
AppComponent,
ComingSoonComponent
],
imports: [
BrowserAnimationsModule,
BrowserModule,
AppRoutingModule,
NgOptimizedImage,
SharedComponentsModule,
BrowserAnimationsModule,
FontAwesomeModule,
MatProgressBarModule,
MatListModule,
MatCheckboxModule,
FormsModule
],
declarations: [AppComponent, ComingSoonComponent],
imports: [
BrowserAnimationsModule,
BrowserModule,
AppRoutingModule,
NgOptimizedImage,
SharedComponentsModule,
BrowserAnimationsModule,
FontAwesomeModule,
MatProgressBarModule,
MatListModule,
MatCheckboxModule,
FormsModule,
],
providers: [],
bootstrap: [AppComponent]
bootstrap: [AppComponent],
})
export class AppModule { }
export class AppModule {}
5 changes: 2 additions & 3 deletions src/app/shared/components/header/header.component.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ describe('HeaderComponent', () => {

beforeEach(async () => {
await TestBed.configureTestingModule({
declarations: [ HeaderComponent ]
})
.compileComponents();
declarations: [HeaderComponent],
}).compileComponents();

fixture = TestBed.createComponent(HeaderComponent);
component = fixture.componentInstance;
Expand Down
6 changes: 2 additions & 4 deletions src/app/shared/components/header/header.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ import { Component } from '@angular/core';
@Component({
selector: 'app-header',
templateUrl: './header.component.html',
styleUrls: ['./header.component.scss']
styleUrls: ['./header.component.scss'],
})
export class HeaderComponent {

}
export class HeaderComponent {}
16 changes: 4 additions & 12 deletions src/app/shared/components/shared-components.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,9 @@ import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
import { HeaderComponent } from './header/header.component';



@NgModule({
declarations: [
HeaderComponent
],
exports: [
HeaderComponent
],
imports: [
CommonModule
]
declarations: [HeaderComponent],
exports: [HeaderComponent],
imports: [CommonModule],
})
export class SharedComponentsModule { }
export class SharedComponentsModule {}
Loading

0 comments on commit 8f395e0

Please sign in to comment.